Package org.springframework.data.rest.core.mapping

Class ExposureConfiguration

java.lang.Object

org.springframework.data.rest.core.mapping.ExposureConfiguration

All Implemented Interfaces:

ExposureConfigurer

public class ExposureConfiguration
extends Object
implements ExposureConfigurer

Configuration type to register filters customizing the HTTP methods supported. By default, filters registered are applied globally. Domain type specific filters can be registered via forDomainType(Class). Useful global shortcuts like disablePutOnItemResources() do exist as well.

Since:

3.1

Author:

Oliver Gierke

See Also:

• forDomainType(Class)

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.rest.core.mapping.ExposureConfigurer

ExposureConfigurer.AggregateResourceHttpMethodsFilter, ExposureConfigurer.AssociationResourceHttpMethodsFilter

Constructor Summary

Constructors

Constructor	Description
ExposureConfiguration()

Method Summary

Modifier and Type	Method	Description
boolean	allowsPutForCreation(Class<?> domainType)	Returns whether PUT requests can be used to create new instances of the given domain type.
boolean	allowsPutForCreation(ResourceMetadata metadata)	Returns whether PUT requests can be used to create new instances for the type backing the given ResourceMetadata.
ExposureConfiguration	disablePatchOnItemResources()	Disables the support for HttpMethod.PATCH for item resources.
ExposureConfiguration	disablePutForCreation()	Disables the ability to create new item resources via HttpMethod.PUT.
ExposureConfiguration	disablePutOnItemResources()	Disables the support for HttpMethod.PUT for item resources.
ExposureConfigurer	forDomainType(Class<?> type)	Returns a ExposureConfigurer to allow the registration of type specific ExposureConfigurer.AggregateResourceHttpMethodsFilter and ExposureConfigurer.AssociationResourceHttpMethodsFilters which means the configured filters will only be invoked for aggregates of the given type and properties owned by that type respectively.
ExposureConfiguration	withAssociationExposure(ExposureConfigurer.AssociationResourceHttpMethodsFilter filter)	Registers the given ExposureConfigurer.AssociationResourceHttpMethodsFilter.
ExposureConfiguration	withCollectionExposure(ExposureConfigurer.AggregateResourceHttpMethodsFilter filter)	Registers the given ExposureConfigurer.AggregateResourceHttpMethodsFilter to be used for collection resources.
ExposureConfiguration	withItemExposure(ExposureConfigurer.AggregateResourceHttpMethodsFilter filter)	Registers the given ExposureConfigurer.AggregateResourceHttpMethodsFilter to be used for item resources.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ExposureConfiguration

public ExposureConfiguration()

Method Details

withCollectionExposure

public ExposureConfiguration withCollectionExposure(ExposureConfigurer.AggregateResourceHttpMethodsFilter filter)

Description copied from interface: ExposureConfigurer

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

Specified by:

withCollectionExposure in interface ExposureConfigurer

Parameters:

filter - must not be null.

Returns:

withItemExposure

public ExposureConfiguration withItemExposure(ExposureConfigurer.AggregateResourceHttpMethodsFilter filter)

Description copied from interface: ExposureConfigurer

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

Specified by:

withItemExposure in interface ExposureConfigurer

Returns:

withAssociationExposure

public ExposureConfiguration withAssociationExposure(ExposureConfigurer.AssociationResourceHttpMethodsFilter filter)

Description copied from interface: ExposureConfigurer

Registers the given ExposureConfigurer.AssociationResourceHttpMethodsFilter.

Specified by:

withAssociationExposure in interface ExposureConfigurer

Returns:

disablePutForCreation

public ExposureConfiguration disablePutForCreation()

Description copied from interface: ExposureConfigurer

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

Specified by:

disablePutForCreation in interface ExposureConfigurer

Returns:

forDomainType

public ExposureConfigurer forDomainType(Class<?> type)

Returns a ExposureConfigurer to allow the registration of type specific ExposureConfigurer.AggregateResourceHttpMethodsFilter and ExposureConfigurer.AssociationResourceHttpMethodsFilters which means the configured filters will only be invoked for aggregates of the given type and properties owned by that type respectively.

Parameters:

type - must not be null.

Returns:

disablePutOnItemResources

public ExposureConfiguration disablePutOnItemResources()

Disables the support for HttpMethod.PUT for item resources.

Returns:

disablePatchOnItemResources

public ExposureConfiguration disablePatchOnItemResources()

Disables the support for HttpMethod.PATCH for item resources.

Returns:

allowsPutForCreation

public boolean allowsPutForCreation(ResourceMetadata metadata)

Returns whether PUT requests can be used to create new instances for the type backing the given ResourceMetadata.

Parameters:

metadata - must not be null.

Returns:

allowsPutForCreation

public boolean allowsPutForCreation(Class<?> domainType)

Returns whether PUT requests can be used to create new instances of the given domain type.

Parameters:

domainType - must not be null.

Returns: