org.springframework.data.rest.core.config

Class RepositoryRestConfiguration

java.lang.Object

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

public class RepositoryRestConfiguration
extends Object

Author:

Jon Brisbin, Oliver Gierke

Constructor Summary

Constructors

Constructor and Description
RepositoryRestConfiguration() Creates a new default RepositoryRestConfiguration.
RepositoryRestConfiguration(ProjectionDefinitionConfiguration projectionConfiguration) Creates a new RepositoryRestConfiguration with the given ProjectionDefinitionConfiguration.

Method Summary

Methods

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	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.
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.
String	getPageParamName() Get the name of the URL query string parameter that indicates what page to return.
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	isIdExposedFor(Class<?> domainType) Should we expose the ID property for this domain type?
boolean	isReturnBodyOnCreate() Whether to return a response body after creating an entity.
boolean	isReturnBodyOnUpdate() Whether to return a response body after updating an entity.
ProjectionDefinitionConfiguration	projectionConfiguration() Returns the ProjectionDefinitionConfiguration to register addition projections.
RepositoryRestConfiguration	setBaseUri(URI baseUri) The base URI against which the exporter should calculate its links.
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.
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	setReturnBodyOnCreate(boolean returnBodyOnCreate) Set whether to return a response body after creating an entity.
RepositoryRestConfiguration	setReturnBodyOnUpdate(boolean returnBodyOnUpdate) Sets 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()

Creates a new default RepositoryRestConfiguration.

RepositoryRestConfiguration

public RepositoryRestConfiguration(ProjectionDefinitionConfiguration projectionConfiguration)

Creates a new RepositoryRestConfiguration with the given ProjectionDefinitionConfiguration.

Parameters:

projectionConfiguration - 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.

setBaseUri

public RepositoryRestConfiguration setBaseUri(URI baseUri)

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

Parameters:

baseUri - The base URI.

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:

isReturnBodyOnCreate

public boolean isReturnBodyOnCreate()

Whether to return a response body after creating an entity.

Returns:

true to return a body on create, false otherwise.

setReturnBodyOnCreate

public RepositoryRestConfiguration setReturnBodyOnCreate(boolean returnBodyOnCreate)

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

Parameters:

returnBodyOnCreate - true to return a body on create, false otherwise.

Returns:

this

isReturnBodyOnUpdate

public boolean isReturnBodyOnUpdate()

Whether to return a response body after updating an entity.

Returns:

true to return a body on update, false otherwise.

setReturnBodyOnUpdate

public RepositoryRestConfiguration setReturnBodyOnUpdate(boolean returnBodyOnUpdate)

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

Parameters:

returnBodyOnUpdate -

Returns:

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

public ProjectionDefinitionConfiguration projectionConfiguration()

Returns the ProjectionDefinitionConfiguration to register addition projections.

Returns: