org.dspace.app.rest.link.relation

Class RelationshipResourceWrapperHalLinkFactory

java.lang.Object

org.dspace.app.rest.link.HalLinkFactory<RelationshipResourceWrapper,RelationshipRestController>

org.dspace.app.rest.link.relation.RelationshipResourceWrapperHalLinkFactory

@Component
public class RelationshipResourceWrapperHalLinkFactory
extends HalLinkFactory<RelationshipResourceWrapper,RelationshipRestController>

This class' purpose is to add the links to the RelationshipResourceWrapper. This function and class will be called and used when the HalLinkService addLinks methods is called as it'll iterate over all the different factories and check whether these are allowed to create links for said resource or not.

Constructor Summary

Constructors

Constructor and Description
RelationshipResourceWrapperHalLinkFactory()

Method Summary

Modifier and Type	Method and Description
protected void	addLinks(RelationshipResourceWrapper halResource, org.springframework.data.domain.Pageable pageable, LinkedList<org.springframework.hateoas.Link> list)
protected Class<RelationshipRestController>	getControllerClass()
protected Class<RelationshipResourceWrapper>	getResourceClass()
String	getSelfLink(RelationshipRestWrapper content, org.springframework.data.domain.Pageable pageable) This method will construct a self link to the RelationshipRestController.retrieveByLabel method.

Methods inherited from class org.dspace.app.rest.link.HalLinkFactory

buildLink, buildLink, getLinksFor, getMethodOn, getMethodOn, supports, uriBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

RelationshipResourceWrapperHalLinkFactory

public RelationshipResourceWrapperHalLinkFactory()

Method Detail

addLinks

protected void addLinks(RelationshipResourceWrapper halResource,
                        org.springframework.data.domain.Pageable pageable,
                        LinkedList<org.springframework.hateoas.Link> list)
                 throws Exception

Specified by:

addLinks in class HalLinkFactory<RelationshipResourceWrapper,RelationshipRestController>

Throws:

Exception

getSelfLink

public String getSelfLink(RelationshipRestWrapper content,
                          org.springframework.data.domain.Pageable pageable)
                   throws Exception

This method will construct a self link to the RelationshipRestController.retrieveByLabel method. This will be constructed so that the RelationshipResourceWrapper resource can contain this selflink and immediately point to the correct endpoint with it.

Parameters:

content - The RelationshipRestWrapper from which we'll retrieve variables to construct the link

pageable - The page object

Returns:

The String determining the link to the correct endpoint

Throws:

Exception - If something goes wrong

getControllerClass

protected Class<RelationshipRestController> getControllerClass()

Specified by:

getControllerClass in class HalLinkFactory<RelationshipResourceWrapper,RelationshipRestController>

getResourceClass

protected Class<RelationshipResourceWrapper> getResourceClass()

Specified by:

getResourceClass in class HalLinkFactory<RelationshipResourceWrapper,RelationshipRestController>