org.springframework.data.rest.webmvc

Class RepositoryController

java.lang.Object

org.springframework.data.rest.webmvc.RepositoryController

@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 org.springframework.hateoas.Resources<?>	entitiesToResources(Iterable<Object> entities, PersistentEntityResourceAssembler assembler, Class<?> domainType)
protected org.springframework.hateoas.Resources<?>	entitiesToResources(Page<Object> page, PersistentEntityResourceAssembler assembler, Class<?> domainType, org.springframework.hateoas.Link baseLink)
protected org.springframework.hateoas.Link	getDefaultSelfLink()
ResponseEntity<?>	headForRepositories() HEAD /
HttpEntity<RepositoryLinksResource>	listRepositories() Lists all repositories exported by creating a link list pointing to resources exposing the repositories.
HttpEntity<?>	optionsForRepositories() OPTIONS /.
protected org.springframework.hateoas.Link	resourceLink(RootResourceInformation resourceLink, org.springframework.hateoas.Resource resource)
protected Object	toResource(Object source, PersistentEntityResourceAssembler assembler, Class<?> domainType, org.springframework.hateoas.Link baseLink) Turns the given source into a ResourceSupport if needed and possible.
protected org.springframework.hateoas.Resources<?>	toResources(Iterable<?> source, PersistentEntityResourceAssembler assembler, Class<?> domainType, org.springframework.hateoas.Link baseLink)

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:

resourceLink

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

toResources

protected org.springframework.hateoas.Resources<?> toResources(Iterable<?> source,
                                                               PersistentEntityResourceAssembler assembler,
                                                               Class<?> domainType,
                                                               org.springframework.hateoas.Link baseLink)

toResource

protected Object toResource(Object source,
                            PersistentEntityResourceAssembler assembler,
                            Class<?> domainType,
                            org.springframework.hateoas.Link baseLink)

Turns the given source into a ResourceSupport if needed and possible. Uses the given PersistentEntityResourceAssembler for the actual conversion.

Parameters:

source - can be must not be null.

assembler - must not be null.

domainType - the domain type in case the source is an empty iterable, must not be null.

baseLink - can be null.

Returns:

entitiesToResources

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

entitiesToResources

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

getDefaultSelfLink

protected org.springframework.hateoas.Link getDefaultSelfLink()