org.springframework.data.rest.webmvc

Class RepositoryRestController

java.lang.Object

org.springframework.data.rest.repository.RepositoryExporterSupport<RepositoryRestController>

org.springframework.data.rest.webmvc.RepositoryRestController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class RepositoryRestController
extends RepositoryExporterSupport<RepositoryRestController>
implements org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean

Exports Spring Data Repositories over the web in a RESTful manner that is HATEOAS friendly.

This controller can be deployed in it's own DispatcherServlet. In that case, use the RepositoryRestExporterServlet in your web.xml. For example, to send all requests through the REST exporter, add the following to your web.xml:

<servlet>
   <servlet-name>exporter</servlet-name>
   <servlet-class>org.springframework.data.rest.webmvc.RepositoryRestExporterServlet</servlet-class>
   <load-on-startup>1</load-on-startup>
 </servlet>
 

 <servlet-mapping>
   <servlet-name>exporter</servlet-name>
   <url-pattern>/*</url-pattern>
 </servlet-mapping>
 

One can also deploy this controller into an existing Spring MVC application. In general, one should be able to simply create an instance of the RepositoryRestMvcConfiguration bean in your ApplicationContext or in JavaConfig.

If you wish to alter the way the REST exporter functions, you don't configure the controller directly. Instead there is a RepositoryRestConfiguration helper class that you create in your ApplicationContext. If a feature is configurable in Spring Data REST, there is a property on this helper to configure it.

Author:

Jon Brisbin

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOCATION
static java.lang.String	SELF

Fields inherited from class org.springframework.data.rest.repository.RepositoryExporterSupport

repositoryExporters

Constructor Summary

Constructors

Constructor and Description
RepositoryRestController()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
org.springframework.http.ResponseEntity<?>	clearLinks(org.springframework.http.server.ServletServerHttpRequest request, java.lang.String repository, java.lang.String id, java.lang.String property) Clear all linked entities of a specific property.
org.springframework.core.convert.ConversionService	conversionService()
RepositoryRestController	conversionServices(java.util.List<org.springframework.core.convert.ConversionService> conversionServices)
org.springframework.http.ResponseEntity<?>	create(org.springframework.http.server.ServletServerHttpRequest request, java.net.URI baseUri, java.lang.String repository) Create a new entity by reading the incoming data and calling CrudRepository.save(Object) and letting the ID be auto-generated.
org.springframework.http.ResponseEntity<?>	createOrUpdate(org.springframework.http.server.ServletServerHttpRequest request, java.net.URI baseUri, java.lang.String repository, java.lang.String id) Create an entity with a specific ID or update an existing entity.
org.springframework.http.ResponseEntity<?>	deleteEntity(org.springframework.http.server.ServletServerHttpRequest request, java.lang.String repository, java.lang.String id) Delete an entity.
org.springframework.http.ResponseEntity<?>	deleteLink(org.springframework.http.server.ServletServerHttpRequest request, java.lang.String repository, java.lang.String id, java.lang.String property, java.lang.String linkedId) Delete a specific relationship between a child entity and its parent.
org.springframework.http.ResponseEntity<?>	entity(org.springframework.http.server.ServletServerHttpRequest request, java.net.URI baseUri, java.lang.String repository, java.lang.String id) Retrieve a specific entity.
org.springframework.core.convert.ConversionService	getConversionService() Get the ConversionService in use by the controller.
UriToDomainObjectUriResolver	getDomainObjectResolver()
java.util.List<org.springframework.http.converter.HttpMessageConverter>	getHttpMessageConverters() Get the list of default HttpMessageConverters.
RepositoryAwareMappingHttpMessageConverter	getMappingHttpMessageConverter()
RepositoryRestConfiguration	getRepositoryRestConfig() Get the configuration currently in use.
org.springframework.http.ResponseEntity	handleConflict(java.lang.Exception ex, org.springframework.http.server.ServletServerHttpRequest request) Send a 409 Conflict in case of concurrent modification.
org.springframework.http.ResponseEntity	handleJsr303ValidationFailure(javax.validation.ConstraintViolationException ex, org.springframework.http.server.ServletServerHttpRequest request) Send a 400 Bad Request in case of a validation failure.
org.springframework.http.ResponseEntity	handleMessageConversionFailure(java.lang.Exception ex, javax.servlet.http.HttpServletRequest request) Send a 400 Bad Request in case no converter was found to process the input or output.
org.springframework.http.ResponseEntity	handleMiscFailures(java.lang.Throwable t, org.springframework.http.server.ServletServerHttpRequest request) Handle failures commonly thrown from code tries to read incoming data and convert or cast it to the right type.
org.springframework.http.ResponseEntity	handleNPE(java.lang.NullPointerException e, org.springframework.http.server.ServletServerHttpRequest request) Handle NPEs as a regular 500 error.
org.springframework.http.ResponseEntity	handleRepositoryNotFoundFailure(RepositoryNotFoundException e, org.springframework.http.server.ServletServerHttpRequest request) Send a 404 if no repository was found.
org.springframework.http.ResponseEntity	handleValidationFailure(RepositoryConstraintViolationException ex, org.springframework.http.server.ServletServerHttpRequest request) Send a 400 Bad Request in case of a validation failure.
java.util.List<org.springframework.http.converter.HttpMessageConverter>	httpMessageConverters()
RepositoryRestController	httpMessageConverters(java.util.List<org.springframework.http.converter.HttpMessageConverter> httpMessageConverters)
org.springframework.http.ResponseEntity<?>	linkedEntity(org.springframework.http.server.ServletServerHttpRequest request, java.net.URI baseUri, java.lang.String repository, java.lang.String id, java.lang.String property, java.lang.String linkedId) Retrieve a linked entity from a parent entity.
org.springframework.http.ResponseEntity<?>	listEntities(org.springframework.http.server.ServletServerHttpRequest request, PagingAndSorting pageSort, java.net.URI baseUri, java.lang.String repository) List entities of a CrudRepository by invoking CrudRepository.findAll() and applying any available paging parameters.
org.springframework.http.ResponseEntity<?>	listQueryMethods(org.springframework.http.server.ServletServerHttpRequest request, java.net.URI baseUri, java.lang.String repository) List the URIs of query methods found on this repository interface.
org.springframework.http.ResponseEntity<?>	listRepositories(org.springframework.http.server.ServletServerHttpRequest request, java.net.URI baseUri) List available CrudRepositorys that are being exported.
org.springframework.http.ResponseEntity<?>	propertyOfEntity(org.springframework.http.server.ServletServerHttpRequest request, java.net.URI baseUri, java.lang.String repository, java.lang.String id, java.lang.String property) Retrieve the property of an entity.
org.springframework.http.ResponseEntity<?>	query(org.springframework.http.server.ServletServerHttpRequest request, PagingAndSorting pageSort, java.net.URI baseUri, java.lang.String repository, java.lang.String query) Invoke a custom query method on a repository and page the results based on URL parameters supplied by the user or the default page size.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setConversionServices(java.util.List<org.springframework.core.convert.ConversionService> conversionServices) Add these ConversionServices to the list of those being delegated to by the internal DelegatingConversionService.
RepositoryRestController	setDomainObjectResolver(UriToDomainObjectUriResolver domainObjectResolver)
void	setHttpMessageConverters(java.util.List<org.springframework.http.converter.HttpMessageConverter> httpMessageConverters) Set the list of available HttpMessageConverters, clobbering the defaults.
RepositoryRestController	setMappingHttpMessageConverter(RepositoryAwareMappingHttpMessageConverter mappingHttpMessageConverter)
RepositoryRestController	setRepositoryRestConfig(RepositoryRestConfiguration config) Set the configuration this controller will use to inflence its behavior.
org.springframework.http.ResponseEntity<?>	updatePropertyOfEntity(org.springframework.http.server.ServletServerHttpRequest request, java.net.URI baseUri, java.lang.String repository, java.lang.String id, java.lang.String property) Update the property of an entity if that property is also managed by a CrudRepository.

Methods inherited from class org.springframework.data.rest.repository.RepositoryExporterSupport

getRepositoryExporters, hasRepositoryMetadataFor, hasRepositoryMetadataFor, repositoryExporters, repositoryExporters, repositoryExporters, repositoryMetadataFor, repositoryMetadataFor, repositoryMetadataFor, setRepositoryExporters

Methods inherited from class java.lang.Object

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

Field Detail

LOCATION

public static final java.lang.String LOCATION

See Also:

Constant Field Values

SELF

public static final java.lang.String SELF

See Also:

Constant Field Values

Constructor Detail

RepositoryRestController

public RepositoryRestController()

Method Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

getConversionService

public org.springframework.core.convert.ConversionService getConversionService()

Get the ConversionService in use by the controller.

Returns:

The internal ConversionServices.

setConversionServices

@Autowired(required=false)
public void setConversionServices(java.util.List<org.springframework.core.convert.ConversionService> conversionServices)

Add these ConversionServices to the list of those being delegated to by the internal DelegatingConversionService. Although this method does an 'add', it is called 'set' to make it JavaBean-friendly.

Parameters:

conversionServices -

conversionService

public org.springframework.core.convert.ConversionService conversionService()

Returns:

The internal ConversionService.

See Also:

getConversionService()

conversionServices

public RepositoryRestController conversionServices(java.util.List<org.springframework.core.convert.ConversionService> conversionServices)

Parameters:

conversionServices -

Returns:

@this

See Also:

setConversionServices(java.util.List)

getHttpMessageConverters

public java.util.List<org.springframework.http.converter.HttpMessageConverter> getHttpMessageConverters()

Get the list of default HttpMessageConverters.

Returns:

Default converters.

setHttpMessageConverters

public void setHttpMessageConverters(java.util.List<org.springframework.http.converter.HttpMessageConverter> httpMessageConverters)

Set the list of available HttpMessageConverters, clobbering the defaults. This does not, however, affect those user-defined converters that come from the RepositoryRestConfiguration.

Parameters:

httpMessageConverters -

httpMessageConverters

public java.util.List<org.springframework.http.converter.HttpMessageConverter> httpMessageConverters()

Returns:

@this

See Also:

getHttpMessageConverters()

httpMessageConverters

public RepositoryRestController httpMessageConverters(java.util.List<org.springframework.http.converter.HttpMessageConverter> httpMessageConverters)

Parameters:

httpMessageConverters -

Returns:

@this

See Also:

setHttpMessageConverters(java.util.List)

getRepositoryRestConfig

public RepositoryRestConfiguration getRepositoryRestConfig()

Get the configuration currently in use.

Returns:

Either the user-defined configuration or a default.

setRepositoryRestConfig

@Autowired(required=false)
public RepositoryRestController setRepositoryRestConfig(RepositoryRestConfiguration config)

Set the configuration this controller will use to inflence its behavior.

Parameters:

config -

Returns:

@this

getMappingHttpMessageConverter

public RepositoryAwareMappingHttpMessageConverter getMappingHttpMessageConverter()

setMappingHttpMessageConverter

@Autowired
public RepositoryRestController setMappingHttpMessageConverter(RepositoryAwareMappingHttpMessageConverter mappingHttpMessageConverter)

getDomainObjectResolver

public UriToDomainObjectUriResolver getDomainObjectResolver()

setDomainObjectResolver

@Autowired
public RepositoryRestController setDomainObjectResolver(UriToDomainObjectUriResolver domainObjectResolver)

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

listRepositories

@RequestMapping(value="/",
                method=GET)
@ResponseBody
public org.springframework.http.ResponseEntity<?> listRepositories(org.springframework.http.server.ServletServerHttpRequest request,
                                                                                      java.net.URI baseUri)
                                                            throws java.io.IOException

List available CrudRepositorys that are being exported.

Parameters:

request -

baseUri -

Returns:

Throws:

java.io.IOException

listEntities

@RequestMapping(value="/{repository}",
                method=GET)
@ResponseBody
public org.springframework.http.ResponseEntity<?> listEntities(org.springframework.http.server.ServletServerHttpRequest request,
                                                                                  PagingAndSorting pageSort,
                                                                                  java.net.URI baseUri,
                                                                                  @PathVariable
                                                                                  java.lang.String repository)
                                                        throws java.io.IOException

List entities of a CrudRepository by invoking CrudRepository.findAll() and applying any available paging parameters.

Parameters:

request -

pageSort -

baseUri -

repository -

Returns:

Throws:

java.io.IOException

listQueryMethods

@RequestMapping(value="/{repository}/search",
                method=GET)
@ResponseBody
public org.springframework.http.ResponseEntity<?> listQueryMethods(org.springframework.http.server.ServletServerHttpRequest request,
                                                                                      java.net.URI baseUri,
                                                                                      @PathVariable
                                                                                      java.lang.String repository)
                                                            throws java.io.IOException

List the URIs of query methods found on this repository interface.

Parameters:

request -

baseUri -

repository -

Returns:

Throws:

java.io.IOException

query

@RequestMapping(value="/{repository}/search/{query}",
                method=GET)
@ResponseBody
public org.springframework.http.ResponseEntity<?> query(org.springframework.http.server.ServletServerHttpRequest request,
                                                                           PagingAndSorting pageSort,
                                                                           java.net.URI baseUri,
                                                                           @PathVariable
                                                                           java.lang.String repository,
                                                                           @PathVariable
                                                                           java.lang.String query)
                                                 throws java.lang.reflect.InvocationTargetException,
                                                        java.lang.IllegalAccessException,
                                                        java.io.IOException

Invoke a custom query method on a repository and page the results based on URL parameters supplied by the user or the default page size.

Parameters:

request -

pageSort -

baseUri -

repository -

query -

Returns:

Throws:

java.lang.reflect.InvocationTargetException

java.lang.IllegalAccessException

java.io.IOException

create

@RequestMapping(value="/{repository}",
                method=POST)
@ResponseBody
public org.springframework.http.ResponseEntity<?> create(org.springframework.http.server.ServletServerHttpRequest request,
                                                                            java.net.URI baseUri,
                                                                            @PathVariable
                                                                            java.lang.String repository)
                                                  throws java.io.IOException

Create a new entity by reading the incoming data and calling CrudRepository.save(Object) and letting the ID be auto-generated.

To get the entity back in the body of the response, simpy add the URL parameter

returnBody=true

.

Parameters:

request -

baseUri -

repository -

Returns:

Throws:

java.io.IOException

entity

@RequestMapping(value="/{repository}/{id}",
                method=GET)
@ResponseBody
public org.springframework.http.ResponseEntity<?> entity(org.springframework.http.server.ServletServerHttpRequest request,
                                                                            java.net.URI baseUri,
                                                                            @PathVariable
                                                                            java.lang.String repository,
                                                                            @PathVariable
                                                                            java.lang.String id)
                                                  throws java.io.IOException

Retrieve a specific entity.

Parameters:

request -

baseUri -

repository -

id -

Returns:

Throws:

java.io.IOException

createOrUpdate

@RequestMapping(value="/{repository}/{id}",
                method=PUT)
@ResponseBody
public org.springframework.http.ResponseEntity<?> createOrUpdate(org.springframework.http.server.ServletServerHttpRequest request,
                                                                                    java.net.URI baseUri,
                                                                                    @PathVariable
                                                                                    java.lang.String repository,
                                                                                    @PathVariable
                                                                                    java.lang.String id)
                                                          throws java.io.IOException,
                                                                 java.lang.IllegalAccessException,
                                                                 java.lang.InstantiationException

Create an entity with a specific ID or update an existing entity.

Parameters:

request -

baseUri -

repository -

id -

Returns:

Throws:

java.io.IOException

java.lang.IllegalAccessException

java.lang.InstantiationException

deleteEntity

@RequestMapping(value="/{repository}/{id}",
                method=DELETE)
@ResponseBody
public org.springframework.http.ResponseEntity<?> deleteEntity(org.springframework.http.server.ServletServerHttpRequest request,
                                                                                  @PathVariable
                                                                                  java.lang.String repository,
                                                                                  @PathVariable
                                                                                  java.lang.String id)
                                                        throws java.io.IOException

Delete an entity.

Parameters:

request -

repository -

id -

Returns:

Throws:

java.io.IOException

propertyOfEntity

@RequestMapping(value="/{repository}/{id}/{property}",
                method=GET)
@ResponseBody
public org.springframework.http.ResponseEntity<?> propertyOfEntity(org.springframework.http.server.ServletServerHttpRequest request,
                                                                                      java.net.URI baseUri,
                                                                                      @PathVariable
                                                                                      java.lang.String repository,
                                                                                      @PathVariable
                                                                                      java.lang.String id,
                                                                                      @PathVariable
                                                                                      java.lang.String property)
                                                            throws java.io.IOException

Retrieve the property of an entity.

Parameters:

request -

baseUri -

repository -

id -

property -

Returns:

Throws:

java.io.IOException

updatePropertyOfEntity

@RequestMapping(value="/{repository}/{id}/{property}",
                method={PUT,POST})
@ResponseBody
public org.springframework.http.ResponseEntity<?> updatePropertyOfEntity(org.springframework.http.server.ServletServerHttpRequest request,
                                                                                            java.net.URI baseUri,
                                                                                            @PathVariable
                                                                                            java.lang.String repository,
                                                                                            @PathVariable
                                                                                            java.lang.String id,
                                                                                            @PathVariable
                                                                                            java.lang.String property)
                                                                  throws java.io.IOException

Update the property of an entity if that property is also managed by a CrudRepository.

Parameters:

request -

baseUri -

repository -

id -

property -

Returns:

Throws:

java.io.IOException

clearLinks

@RequestMapping(value="/{repository}/{id}/{property}",
                method=DELETE)
@ResponseBody
public org.springframework.http.ResponseEntity<?> clearLinks(org.springframework.http.server.ServletServerHttpRequest request,
                                                                                @PathVariable
                                                                                java.lang.String repository,
                                                                                @PathVariable
                                                                                java.lang.String id,
                                                                                @PathVariable
                                                                                java.lang.String property)
                                                      throws java.io.IOException

Clear all linked entities of a specific property.

Parameters:

request -

repository -

id -

property -

Returns:

Throws:

java.io.IOException

linkedEntity

@RequestMapping(value="/{repository}/{id}/{property}/{linkedId}",
                method=GET)
@ResponseBody
public org.springframework.http.ResponseEntity<?> linkedEntity(org.springframework.http.server.ServletServerHttpRequest request,
                                                                                  java.net.URI baseUri,
                                                                                  @PathVariable
                                                                                  java.lang.String repository,
                                                                                  @PathVariable
                                                                                  java.lang.String id,
                                                                                  @PathVariable
                                                                                  java.lang.String property,
                                                                                  @PathVariable
                                                                                  java.lang.String linkedId)
                                                        throws java.io.IOException

Retrieve a linked entity from a parent entity.

Parameters:

request -

baseUri -

repository -

id -

property -

linkedId -

Returns:

Throws:

java.io.IOException

deleteLink

@RequestMapping(value="/{repository}/{id}/{property}/{linkedId}",
                method=DELETE)
@ResponseBody
public org.springframework.http.ResponseEntity<?> deleteLink(org.springframework.http.server.ServletServerHttpRequest request,
                                                                                @PathVariable
                                                                                java.lang.String repository,
                                                                                @PathVariable
                                                                                java.lang.String id,
                                                                                @PathVariable
                                                                                java.lang.String property,
                                                                                @PathVariable
                                                                                java.lang.String linkedId)
                                                      throws java.io.IOException

Delete a specific relationship between a child entity and its parent.

Parameters:

request -

repository -

id -

property -

linkedId -

Returns:

Throws:

java.io.IOException

handleRepositoryNotFoundFailure

@ExceptionHandler(value=RepositoryNotFoundException.class)
@ResponseBody
public org.springframework.http.ResponseEntity handleRepositoryNotFoundFailure(RepositoryNotFoundException e,
                                                                                                                                     org.springframework.http.server.ServletServerHttpRequest request)
                                                                        throws java.io.IOException

Send a 404 if no repository was found.

Parameters:

e -

request -

Returns:

Throws:

java.io.IOException

handleNPE

@ExceptionHandler(value=java.lang.NullPointerException.class)
@ResponseBody
public org.springframework.http.ResponseEntity handleNPE(java.lang.NullPointerException e,
                                                                                                                  org.springframework.http.server.ServletServerHttpRequest request)
                                                  throws java.io.IOException

Handle NPEs as a regular 500 error.

Parameters:

e -

request -

Returns:

Throws:

java.io.IOException

handleMiscFailures

@ExceptionHandler(value={java.lang.reflect.InvocationTargetException.class,java.lang.IllegalArgumentException.class,java.lang.ClassCastException.class,org.springframework.core.convert.ConversionFailedException.class})
@ResponseBody
public org.springframework.http.ResponseEntity handleMiscFailures(java.lang.Throwable t,
                                                                                                                                                                                                                                                                                  org.springframework.http.server.ServletServerHttpRequest request)
                                                           throws java.io.IOException

Handle failures commonly thrown from code tries to read incoming data and convert or cast it to the right type.

Parameters:

t -

request -

Returns:

Throws:

java.io.IOException

handleConflict

@ExceptionHandler(value={org.springframework.dao.OptimisticLockingFailureException.class,org.springframework.dao.DataIntegrityViolationException.class})
@ResponseBody
public org.springframework.http.ResponseEntity handleConflict(java.lang.Exception ex,
                                                                                                                                                                                                               org.springframework.http.server.ServletServerHttpRequest request)
                                                       throws java.io.IOException

Send a 409 Conflict in case of concurrent modification.

Parameters:

ex -

request -

Returns:

Throws:

java.io.IOException

handleValidationFailure

@ExceptionHandler(value=RepositoryConstraintViolationException.class)
@ResponseBody
public org.springframework.http.ResponseEntity handleValidationFailure(RepositoryConstraintViolationException ex,
                                                                                                                                        org.springframework.http.server.ServletServerHttpRequest request)
                                                                throws java.io.IOException

Send a 400 Bad Request in case of a validation failure.

Parameters:

ex -

request -

Returns:

Throws:

java.io.IOException

handleJsr303ValidationFailure

@ExceptionHandler(value=javax.validation.ConstraintViolationException.class)
@ResponseBody
public org.springframework.http.ResponseEntity handleJsr303ValidationFailure(javax.validation.ConstraintViolationException ex,
                                                                                                                                                     org.springframework.http.server.ServletServerHttpRequest request)
                                                                      throws java.io.IOException

Send a 400 Bad Request in case of a validation failure.

Parameters:

ex -

request -

Returns:

Throws:

java.io.IOException

handleMessageConversionFailure

@ExceptionHandler(value={org.springframework.http.converter.HttpMessageNotReadableException.class,org.springframework.http.converter.HttpMessageNotWritableException.class})
@ResponseBody
public org.springframework.http.ResponseEntity handleMessageConversionFailure(java.lang.Exception ex,
                                                                                                                                                                                                                                                   javax.servlet.http.HttpServletRequest request)
                                                                       throws java.io.IOException

Send a 400 Bad Request in case no converter was found to process the input or output.

Parameters:

ex -

request -

Returns:

Throws:

java.io.IOException