Package com.day.cq.dam.indd

Interface PageExtractionHandler

All Known Implementing Classes:

AbstractPageExtractionHandler

public interface PageExtractionHandler

The PageExtractionHandler service.

This interface provides an extension point for the page extraction process as performed with the INDDPageExtractProcess.

Clients must implements this interface and provide as a service component in case they want to provide custom logic to create a Page from a Rendition. Implementations must indicate the rendition they are supporting by implementing getRenditionPicker(). The extraction as per extractPage(com.day.cq.dam.api.Rendition, String, String, String, String, String) is only performed if a rendition as per getRenditionPicker() is found on the asset.

Available implementations can be listed using the PageExtractionHandlerListServlet at /libs/dam/content/indesign/extractionhandler.list.json

Clients are encouraged to extend from the provided AbstractPageExtractionHandler.

Since:

5.5

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SERVICE_PROPERTY_DESCRIPTION	Service property to provide a description for the implementation.
static java.lang.String	SERVICE_PROPERTY_LABEL	Service property to provide a label for the implementation.

Method Summary

Modifier and Type	Method	Description
Page	extractPage(Rendition extractedRendition, java.lang.String pageRoot, java.lang.String pageName, java.lang.String pageTitle, java.lang.String pageTemplate, java.lang.String pageDesign)	Extract a Page from the given Rendition.
RenditionPicker	getRenditionPicker()	Get the rendition picker.

Field Detail

SERVICE_PROPERTY_LABEL

static final java.lang.String SERVICE_PROPERTY_LABEL

Service property to provide a label for the implementation.

Currently used in the listing of PageExtractionHandlerListServlet.

See Also:

Constant Field Values

SERVICE_PROPERTY_DESCRIPTION

static final java.lang.String SERVICE_PROPERTY_DESCRIPTION

Service property to provide a description for the implementation.

Currently used in the listing of PageExtractionHandlerListServlet.

See Also:

Constant Field Values

Method Detail

extractPage

Page extractPage(Rendition extractedRendition,
                 java.lang.String pageRoot,
                 java.lang.String pageName,
                 java.lang.String pageTitle,
                 java.lang.String pageTemplate,
                 java.lang.String pageDesign)
          throws PageExtractionException

Extract a Page from the given Rendition.

The parameters are set by the configuration of the INDDPageExtractProcess.

Parameters:

extractedRendition - The renditions to extract the page from.

pageRoot - The root path for the page.

pageName - The page name.

pageTitle - The page title.

pageTemplate - The page template.

pageDesign - The design

Returns:

Page The extracted page.

Throws:

PageExtractionException - exception caused in extracting page.

getRenditionPicker

RenditionPicker getRenditionPicker()

Get the rendition picker.

Implementations must provide a RenditionPicker to indicate what renditions they can handle.

Returns:

The rendition picker.