public interface PageExtractionHandler
process.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 impl.servlet.PageExtractionHandlerListServlet
at
/libs/dam/content/indesign/extractionhandler.list.json
Clients are encouraged to extend from the provided AbstractPageExtractionHandler
.Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_PROPERTY_DESCRIPTION
Service property to provide a description for the implementation.
|
static String |
SERVICE_PROPERTY_LABEL
Service property to provide a label for the implementation.
|
Modifier and Type | Method and Description |
---|---|
Page |
extractPage(Rendition extractedRendition,
String pageRoot,
String pageName,
String pageTitle,
String pageTemplate,
String pageDesign)
|
RenditionPicker |
getRenditionPicker()
Get the rendition picker.
|
static final String SERVICE_PROPERTY_LABEL
impl.servlet.PageExtractionHandlerListServlet
.static final String SERVICE_PROPERTY_DESCRIPTION
impl.servlet.PageExtractionHandlerListServlet
.Page extractPage(Rendition extractedRendition, String pageRoot, String pageName, String pageTitle, String pageTemplate, String pageDesign) throws PageExtractionException
Page
from the given Rendition
.
The parameters are set by the configuration of the process.INDDPageExtractProcess
.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 designPageExtractionException
RenditionPicker getRenditionPicker()
RenditionPicker
to indicate what renditions they can handle."Copyright © 2006 - 2015 Adobe Systems Incorporated. All Rights Reserved"