org.springframework.data.rest.core.mapping

Interface ExposureConfigurer

All Known Implementing Classes:

ExposureConfiguration

public interface ExposureConfigurer

Configuration API to register filters to customize the supported HTTP methods by different kinds of resources.

Since:

2.1

Author:

Oliver Gierke

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ExposureConfigurer.AggregateResourceHttpMethodsFilter A filter to post-process the supported HTTP methods by aggregate resources (collection or item resource).
static interface	ExposureConfigurer.AssociationResourceHttpMethodsFilter A filter to post-process the supported HTTP methods by Association resources.

Method Summary

Modifier and Type	Method and Description
ExposureConfigurer	disablePutForCreation() Disables the ability to create new item resources via HttpMethod.PUT.
ExposureConfigurer	withAssociationExposure(ExposureConfigurer.AssociationResourceHttpMethodsFilter filter) Registers the given ExposureConfigurer.AssociationResourceHttpMethodsFilter.
ExposureConfigurer	withCollectionExposure(ExposureConfigurer.AggregateResourceHttpMethodsFilter filter) Registers the given ExposureConfigurer.AggregateResourceHttpMethodsFilter to be used for collection resources.
ExposureConfigurer	withItemExposure(ExposureConfigurer.AggregateResourceHttpMethodsFilter filter) Registers the given ExposureConfigurer.AggregateResourceHttpMethodsFilter to be used for item resources.

Method Detail

withCollectionExposure

ExposureConfigurer withCollectionExposure(ExposureConfigurer.AggregateResourceHttpMethodsFilter filter)

Registers the given ExposureConfigurer.AggregateResourceHttpMethodsFilter to be used for collection resources.

Parameters:

filter - must not be null.

Returns:

withItemExposure

ExposureConfigurer withItemExposure(ExposureConfigurer.AggregateResourceHttpMethodsFilter filter)

Registers the given ExposureConfigurer.AggregateResourceHttpMethodsFilter to be used for item resources.

Parameters:

filter -

Returns:

withAssociationExposure

ExposureConfigurer withAssociationExposure(ExposureConfigurer.AssociationResourceHttpMethodsFilter filter)

Registers the given ExposureConfigurer.AssociationResourceHttpMethodsFilter.

Parameters:

filter -

Returns:

disablePutForCreation

ExposureConfigurer disablePutForCreation()

Disables the ability to create new item resources via HttpMethod.PUT.

Returns: