public abstract class AbstractTransformationRenderingEngine extends AbstractRenderingEngine
Modifier and Type | Class and Description |
---|---|
protected class |
AbstractTransformationRenderingEngine.TransformationCallable
Implementation of
Callable for doing the work of the transformation
which returns the temporary content writer if successful. |
AbstractRenderingEngine.RenderingContext
Modifier and Type | Field and Description |
---|---|
protected static int |
CANCELLED_ACTION_POLLING_INTERVAL
The frequency in milliseconds with which the
ActionTrackingService should
be polled for cancellation of the action. |
static String |
PARAM_MAX_PAGES
This optional
Integer parameter specifies the maximum number of pages of
the source that may be read. |
static String |
PARAM_MAX_SOURCE_SIZE_K_BYTES
This optional
Long parameter specifies the maximum number of kbytes of
the source may be read. |
static String |
PARAM_PAGE_LIMIT
This optional
Integer parameter specifies how many source
pages should be read in order to create an image. |
static String |
PARAM_READ_LIMIT_K_BYTES
This optional
Long parameter specifies how many kbytes of
the source to read in order to create an image. |
static String |
PARAM_READ_LIMIT_TIME_MS
This optional
Long parameter specifies how timeout for reading
the source before EOF is returned. |
static String |
PARAM_TIMEOUT_MS
This optional
Long parameter specifies the timeout for reading
the source before an exception is thrown. |
static String |
PARAM_USE
This optional
String parameter specifies the type (or use) of the rendition. |
actionTrackingService, CONTENT_READER_NOT_FOUND_MESSAGE, contentService, DEFAULT_RUN_AS_NAME, mimetypeMap, nodeService, PARAM_ENCODING, PARAM_MIME_TYPE, PARAM_PLACEHOLDER_RESOURCE_PATH, PARAM_RUN_AS, PARAM_SOURCE_CONTENT_PROPERTY, PARAM_TARGET_CONTENT_PROPERTY, PARAM_UPDATE_RENDITIONS_ON_ANY_PROPERTY_CHANGE
actionDefinition, applicableTypes, publicAction
adhocPropertiesAllowed, DISPLAY_LABEL, runtimeActionService
name
PARAM_RESULT
Constructor and Description |
---|
AbstractTransformationRenderingEngine() |
Modifier and Type | Method and Description |
---|---|
protected ExecutorService |
getExecutorService()
Gets the
ExecutorService to be used for cancel-aware
transforms. |
protected Collection<ParameterDefinition> |
getParameterDefinitions()
Supplies the list of parameters required by this rendering engine.
|
Collection<TransformationSourceOptions.TransformationSourceOptionsSerializer> |
getSourceOptionsSerializers() |
protected abstract TransformationOptions |
getTransformOptions(AbstractRenderingEngine.RenderingContext context) |
protected TransformationOptions |
getTransformOptionsImpl(TransformationOptions options,
AbstractRenderingEngine.RenderingContext context) |
void |
init()
Init method
|
protected void |
render(AbstractRenderingEngine.RenderingContext context) |
void |
setSourceOptionsSerializers(Collection<TransformationSourceOptions.TransformationSourceOptionsSerializer> sourceOptionsSerializers) |
addParameterDefinitions, checkActionIsRenditionDefinition, checkParameterValues, checkSourceNodeExists, createActionDefinition, executeImpl, executeImpl, executeRenditionImpl, getCheckedParam, getDefaultRenditionContentProp, getDefaultRenditionNodeType, getExecutionSummary, getParamDisplayLabel, getParamWithDefault, getRenditionContentProperty, getTargetEncoding, getTargetMimeType, notifyCallbackOfException, notifyCallbackOfResult, resolveRenditionLocation, setActionTrackingService, setBehaviourFilter, setContentService, setDefaultRenditionContentProp, setDefaultRenditionNodeType, setMimetypeMap, setNodeService, setRenditionLocationResolver, setRenditionService, switchToFinalRenditionNode, tagSourceNodeAsRenditioned, throwWrappedException
execute, getActionDefinition, getIgnoreLock, getQueueName, getTrackStatus, isApplicableType, onLogException, setApplicableTypes, setBaseNodeService, setDictionaryService, setIgnoreLock, setLockService, setMlAwareNodeService, setPublicAction, setQueueName, setTrackStatus
checkMandatoryProperties, getAdhocPropertiesAllowed, getDescriptionKey, getLocalizedParameterDefinitions, getParamDisplayLabel, getParameterDefintions, getTitleKey, setAdhocPropertiesAllowed, setLocales, setRuntimeActionService, toString
setBeanName
public static final String PARAM_TIMEOUT_MS
Long
parameter specifies the timeout for reading
the source before an exception is thrown.public static final String PARAM_READ_LIMIT_TIME_MS
Long
parameter specifies how timeout for reading
the source before EOF is returned.public static final String PARAM_MAX_SOURCE_SIZE_K_BYTES
Long
parameter specifies the maximum number of kbytes of
the source may be read. An exception is thrown before any are read if larger.public static final String PARAM_READ_LIMIT_K_BYTES
Long
parameter specifies how many kbytes of
the source to read in order to create an image.public static final String PARAM_MAX_PAGES
Integer
parameter specifies the maximum number of pages of
the source that may be read. An exception is thrown before any are read if larger.public static final String PARAM_PAGE_LIMIT
Integer
parameter specifies how many source
pages should be read in order to create an image.protected static final int CANCELLED_ACTION_POLLING_INTERVAL
ActionTrackingService
should
be polled for cancellation of the action.public AbstractTransformationRenderingEngine()
public Collection<TransformationSourceOptions.TransformationSourceOptionsSerializer> getSourceOptionsSerializers()
public void setSourceOptionsSerializers(Collection<TransformationSourceOptions.TransformationSourceOptionsSerializer> sourceOptionsSerializers)
protected ExecutorService getExecutorService()
ExecutorService
to be used for cancel-aware
transforms.
If no ExecutorService
has been defined a default
of Executors.newCachedThreadPool()
is used during
init()
.
ExecutorService
public void init()
ActionExecuterAbstractBase
init
in class ActionExecuterAbstractBase
protected void render(AbstractRenderingEngine.RenderingContext context)
render
in class AbstractRenderingEngine
protected abstract TransformationOptions getTransformOptions(AbstractRenderingEngine.RenderingContext context)
protected TransformationOptions getTransformOptionsImpl(TransformationOptions options, AbstractRenderingEngine.RenderingContext context)
protected Collection<ParameterDefinition> getParameterDefinitions()
AbstractRenderingEngine
getParameterDefinitions
in class AbstractRenderingEngine
Copyright © 2005–2017 Alfresco Software. All rights reserved.