org.springframework.hateoas.server

Interface LinkRelationProvider

All Superinterfaces:

org.springframework.plugin.core.Plugin<LinkRelationProvider.LookupContext>

All Known Implementing Classes:

AnnotationLinkRelationProvider, ControllerLinkRelationProvider, DefaultLinkRelationProvider, DelegatingLinkRelationProvider, EvoInflectorLinkRelationProvider

public interface LinkRelationProvider
extends org.springframework.plugin.core.Plugin<LinkRelationProvider.LookupContext>

API to provide LinkRelations for collections and items of the given type. Implementations can be selected based on the LinkRelationProvider.LookupContext, for item resource relations, collection resource relations or both.

Author:

Oliver Gierke

See Also:

supports(LookupContext)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LinkRelationProvider.LookupContext LinkRelationProvider selection context for item resource relation lookups (LinkRelationProvider.LookupContext.forItemResourceRelLookup(Class), collection resource relation lookups LinkRelationProvider.LookupContext.forCollectionResourceRelLookup(Class) or both LinkRelationProvider.LookupContext.forType(Class).

Method Summary

Modifier and Type	Method and Description
LinkRelation	getCollectionResourceRelFor(Class<?> type) Returns the relation type to be used to point to a collection resource of the given type.
LinkRelation	getItemResourceRelFor(Class<?> type) Returns the relation type to be used to point to an item resource of the given type.
boolean	supports(LinkRelationProvider.LookupContext delimiter) Callback method to manually select LinkRelationProvider implementations based on a given LinkRelationProvider.LookupContext.

Method Detail

getItemResourceRelFor

LinkRelation getItemResourceRelFor(Class<?> type)

Returns the relation type to be used to point to an item resource of the given type.

Parameters:

type - must not be null.

Returns:

getCollectionResourceRelFor

LinkRelation getCollectionResourceRelFor(Class<?> type)

Returns the relation type to be used to point to a collection resource of the given type.

Parameters:

type - must not be null.

Returns:

supports

boolean supports(LinkRelationProvider.LookupContext delimiter)

Callback method to manually select LinkRelationProvider implementations based on a given LinkRelationProvider.LookupContext. User code shouldn't need to call this method explicitly but rather use DelegatingLinkRelationProvider, equip that with a set of LinkRelationProvider implementations as that will perform the selection of the matching one on invocations of getItemResourceRelFor(Class) and getCollectionResourceRelFor(Class) transparently.

Specified by:

supports in interface org.springframework.plugin.core.Plugin<LinkRelationProvider.LookupContext>

See Also:

Plugin.supports(java.lang.Object)