org.apache.sling.sitemap.spi.common

Interface SitemapLinkExternalizer

All Known Subinterfaces:

SitemapLinkExternalizer

@ConsumerType
public interface SitemapLinkExternalizer

Consumers may implement this interface to override the default externalisation behaviour.

Field Summary

Fields

Modifier and Type	Field and Description
static SitemapLinkExternalizer	DEFAULT A default implementation of the SitemapLinkExternalizer which may be used as fallback.

Method Summary

Modifier and Type	Method and Description
@Nullable java.lang.String	externalize(Resource resource) Implementations must return an absolute url for the given resource.
@Nullable java.lang.String	externalize(SlingHttpServletRequest request, java.lang.String path) Implementations must return an absolute url for the given path in the context of the given request.

Field Detail

DEFAULT

static final SitemapLinkExternalizer DEFAULT

A default implementation of the SitemapLinkExternalizer which may be used as fallback.

Method Detail

externalize

@Nullable
@Nullable java.lang.String externalize(SlingHttpServletRequest request,
                                                 java.lang.String path)

Implementations must return an absolute url for the given path in the context of the given request.

Parameters:

request -

path -

Returns:

an absolute url

externalize

@Nullable
@Nullable java.lang.String externalize(Resource resource)

Implementations must return an absolute url for the given resource.

Parameters:

resource -

Returns:

an absolute url