org.springframework.data.rest.core.config

Class RepositoryRestConfiguration

java.lang.Object

org.springframework.data.rest.core.config.RepositoryRestConfiguration

public class RepositoryRestConfiguration
extends Object

Spring Data REST configuration options.

Author:

Jon Brisbin, Oliver Gierke, Jeremy Rickard, Greg Turnquist

Constructor Summary

Constructors

Constructor and Description
RepositoryRestConfiguration(ProjectionDefinitionConfiguration projectionConfiguration, MetadataConfiguration metadataConfiguration, EnumTranslationConfiguration enumTranslationConfiguration) Creates a new RepositoryRestConfiguration with the given ProjectionDefinitionConfiguration.

Method Summary

Modifier and Type	Method and Description
RepositoryRestConfiguration	exposeIdsFor(Class<?>... domainTypes) Set the list of domain types for which we will expose the ID value as a normal property.
ResourceMapping	findRepositoryMappingForPath(String path)
URI	getBasePath() The base path to expose repository resources under.
URI	getBaseUri() The base URI against which the exporter should calculate its links.
MediaType	getDefaultMediaType() Get the MediaType to use as a default when none is specified.
int	getDefaultPageSize() Get the default size of Pageables.
ResourceMappingConfiguration	getDomainTypesResourceMappingConfiguration() Get the ResourceMappingConfiguration that is currently configured.
EnumTranslationConfiguration	getEnumSerializationConfiguration() Returns the EnumTranslator for
String	getLimitParamName() Get the name of the URL query string parameter that indicates how many results to return at once.
int	getMaxPageSize() Get the maximum size of pages.
MetadataConfiguration	getMetadataConfiguration() Returns the MetadataConfiguration to customize metadata exposure.
String	getPageParamName() Get the name of the URL query string parameter that indicates what page to return.
ProjectionDefinitionConfiguration	getProjectionConfiguration() Returns the ProjectionDefinitionConfiguration to register addition projections.
ResourceMapping	getResourceMappingForDomainType(Class<?> domainType) Get the ResourceMapping for a specific domain type.
ResourceMapping	getResourceMappingForRepository(Class<?> repositoryInterface) Get the ResourceMapping for a specific repository interface.
String	getSortParamName() Get the name of the URL query string parameter that indicates what direction to sort results.
boolean	hasResourceMappingForDomainType(Class<?> domainType) Whether there is a ResourceMapping for the given domain type.
boolean	hasResourceMappingForRepository(Class<?> repositoryInterface) Whether there is a ResourceMapping configured for this Repository class.
boolean	isEnableEnumTranslation() Returns whether enum value translation is enabled.
boolean	isIdExposedFor(Class<?> domainType) Should we expose the ID property for this domain type?
Boolean	isReturnBodyOnCreate() Deprecated. use returnBodyOnCreate(String)
Boolean	isReturnBodyOnUpdate() Deprecated. use returnBodyOnUpdate(String)
MetadataConfiguration	metadataConfiguration() Deprecated. since 2.4, use getMetadataConfiguration() instead.
ProjectionDefinitionConfiguration	projectionConfiguration() Deprecated. since 2.4, use getProjectionConfiguration() instead.
boolean	returnBodyOnCreate(String acceptHeader) Whether to return a response body after creating an entity considering the given accept header.
boolean	returnBodyOnUpdate(String acceptHeader) Whether to return a response body after updating an entity considering the given accept header.
void	setBasePath(String basePath) Configures the base path to be used by Spring Data REST to expose repository resources.
RepositoryRestConfiguration	setDefaultMediaType(MediaType defaultMediaType) Set the MediaType to use as a default when none is specified.
RepositoryRestConfiguration	setDefaultPageSize(int defaultPageSize) Set the default size of Pageables.
void	setEnableEnumTranslation(boolean enableEnumTranslation) Configures whether to enable enum value translation via the Spring Data REST default resource bundle.
RepositoryRestConfiguration	setLimitParamName(String limitParamName) Set the name of the URL query string parameter that indicates how many results to return at once.
RepositoryRestConfiguration	setMaxPageSize(int maxPageSize) Set the maximum size of pages.
RepositoryRestConfiguration	setPageParamName(String pageParamName) Set the name of the URL query string parameter that indicates what page to return.
ResourceMapping	setResourceMappingForDomainType(Class<?> domainType) Start configuration a ResourceMapping for a specific domain type.
ResourceMapping	setResourceMappingForRepository(Class<?> repositoryInterface) Start configuration a ResourceMapping for a specific repository interface.
RepositoryRestConfiguration	setReturnBodyForPutAndPost(Boolean returnBody) Convenience method to activate returning response bodies for all PUT and POST requests, i.e. both creating and updating entities.
RepositoryRestConfiguration	setReturnBodyOnCreate(Boolean returnBody) Set whether to return a response body after creating an entity.
RepositoryRestConfiguration	setReturnBodyOnUpdate(Boolean returnBodyOnUpdate) Set whether to return a response body after updating an entity.
RepositoryRestConfiguration	setSortParamName(String sortParamName) Set the name of the URL query string parameter that indicates what direction to sort results.
boolean	useHalAsDefaultJsonMediaType() Returns whether HAL will be served as primary representation in case on application/json is requested.
RepositoryRestConfiguration	useHalAsDefaultJsonMediaType(boolean useHalAsDefaultJsonMediaType) Configures whether HAL will be served as primary representation in case on application/json is requested.

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryRestConfiguration

public RepositoryRestConfiguration(ProjectionDefinitionConfiguration projectionConfiguration,
                                   MetadataConfiguration metadataConfiguration,
                                   EnumTranslationConfiguration enumTranslationConfiguration)

Creates a new RepositoryRestConfiguration with the given ProjectionDefinitionConfiguration.

Parameters:

projectionConfiguration - must not be null.

metadataConfiguration - must not be null.

Method Detail

getBaseUri

public URI getBaseUri()

The base URI against which the exporter should calculate its links.

Returns:

The base URI.

getBasePath

public URI getBasePath()

The base path to expose repository resources under.

Returns:

the basePath

setBasePath

public void setBasePath(String basePath)

Configures the base path to be used by Spring Data REST to expose repository resources.

Parameters:

basePath - the basePath to set

getDefaultPageSize

public int getDefaultPageSize()

Get the default size of Pageables. Default is 20.

Returns:

The default page size.

setDefaultPageSize

public RepositoryRestConfiguration setDefaultPageSize(int defaultPageSize)

Set the default size of Pageables.

Parameters:

defaultPageSize - The default page size.

Returns:

this

getMaxPageSize

public int getMaxPageSize()

Get the maximum size of pages.

Returns:

Maximum page size.

setMaxPageSize

public RepositoryRestConfiguration setMaxPageSize(int maxPageSize)

Set the maximum size of pages.

Parameters:

maxPageSize - Maximum page size.

Returns:

this

getPageParamName

public String getPageParamName()

Get the name of the URL query string parameter that indicates what page to return. Default is 'page'.

Returns:

Name of the query parameter used to indicate the page number to return.

setPageParamName

public RepositoryRestConfiguration setPageParamName(String pageParamName)

Set the name of the URL query string parameter that indicates what page to return.

Parameters:

pageParamName - Name of the query parameter used to indicate the page number to return.

Returns:

this

getLimitParamName

public String getLimitParamName()

Get the name of the URL query string parameter that indicates how many results to return at once. Default is 'limit'.

Returns:

Name of the query parameter used to indicate the maximum number of entries to return at a time.

setLimitParamName

public RepositoryRestConfiguration setLimitParamName(String limitParamName)

Set the name of the URL query string parameter that indicates how many results to return at once.

Parameters:

limitParamName - Name of the query parameter used to indicate the maximum number of entries to return at a time.

Returns:

this

getSortParamName

public String getSortParamName()

Get the name of the URL query string parameter that indicates what direction to sort results. Default is 'sort'.

Returns:

Name of the query string parameter used to indicate what field to sort on.

setSortParamName

public RepositoryRestConfiguration setSortParamName(String sortParamName)

Set the name of the URL query string parameter that indicates what direction to sort results.

Parameters:

sortParamName - Name of the query string parameter used to indicate what field to sort on.

Returns:

this

getDefaultMediaType

public MediaType getDefaultMediaType()

Get the MediaType to use as a default when none is specified.

Returns:

Default content type if none has been specified.

setDefaultMediaType

public RepositoryRestConfiguration setDefaultMediaType(MediaType defaultMediaType)

Set the MediaType to use as a default when none is specified.

Parameters:

defaultMediaType - default content type if none has been specified.

Returns:

this

useHalAsDefaultJsonMediaType

public boolean useHalAsDefaultJsonMediaType()

Returns whether HAL will be served as primary representation in case on application/json is requested. This defaults to true. If configured to false the legacy Spring Data representation will be rendered.

Returns:

useHalAsDefaultJsonMediaType

public RepositoryRestConfiguration useHalAsDefaultJsonMediaType(boolean useHalAsDefaultJsonMediaType)

Configures whether HAL will be served as primary representation in case on application/json is requested. This defaults to true. If configured to false the legacy Spring Data representation will be rendered.

Parameters:

useHalAsDefaultJsonMediaType -

Returns:

setReturnBodyForPutAndPost

public RepositoryRestConfiguration setReturnBodyForPutAndPost(Boolean returnBody)

Convenience method to activate returning response bodies for all PUT and POST requests, i.e. both creating and updating entities.

Parameters:

returnBody - can be null, expressing the decision shall be derived from the presence of an Accept header in the request.

Returns:

isReturnBodyOnCreate

@Deprecated
public Boolean isReturnBodyOnCreate()

Deprecated. use returnBodyOnCreate(String)

Whether to return a response body after creating an entity.

Returns:

Boolean.TRUE to enforce returning a body on create, Boolean.FALSE otherwise. If null and an Accept header present in the request will cause a body being returned. If the Accept header is not present, no body will be rendered.

returnBodyOnCreate

public boolean returnBodyOnCreate(String acceptHeader)

Whether to return a response body after creating an entity considering the given accept header.

Parameters:

acceptHeader - can be null or empty.

Returns:

setReturnBodyOnCreate

public RepositoryRestConfiguration setReturnBodyOnCreate(Boolean returnBody)

Set whether to return a response body after creating an entity.

Parameters:

returnBody - can be null, expressing the decision shall be derived from the presence of an Accept header in the request.

Returns:

this

isReturnBodyOnUpdate

@Deprecated
public Boolean isReturnBodyOnUpdate()

Deprecated. use returnBodyOnUpdate(String)

Whether to return a response body after updating an entity.

Returns:

Boolean.TRUE to enforce returning a body on create, Boolean.FALSE otherwise. If null and an Accept header present in the request will cause a body being returned. If the Accept header is not present, no body will be rendered.

returnBodyOnUpdate

public boolean returnBodyOnUpdate(String acceptHeader)

Whether to return a response body after updating an entity considering the given accept header.

Parameters:

acceptHeader - can be null or empty.

Returns:

setReturnBodyOnUpdate

public RepositoryRestConfiguration setReturnBodyOnUpdate(Boolean returnBodyOnUpdate)

Set whether to return a response body after updating an entity.

Parameters:

returnBody - can be null, expressing the decision shall be derived from the presence of an Accept header in the request.

Returns:

this

setResourceMappingForDomainType

public ResourceMapping setResourceMappingForDomainType(Class<?> domainType)

Start configuration a ResourceMapping for a specific domain type.

Parameters:

domainType - The Class of the domain type to configure a mapping for.

Returns:

A new ResourceMapping for configuring how a domain type is mapped.

getResourceMappingForDomainType

public ResourceMapping getResourceMappingForDomainType(Class<?> domainType)

Get the ResourceMapping for a specific domain type.

Parameters:

domainType - The Class of the domain type.

Returns:

A ResourceMapping for that domain type or null if none exists.

hasResourceMappingForDomainType

public boolean hasResourceMappingForDomainType(Class<?> domainType)

Whether there is a ResourceMapping for the given domain type.

Parameters:

domainType - The domain type to find a ResourceMapping for.

Returns:

true if a ResourceMapping exists for this domain class, false otherwise.

getDomainTypesResourceMappingConfiguration

public ResourceMappingConfiguration getDomainTypesResourceMappingConfiguration()

Get the ResourceMappingConfiguration that is currently configured.

Returns:

setResourceMappingForRepository

public ResourceMapping setResourceMappingForRepository(Class<?> repositoryInterface)

Start configuration a ResourceMapping for a specific repository interface.

Parameters:

repositoryInterface - The Class of the repository interface to configure a mapping for.

Returns:

A new ResourceMapping for configuring how a repository interface is mapped.

getResourceMappingForRepository

public ResourceMapping getResourceMappingForRepository(Class<?> repositoryInterface)

Get the ResourceMapping for a specific repository interface.

Parameters:

repositoryInterface - The Class of the repository interface.

Returns:

A ResourceMapping for that repository interface or null if none exists.

hasResourceMappingForRepository

public boolean hasResourceMappingForRepository(Class<?> repositoryInterface)

Whether there is a ResourceMapping configured for this Repository class.

Parameters:

repositoryInterface -

Returns:

findRepositoryMappingForPath

public ResourceMapping findRepositoryMappingForPath(String path)

isIdExposedFor

public boolean isIdExposedFor(Class<?> domainType)

Should we expose the ID property for this domain type?

Parameters:

domainType - The domain type we may need to expose the ID for.

Returns:

true is the ID is to be exposed, false otherwise.

exposeIdsFor

public RepositoryRestConfiguration exposeIdsFor(Class<?>... domainTypes)

Set the list of domain types for which we will expose the ID value as a normal property.

Parameters:

domainTypes - Array of types to expose IDs for.

Returns:

this

projectionConfiguration

@Deprecated
public ProjectionDefinitionConfiguration projectionConfiguration()

Deprecated. since 2.4, use getProjectionConfiguration() instead.

Returns the ProjectionDefinitionConfiguration to register addition projections.

Returns:

getProjectionConfiguration

public ProjectionDefinitionConfiguration getProjectionConfiguration()

Returns the ProjectionDefinitionConfiguration to register addition projections.

Returns:

metadataConfiguration

@Deprecated
public MetadataConfiguration metadataConfiguration()

Deprecated. since 2.4, use getMetadataConfiguration() instead.

Returns the MetadataConfiguration to customize metadata exposure.

Returns:

getMetadataConfiguration

public MetadataConfiguration getMetadataConfiguration()

Returns the MetadataConfiguration to customize metadata exposure.

Returns:

setEnableEnumTranslation

public void setEnableEnumTranslation(boolean enableEnumTranslation)

Configures whether to enable enum value translation via the Spring Data REST default resource bundle. Defaults to false for backwards compatibility reasons. Will use the fully qualified enum name as key. For further details see EnumTranslator.

Parameters:

enableEnumTranslation -

See Also:

getEnumSerializationConfiguration()

isEnableEnumTranslation

public boolean isEnableEnumTranslation()

Returns whether enum value translation is enabled.

Returns:

getEnumSerializationConfiguration

public EnumTranslationConfiguration getEnumSerializationConfiguration()

Returns the EnumTranslator for

Returns: