org.springframework.data.rest.webmvc

Class RepositoryController

java.lang.Object

org.springframework.data.rest.webmvc.RepositoryController

All Implemented Interfaces:

Aware, MessageSourceAware

@RepositoryRestController
public class RepositoryController
extends Object

Controller for the root resource exposing links to the repository resources.

Author:

Jon Brisbin, Oliver Gierke

Constructor Summary

Constructors

Constructor and Description
RepositoryController(PagedResourcesAssembler<Object> assembler, Repositories repositories, org.springframework.hateoas.EntityLinks entityLinks, ResourceMappings mappings) Creates a new RepositoryController for the given PagedResourcesAssembler, Repositories, EntityLinks and ResourceMappings.

Method Summary

Modifier and Type	Method and Description
protected <T extends Throwable> ResponseEntity<ExceptionMessage>	badRequest(HttpHeaders headers, T throwable)
protected <T extends Throwable> ResponseEntity<ExceptionMessage>	badRequest(T throwable)
protected org.springframework.hateoas.Resources<org.springframework.hateoas.Resource<Object>>	entitiesToResources(Iterable<Object> entities, PersistentEntityResourceAssembler assembler)
protected org.springframework.hateoas.Resources<? extends org.springframework.hateoas.Resource<Object>>	entitiesToResources(Page<Object> page, PersistentEntityResourceAssembler assembler, org.springframework.hateoas.Link baseLink)
<T extends Throwable> ResponseEntity<ExceptionMessage>	errorResponse(HttpHeaders headers, T throwable, HttpStatus status)
<T extends Throwable> ResponseEntity<ExceptionMessage>	errorResponse(T throwable, HttpStatus status)
ResponseEntity<Void>	handle(HttpRequestMethodNotSupportedException o_O) Send 405 Method Not Allowed and include the supported HttpMethods in the Allow header.
ResponseEntity	handleConflict(Exception ex) Send a 409 Conflict in case of concurrent modification.
ResponseEntity	handleMiscFailures(Throwable t) Handle failures commonly thrown from code tries to read incoming data and convert or cast it to the right type.
ResponseEntity<?>	handleNotFound()
ResponseEntity<ExceptionMessage>	handleNotReadable(HttpMessageNotReadableException e)
ResponseEntity<?>	handleNPE(NullPointerException npe)
ResponseEntity	handleRepositoryConstraintViolationException(Locale locale, RepositoryConstraintViolationException rcve)
ResponseEntity<?>	headForRepositories() HEAD /
HttpEntity<RepositoryLinksResource>	listRepositories() Lists all repositories exported by creating a link list pointing to resources exposing the repositories.
protected <T> ResponseEntity<T>	notFound()
protected <T> ResponseEntity<T>	notFound(HttpHeaders headers, T body)
HttpEntity<?>	optionsForRepositories() OPTIONS /.
protected org.springframework.hateoas.Link	resourceLink(RootResourceInformation resourceLink, org.springframework.hateoas.Resource resource)
<T> ResponseEntity<T>	response(HttpHeaders headers, T body, HttpStatus status)
protected org.springframework.hateoas.Resources	resultToResources(Object result, PersistentEntityResourceAssembler assembler, org.springframework.hateoas.Link baseLink)
void	setMessageSource(MessageSource messageSource)

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryController

@Autowired
public RepositoryController(PagedResourcesAssembler<Object> assembler,
                                       Repositories repositories,
                                       org.springframework.hateoas.EntityLinks entityLinks,
                                       ResourceMappings mappings)

Creates a new RepositoryController for the given PagedResourcesAssembler, Repositories, EntityLinks and ResourceMappings.

Parameters:

assembler - must not be null.

repositories - must not be null.

entityLinks - must not be null.

mappings - must not be null.

Method Detail

optionsForRepositories

@RequestMapping(value="/",
                method=OPTIONS)
public HttpEntity<?> optionsForRepositories()

OPTIONS /.

Returns:

Since:

2.2

headForRepositories

@RequestMapping(value="/",
                method=HEAD)
public ResponseEntity<?> headForRepositories()

HEAD /

Returns:

Since:

2.2

listRepositories

@RequestMapping(value="/",
                method=GET)
public HttpEntity<RepositoryLinksResource> listRepositories()

Lists all repositories exported by creating a link list pointing to resources exposing the repositories.

Returns:

setMessageSource

public void setMessageSource(MessageSource messageSource)

Specified by:

setMessageSource in interface MessageSourceAware

handleNPE

@ExceptionHandler(value=java.lang.NullPointerException.class)
 @ResponseBody
public ResponseEntity<?> handleNPE(NullPointerException npe)

handleNotFound

@ExceptionHandler(value=ResourceNotFoundException.class)
 @ResponseBody
public ResponseEntity<?> handleNotFound()

handleNotReadable

@ExceptionHandler(value=org.springframework.http.converter.HttpMessageNotReadableException.class)
 @ResponseBody
public ResponseEntity<ExceptionMessage> handleNotReadable(HttpMessageNotReadableException e)

handleMiscFailures

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

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

Parameters:

t -

Returns:

handleRepositoryConstraintViolationException

@ExceptionHandler(value=org.springframework.data.rest.core.RepositoryConstraintViolationException.class)
 @ResponseBody
public ResponseEntity handleRepositoryConstraintViolationException(Locale locale,
                                                                                                                                                                                           RepositoryConstraintViolationException rcve)

handleConflict

@ExceptionHandler(value={org.springframework.dao.OptimisticLockingFailureException.class,org.springframework.dao.DataIntegrityViolationException.class})
 @ResponseBody
public ResponseEntity handleConflict(Exception ex)

Send a 409 Conflict in case of concurrent modification.

Parameters:

ex -

Returns:

handle

@ExceptionHandler
 @ResponseBody
public ResponseEntity<Void> handle(HttpRequestMethodNotSupportedException o_O)

Send 405 Method Not Allowed and include the supported HttpMethods in the Allow header.

Parameters:

o_O -

Returns:

notFound

protected <T> ResponseEntity<T> notFound()

notFound

protected <T> ResponseEntity<T> notFound(HttpHeaders headers,
                                         T body)

badRequest

protected <T extends Throwable> ResponseEntity<ExceptionMessage> badRequest(T throwable)

badRequest

protected <T extends Throwable> ResponseEntity<ExceptionMessage> badRequest(HttpHeaders headers,
                                                                            T throwable)

errorResponse

public <T extends Throwable> ResponseEntity<ExceptionMessage> errorResponse(T throwable,
                                                                            HttpStatus status)

errorResponse

public <T extends Throwable> ResponseEntity<ExceptionMessage> errorResponse(HttpHeaders headers,
                                                                            T throwable,
                                                                            HttpStatus status)

response

public <T> ResponseEntity<T> response(HttpHeaders headers,
                                      T body,
                                      HttpStatus status)

resourceLink

protected org.springframework.hateoas.Link resourceLink(RootResourceInformation resourceLink,
                                                        org.springframework.hateoas.Resource resource)

resultToResources

protected org.springframework.hateoas.Resources resultToResources(Object result,
                                                                  PersistentEntityResourceAssembler assembler,
                                                                  org.springframework.hateoas.Link baseLink)

entitiesToResources

protected org.springframework.hateoas.Resources<? extends org.springframework.hateoas.Resource<Object>> entitiesToResources(Page<Object> page,
                                                                                                                            PersistentEntityResourceAssembler assembler,
                                                                                                                            org.springframework.hateoas.Link baseLink)

entitiesToResources

protected org.springframework.hateoas.Resources<org.springframework.hateoas.Resource<Object>> entitiesToResources(Iterable<Object> entities,
                                                                                                                  PersistentEntityResourceAssembler assembler)