io.wcm.handler.link.spi

Class LinkType

java.lang.Object

io.wcm.handler.link.spi.LinkType

Direct Known Subclasses:

ExternalLinkType, InternalCrossScopeLinkType, InternalLinkType, MediaLinkType

@ConsumerType
public abstract class LinkType
extends Object

Defines a link type supported by LinkHandler.

This interface has to be implemented by a Sling Model class. The adaptables should be SlingHttpServletRequest and Resource.

Constructor Summary

Constructors

Constructor and Description
LinkType()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(LinkRequest linkRequest) Checks whether a link reference can be handled by this link type
abstract boolean	accepts(String linkRef) Checks whether a link reference string can be handled by this link type
abstract String	getId()
abstract String	getPrimaryLinkRefProperty()
abstract Link	resolveLink(Link link) Resolves a link

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkType

public LinkType()

Method Detail

getId

public abstract String getId()

Returns:

Link type ID (is stored as identifier in repository)

getPrimaryLinkRefProperty

public abstract String getPrimaryLinkRefProperty()

Returns:

Name of the property in which the primary link reference is stored

accepts

public boolean accepts(LinkRequest linkRequest)

Checks whether a link reference can be handled by this link type

Parameters:

linkRequest - Link reference

Returns:

true if this link type can handle the given link reference

accepts

public abstract boolean accepts(String linkRef)

Checks whether a link reference string can be handled by this link type

Parameters:

linkRef - Link reference string

Returns:

true if this link type can handle the given link reference

resolveLink

public abstract Link resolveLink(Link link)

Resolves a link

Parameters:

link - Link metadata

Returns:

Resolved link metadata. Never null.