org.springframework.data.rest.webmvc.support

Class RepositoryEntityLinks

java.lang.Object

org.springframework.hateoas.core.AbstractEntityLinks

org.springframework.data.rest.webmvc.support.RepositoryEntityLinks

All Implemented Interfaces:

org.springframework.hateoas.EntityLinks, org.springframework.plugin.core.Plugin<Class<?>>

public class RepositoryEntityLinks
extends org.springframework.hateoas.core.AbstractEntityLinks

EntityLinks implementation that is able to create Link for domain classes managed by Spring Data REST.

Author:

Jon Brisbin, Oliver Gierke

Constructor Summary

Constructors

Constructor and Description
RepositoryEntityLinks(Repositories repositories, ResourceMappings mappings, RepositoryRestConfiguration config, PagingAndSortingTemplateVariables templateVariables, org.springframework.plugin.core.PluginRegistry<BackendIdConverter,Class<?>> idConverters) Creates a new RepositoryEntityLinks.

Method Summary

Modifier and Type	Method and Description
org.springframework.hateoas.LinkBuilder	linkFor(Class<?> type)
org.springframework.hateoas.LinkBuilder	linkFor(Class<?> type, Object... parameters)
org.springframework.hateoas.Links	linksToSearchResources(Class<?> type) Returns all links to search resource for the given type.
org.springframework.hateoas.Links	linksToSearchResources(Class<?> type, Pageable pageable) Returns all link to search resources for the given type, pre-expanded with the given Pageable if applicable.
org.springframework.hateoas.Links	linksToSearchResources(Class<?> type, Sort sort) Returns all link to search resources for the given type, pre-expanded with the given Sort if applicable.
org.springframework.hateoas.Link	linkToCollectionResource(Class<?> type)
org.springframework.hateoas.Link	linkToPagedResource(Class<?> type, Pageable pageable) Returns the link to to the paged colelction resource for the given type, pre-expanding the
org.springframework.hateoas.Link	linkToSearchResource(Class<?> domainType, String rel) Creates the link to the search resource with the given rel for a given type.
org.springframework.hateoas.Link	linkToSearchResource(Class<?> domainType, String rel, Pageable pageable) Creates the link to the search resource with the given rel for a given type.
org.springframework.hateoas.Link	linkToSearchResource(Class<?> domainType, String rel, Sort sort) Creates the link to the search resource with the given rel for a given type.
org.springframework.hateoas.Link	linkToSingleResource(Class<?> type, Object id)
boolean	supports(Class<?> delimiter)

Methods inherited from class org.springframework.hateoas.core.AbstractEntityLinks

linkForSingleResource, linkForSingleResource, linkToSingleResource

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryEntityLinks

@Autowired
public RepositoryEntityLinks(Repositories repositories,
                                        ResourceMappings mappings,
                                        RepositoryRestConfiguration config,
                                        PagingAndSortingTemplateVariables templateVariables,
                                        org.springframework.plugin.core.PluginRegistry<BackendIdConverter,Class<?>> idConverters)

Creates a new RepositoryEntityLinks.

Parameters:

repositories - must not be null.

mappings - must not be null.

config - must not be null.

pagingAndSortingTemplateVariables - must not be null.

idConverters - must not be null.

Method Detail

supports

public boolean supports(Class<?> delimiter)

linkFor

public org.springframework.hateoas.LinkBuilder linkFor(Class<?> type)

linkFor

public org.springframework.hateoas.LinkBuilder linkFor(Class<?> type,
                                                       Object... parameters)

linkToPagedResource

public org.springframework.hateoas.Link linkToPagedResource(Class<?> type,
                                                            Pageable pageable)

Returns the link to to the paged colelction resource for the given type, pre-expanding the

Parameters:

type - must not be null.

pageable - the pageable to can be null.

Returns:

linkToCollectionResource

public org.springframework.hateoas.Link linkToCollectionResource(Class<?> type)

linkToSingleResource

public org.springframework.hateoas.Link linkToSingleResource(Class<?> type,
                                                             Object id)

linksToSearchResources

public org.springframework.hateoas.Links linksToSearchResources(Class<?> type)

Returns all links to search resource for the given type.

Parameters:

type - must not be null.

Returns:

Since:

2.3

linksToSearchResources

public org.springframework.hateoas.Links linksToSearchResources(Class<?> type,
                                                                Pageable pageable)

Returns all link to search resources for the given type, pre-expanded with the given Pageable if applicable.

Parameters:

type - must not be null.

pageable - can be null.

Returns:

Since:

2.3

linksToSearchResources

public org.springframework.hateoas.Links linksToSearchResources(Class<?> type,
                                                                Sort sort)

Returns all link to search resources for the given type, pre-expanded with the given Sort if applicable.

Parameters:

type - must not be null.

sort - can be null.

Returns:

Since:

2.3

linkToSearchResource

public org.springframework.hateoas.Link linkToSearchResource(Class<?> domainType,
                                                             String rel)

Creates the link to the search resource with the given rel for a given type.

Parameters:

domainType - must not be null.

rel - must not be null or empty.

Returns:

Since:

2.3

linkToSearchResource

public org.springframework.hateoas.Link linkToSearchResource(Class<?> domainType,
                                                             String rel,
                                                             Pageable pageable)

Creates the link to the search resource with the given rel for a given type. Uses the given Pageable to pre-expand potentially available template variables.

Parameters:

domainType - must not be null.

rel - must not be null or empty.

pageable - can be null.

Returns:

Since:

2.3

linkToSearchResource

public org.springframework.hateoas.Link linkToSearchResource(Class<?> domainType,
                                                             String rel,
                                                             Sort sort)

Creates the link to the search resource with the given rel for a given type. Uses the given Sort to pre-expand potentially available template variables.

Parameters:

domainType - must not be null.

rel - must not be null or empty.

sort - can be null.

Returns:

Since:

2.3