io.wcm.handler.link.type

Class InternalLinkType

java.lang.Object

io.wcm.handler.link.spi.LinkType

io.wcm.handler.link.type.InternalLinkType

@Model(adaptables={org.apache.sling.api.SlingHttpServletRequest.class,org.apache.sling.api.resource.Resource.class})
 @ProviderType
public final class InternalLinkType
extends LinkType

Default implementation of LinkType for internal links. Internal links are links to content pages inside the CMS.

This link type ensures all links target only pages inside the same inner-most configuration scope, which is usually the same site/language. All link paths referencing pages outside this content subtree are rewritten via UrlHandler.rewritePathToContext(Resource) with the root path of the inner-most configuration scope/site and then resolved.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID Link type ID

Constructor Summary

Constructors

Constructor and Description
InternalLinkType()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(LinkRequest linkRequest) Checks whether a link reference can be handled by this link type
boolean	accepts(String linkRef) Checks whether a link reference string can be handled by this link type
String	getId()
String	getPrimaryLinkRefProperty()
static org.apache.sling.api.resource.Resource	getSyntheticLinkResource(org.apache.sling.api.resource.ResourceResolver resourceResolver, String pageRef) Get synthetic link resource for this link type.
Link	resolveLink(Link link) Resolves a link
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

Link type ID

See Also:

Constant Field Values

Constructor Detail

InternalLinkType

public InternalLinkType()

Method Detail

getId

public String getId()

Specified by:

getId in class LinkType

Returns:

Link type ID (is stored as identifier in repository)

getPrimaryLinkRefProperty

public String getPrimaryLinkRefProperty()

Specified by:

getPrimaryLinkRefProperty in class LinkType

Returns:

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

accepts

public boolean accepts(String linkRef)

Description copied from class: LinkType

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

Specified by:

accepts in class LinkType

Parameters:

linkRef - Link reference string

Returns:

true if this link type can handle the given link reference

accepts

public boolean accepts(LinkRequest linkRequest)

Description copied from class: LinkType

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

Overrides:

accepts in class LinkType

Parameters:

linkRequest - Link reference

Returns:

true if this link type can handle the given link reference

resolveLink

public Link resolveLink(Link link)

Description copied from class: LinkType

Resolves a link

Specified by:

resolveLink in class LinkType

Parameters:

link - Link metadata

Returns:

Resolved link metadata. Never null.

getSyntheticLinkResource

public static org.apache.sling.api.resource.Resource getSyntheticLinkResource(org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                                                              String pageRef)

Get synthetic link resource for this link type.

Parameters:

resourceResolver - Resource resolver

pageRef - Path to target page

Returns:

Synthetic link resource

toString

public String toString()

Overrides:

toString in class Object