com.valtech.aem.saas.api.resource

Interface PathTransformer

public interface PathTransformer

Service interface for resource path mapping and externalizing.

Method Summary

Modifier and Type	Method and Description
String	externalize(org.apache.sling.api.resource.ResourceResolver resourceResolver, String path) Returns a URL for the passed path argument.
String	externalize(org.apache.sling.api.SlingHttpServletRequest request, String path) Returns a URL for the passed path argument.
List<String>	externalizeList(org.apache.sling.api.resource.ResourceResolver resourceResolver, String path) Returns one or more externalized URLs for the passed path argument.
List<String>	externalizeList(org.apache.sling.api.SlingHttpServletRequest request, String path) Returns one or more externalized URLs for the passed path argument.
String	map(org.apache.sling.api.SlingHttpServletRequest request, String path) Retrieves a path that is a result of the applied mapping rules.

Method Detail

externalizeList

List<String> externalizeList(org.apache.sling.api.SlingHttpServletRequest request,
                             String path)

Returns one or more externalized URLs for the passed path argument. It returns more than one URL in case a path can be represented by more than one url (e.g. for indexing). In the core implementation a path to an AEM page will be appended with the html extension and the Day CQ Link externalizer is used. For custom rewriting requirements, e.g. extensionless URLs, a custom PathTransformer which higher service ranking than 0 is required.

Parameters:

request - sling request used for context.

path - resource/page path to be externalized.

Returns:

list of externalized paths

externalizeList

List<String> externalizeList(org.apache.sling.api.resource.ResourceResolver resourceResolver,
                             String path)

Returns one or more externalized URLs for the passed path argument. It returns more than one URL in case a path can be represented by more than one url (e.g. for indexing). In the core implementation a path to an AEM page will be appended with the html extension and the Day CQ Link externalizer is used. For custom rewriting requirements, e.g. extensionless URLs, a custom PathTransformer which higher service ranking than 0 is required.

Parameters:

resourceResolver - resource resolver used for context.

path - resource/page path to be externalized.

Returns:

list of externalized paths

externalize

String externalize(org.apache.sling.api.SlingHttpServletRequest request,
                   String path)

Returns a URL for the passed path argument. In the core implementation a path to an AEM page will be appended with the html extension and the Day CQ Link externalizer is used. For custom rewriting requirements, e.g. extensionless URL, a custom PathTransformer which higher service ranking than 0 is required.

Parameters:

request - sling request used for context.

path - resource/page path to be externalized.

Returns:

externalized path

externalize

String externalize(org.apache.sling.api.resource.ResourceResolver resourceResolver,
                   String path)

Returns a URL for the passed path argument. In the core implementation a path to an AEM page will be appended with the html extension and the Day CQ Link externalizer is used. For custom rewriting requirements, e.g. extensionless URL, a custom PathTransformer which higher service ranking than 0 is required.

Parameters:

resourceResolver - resource resolver used for context.

path - resource/page path to be externalized.

Returns:

externalized path

map

String map(org.apache.sling.api.SlingHttpServletRequest request,
           String path)

Retrieves a path that is a result of the applied mapping rules. By default, the implementation uses resourceResolver::map. If customization is required a higher service ranking than 0 should be used

Parameters:

request - sling request used for context.

path - the resource's path on which the mapping rules are applied.

Returns:

mapped path.