Package org.springframework.hateoas.server.mvc

Class ControllerLinkRelationProvider

java.lang.Object

org.springframework.hateoas.server.mvc.ControllerLinkRelationProvider

All Implemented Interfaces:

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

public class ControllerLinkRelationProvider
extends Object
implements LinkRelationProvider

LinkRelationProvider inspecting ExposesResourceFor annotations on controller classes.

Author:

Oliver Drotbohm

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.hateoas.server.LinkRelationProvider

LinkRelationProvider.LookupContext

Constructor Summary

Constructors

Constructor	Description
ControllerLinkRelationProvider(Class<?> controller, org.springframework.plugin.core.PluginRegistry<LinkRelationProvider,LinkRelationProvider.LookupContext> providers)	Creates a new ControllerLinkRelationProvider

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ControllerLinkRelationProvider

public ControllerLinkRelationProvider(Class<?> controller,
 org.springframework.plugin.core.PluginRegistry<LinkRelationProvider,LinkRelationProvider.LookupContext> providers)

Creates a new ControllerLinkRelationProvider

Parameters:

controller - must not be null.

providers - must not be null.

Method Details

getItemResourceRelFor

public LinkRelation getItemResourceRelFor(Class<?> resource)

Description copied from interface: LinkRelationProvider

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

Specified by:

getItemResourceRelFor in interface LinkRelationProvider

Parameters:

resource - must not be null.

Returns:

getCollectionResourceRelFor

public LinkRelation getCollectionResourceRelFor(Class<?> resource)

Description copied from interface: LinkRelationProvider

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

Specified by:

getCollectionResourceRelFor in interface LinkRelationProvider

Parameters:

resource - must not be null.

Returns:

supports

public boolean supports(LinkRelationProvider.LookupContext context)

Description copied from interface: LinkRelationProvider

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 LinkRelationProvider.getItemResourceRelFor(Class) and LinkRelationProvider.getCollectionResourceRelFor(Class) transparently.

Specified by:

supports in interface LinkRelationProvider

Specified by:

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

See Also:

• Plugin.supports(java.lang.Object)