org.springframework.data.rest.webmvc

Class RepositoryPropertyReferenceController

java.lang.Object

org.springframework.data.rest.webmvc.RepositoryPropertyReferenceController

All Implemented Interfaces:

Aware, InitializingBean, ApplicationEventPublisherAware, MessageSourceAware

@RepositoryRestController
public class RepositoryPropertyReferenceController
extends Object
implements ApplicationEventPublisherAware

Author:

Jon Brisbin, Oliver Gierke, Greg Turnquist

Constructor Summary

Constructors

Constructor and Description
RepositoryPropertyReferenceController(Repositories repositories, DomainClassConverter<?> domainClassConverter, PagedResourcesAssembler<Object> assembler, PersistentEntityResourceAssembler<Object> perAssembler)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected <T extends Throwable> ResponseEntity<ExceptionMessage>	badRequest(HttpHeaders headers, T throwable)
protected <T extends Throwable> ResponseEntity<ExceptionMessage>	badRequest(T throwable)
ResponseEntity<? extends org.springframework.hateoas.ResourceSupport>	createPropertyReference(org.springframework.data.rest.webmvc.RepositoryRestRequest repoRequest, org.springframework.hateoas.Resources<Object> incoming, String id, String property, UriComponentsBuilder builder)
ResponseEntity<? extends org.springframework.hateoas.ResourceSupport>	deletePropertyReference(org.springframework.data.rest.webmvc.RepositoryRestRequest repoRequest, String id, String property)
ResponseEntity<org.springframework.hateoas.ResourceSupport>	deletePropertyReferenceId(org.springframework.data.rest.webmvc.RepositoryRestRequest repoRequest, String id, String property, String propertyId)
protected org.springframework.hateoas.Resources<org.springframework.hateoas.Resource<Object>>	entitiesToResources(Iterable<Object> entities)
protected org.springframework.hateoas.Resources<? extends org.springframework.hateoas.Resource<Object>>	entitiesToResources(Page<Object> page, PagedResourcesAssembler<Object> assembler)
<T extends Throwable> ResponseEntity<ExceptionMessage>	errorResponse(HttpHeaders headers, T throwable, HttpStatus status)
<T extends Throwable> ResponseEntity<ExceptionMessage>	errorResponse(T throwable, HttpStatus status)
ResponseEntity<org.springframework.hateoas.ResourceSupport>	followPropertyReference(org.springframework.data.rest.webmvc.RepositoryRestRequest repoRequest, String id, String property)
ResponseEntity<org.springframework.hateoas.ResourceSupport>	followPropertyReference(org.springframework.data.rest.webmvc.RepositoryRestRequest repoRequest, String id, String property, String propertyId)
ResponseEntity<org.springframework.hateoas.ResourceSupport>	followPropertyReferenceCompact(org.springframework.data.rest.webmvc.RepositoryRestRequest repoRequest, String id, String property)
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<?>	handleNoSuchMethod()
ResponseEntity<?>	handleNotFound()
ResponseEntity<ExceptionMessage>	handleNotReadable(HttpMessageNotReadableException e)
ResponseEntity<?>	handleNPE(NullPointerException npe)
ResponseEntity	handleRepositoryConstraintViolationException(Locale locale, RepositoryConstraintViolationException rcve)
protected <T> ResponseEntity<T>	notFound()
protected <T> ResponseEntity<T>	notFound(HttpHeaders headers, T body)
protected org.springframework.hateoas.Link	resourceLink(org.springframework.data.rest.webmvc.RepositoryRestRequest repoRequest, org.springframework.hateoas.Resource resource)
<T> ResponseEntity<T>	response(HttpHeaders headers, T body, HttpStatus status)
protected org.springframework.hateoas.Resources	resultToResources(Object result)
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
void	setMessageSource(MessageSource messageSource)

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryPropertyReferenceController

@Autowired
public RepositoryPropertyReferenceController(Repositories repositories,
                                               DomainClassConverter<?> domainClassConverter,
                                               PagedResourcesAssembler<Object> assembler,
                                               PersistentEntityResourceAssembler<Object> perAssembler)

Method Detail

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

followPropertyReference

@RequestMapping(value="/{repository}/{id}/{property}",
                method=GET)
public ResponseEntity<org.springframework.hateoas.ResourceSupport> followPropertyReference(org.springframework.data.rest.webmvc.RepositoryRestRequest repoRequest,
                                                                                                               @PathVariable
                                                                                                               String id,
                                                                                                               @PathVariable
                                                                                                               String property)
                                                                                    throws ResourceNotFoundException,
                                                                                           NoSuchMethodException

Throws:

ResourceNotFoundException

NoSuchMethodException

deletePropertyReference

@RequestMapping(value="/{repository}/{id}/{property}",
                method=DELETE)
public ResponseEntity<? extends org.springframework.hateoas.ResourceSupport> deletePropertyReference(org.springframework.data.rest.webmvc.RepositoryRestRequest repoRequest,
                                                                                                                            @PathVariable
                                                                                                                            String id,
                                                                                                                            @PathVariable
                                                                                                                            String property)
                                                                                              throws ResourceNotFoundException,
                                                                                                     NoSuchMethodException,
                                                                                                     HttpRequestMethodNotSupportedException

Throws:

ResourceNotFoundException

NoSuchMethodException

HttpRequestMethodNotSupportedException

followPropertyReference

@RequestMapping(value="/{repository}/{id}/{property}/{propertyId}",
                method=GET,
                produces={"application/json","application/x-spring-data-verbose+json","application/x-spring-data-compact+json","text/uri-list"})
public ResponseEntity<org.springframework.hateoas.ResourceSupport> followPropertyReference(org.springframework.data.rest.webmvc.RepositoryRestRequest repoRequest,
                                                                                                                       @PathVariable
                                                                                                                       String id,
                                                                                                                       @PathVariable
                                                                                                                       String property,
                                                                                                                       @PathVariable
                                                                                                                       String propertyId)
                                                                                    throws ResourceNotFoundException,
                                                                                           NoSuchMethodException

Throws:

ResourceNotFoundException

NoSuchMethodException

followPropertyReferenceCompact

@RequestMapping(value="/{repository}/{id}/{property}",
                method=GET,
                produces={"application/x-spring-data-compact+json","text/uri-list"})
public ResponseEntity<org.springframework.hateoas.ResourceSupport> followPropertyReferenceCompact(org.springframework.data.rest.webmvc.RepositoryRestRequest repoRequest,
                                                                                                                              @PathVariable
                                                                                                                              String id,
                                                                                                                              @PathVariable
                                                                                                                              String property)
                                                                                           throws ResourceNotFoundException,
                                                                                                  NoSuchMethodException

Throws:

ResourceNotFoundException

NoSuchMethodException

createPropertyReference

@RequestMapping(value="/{repository}/{id}/{property}",
                method={POST,PUT},
                consumes={"application/json","application/x-spring-data-compact+json","text/uri-list"})
@ResponseBody
public ResponseEntity<? extends org.springframework.hateoas.ResourceSupport> createPropertyReference(org.springframework.data.rest.webmvc.RepositoryRestRequest repoRequest,
                                                                                                                                                  @RequestBody
                                                                                                                                                  org.springframework.hateoas.Resources<Object> incoming,
                                                                                                                                                  @PathVariable
                                                                                                                                                  String id,
                                                                                                                                                  @PathVariable
                                                                                                                                                  String property,
                                                                                                                                                  UriComponentsBuilder builder)
                                                                                              throws NoSuchMethodException

Throws:

NoSuchMethodException

deletePropertyReferenceId

@RequestMapping(value="/{repository}/{id}/{property}/{propertyId}",
                method=DELETE)
@ResponseBody
public ResponseEntity<org.springframework.hateoas.ResourceSupport> deletePropertyReferenceId(org.springframework.data.rest.webmvc.RepositoryRestRequest repoRequest,
                                                                                                                                 @PathVariable
                                                                                                                                 String id,
                                                                                                                                 @PathVariable
                                                                                                                                 String property,
                                                                                                                                 @PathVariable
                                                                                                                                 String propertyId)
                                                                                      throws NoSuchMethodException

Throws:

NoSuchMethodException

setMessageSource

public void setMessageSource(MessageSource messageSource)

Specified by:

setMessageSource in interface MessageSourceAware

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

handleNPE

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

handleNotFound

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

handleNoSuchMethod

@ExceptionHandler(value={java.lang.NoSuchMethodError.class,org.springframework.web.HttpRequestMethodNotSupportedException.class})
@ResponseBody
public ResponseEntity<?> handleNoSuchMethod()

handleNotReadable

@ExceptionHandler(value={org.springframework.http.converter.HttpMessageNotReadableException.class,org.springframework.http.converter.HttpMessageNotWritableException.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:

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(org.springframework.data.rest.webmvc.RepositoryRestRequest repoRequest,
                                            org.springframework.hateoas.Resource resource)

resultToResources

protected org.springframework.hateoas.Resources resultToResources(Object result)

entitiesToResources

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

entitiesToResources

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