io.wcm.handler.link.spi

Class LinkHandlerConfig

java.lang.Object

io.wcm.handler.link.spi.LinkHandlerConfig

All Implemented Interfaces:

io.wcm.sling.commons.caservice.ContextAwareService

@ConsumerType
public abstract class LinkHandlerConfig
extends Object
implements io.wcm.sling.commons.caservice.ContextAwareService

LinkHandlerConfig OSGi services provide application-specific configuration for link handling. Applications can set service properties or bundle headers as defined in ContextAwareService to apply this configuration only for resources that match the relevant resource paths.

Field Summary

Fields inherited from interface io.wcm.sling.commons.caservice.ContextAwareService

PROPERTY_ACCEPTS_CONTEXT_PATH_EMPTY, PROPERTY_CONTEXT_PATH_BLACKLIST_PATTERN, PROPERTY_CONTEXT_PATH_PATTERN

Constructor Summary

Constructors

Constructor and Description
LinkHandlerConfig()

Method Summary

Modifier and Type	Method and Description
List<Class<? extends LinkType>>	getLinkTypes()
List<Class<? extends LinkMarkupBuilder>>	getMarkupBuilders()
List<Class<? extends LinkProcessor>>	getPostProcessors()
List<Class<? extends LinkProcessor>>	getPreProcessors()
boolean	isRedirect(com.day.cq.wcm.api.Page page) Detected if page contains redirect link information
boolean	isValidLinkTarget(com.day.cq.wcm.api.Page page) Detected if page is acceptable as link target.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkHandlerConfig

public LinkHandlerConfig()

Method Detail

getLinkTypes

public List<Class<? extends LinkType>> getLinkTypes()

Returns:

Supported link types

getMarkupBuilders

public List<Class<? extends LinkMarkupBuilder>> getMarkupBuilders()

Returns:

Available link markup builders

getPreProcessors

public List<Class<? extends LinkProcessor>> getPreProcessors()

Returns:

List of link metadata pre processors (optional). The processors are applied in list order.

getPostProcessors

public List<Class<? extends LinkProcessor>> getPostProcessors()

Returns:

List of link metadata post processors (optional). The processors are applied in list order.

isValidLinkTarget

public boolean isValidLinkTarget(com.day.cq.wcm.api.Page page)

Detected if page is acceptable as link target. This is used by InternalLinkType, other LinkType implementations may implement other logic.

Parameters:

page - Page

Returns:

true if Page is acceptable as link target.

isRedirect

public boolean isRedirect(com.day.cq.wcm.api.Page page)

Detected if page contains redirect link information

Parameters:

page - Page

Returns:

true if Page is a redirect page