io.wcm.handler.link

Interface LinkHandler

@ProviderType
public interface LinkHandler

Manages link resolving and markup generation.

The interface is implemented by a Sling Model. You can adapt from SlingHttpServletRequest or Resource to get a context-specific handler instance.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INVALID_LINK Special link used to notify invalid links.

Method Summary

Modifier and Type	Method and Description
LinkBuilder	get(LinkRequest linkRequest) Build link for the given request holding all further request properties.
LinkBuilder	get(com.day.cq.wcm.api.Page page) Build internal link referencing the given content page.
LinkBuilder	get(org.apache.sling.api.resource.Resource resource) Build link which is referenced in the resource (containing properties e.g. pointing to internal or external link).

Field Detail

INVALID_LINK

static final String INVALID_LINK

Special link used to notify invalid links.

See Also:

Constant Field Values

Method Detail

get

LinkBuilder get(org.apache.sling.api.resource.Resource resource)

Build link which is referenced in the resource (containing properties e.g. pointing to internal or external link).

Parameters:

resource - Resource containing properties that define the link target

Returns:

Link builder

get

LinkBuilder get(com.day.cq.wcm.api.Page page)

Build internal link referencing the given content page.

Parameters:

page - Target content page

Returns:

Link builder

get

LinkBuilder get(LinkRequest linkRequest)

Build link for the given request holding all further request properties.

Parameters:

linkRequest - Link handling request

Returns:

Link builder