com.adobe.aem.commons.assetshare.util.assetkit

Interface PagePathGenerator

All Known Implementing Classes:

YyyyMmPagePathPathGeneratorImpl

@ConsumerType
public interface PagePathGenerator

Method Summary

Modifier and Type	Method and Description
String	generatePagePath(String prefix, org.apache.sling.api.resource.Resource assetKit) Generates a page path based on the @{code prefix} and @{code assetKit} resource.
default String	getId() The id of the component updater.
String	getName() The name of the page path generator.

Method Detail

getName

String getName()

The name of the page path generator. Displays in the Asset kit creator workflow dialog's dropdown.

Returns:

the name of the page path generator. Ideally is unique across all page path generator, so you can tell which is which.

getId

default String getId()

The id of the component updater. Used to identify the component updater in the workflow dialog. Must be unique across all component updaters. Defaults to the component's full class name. No need to change the default implementation.

Returns:

the unique id of the page path generator.

generatePagePath

String generatePagePath(String prefix,
                        org.apache.sling.api.resource.Resource assetKit)

Generates a page path based on the @{code prefix} and @{code assetKit} resource.

Parameters:

prefix - the JCR path prefix all asset kit pages will be created under. This is defined in the Asset Kit creator workflow dialog.

assetKit - the resource (folder, collection) that represents the asset kit's contents.

Returns:

the full JCR path of the asset kit page.