org.alfresco.repo.rendition.executer

Class AbstractRenderingEngine

java.lang.Object

org.alfresco.repo.action.CommonResourceAbstractBase

org.alfresco.repo.action.ParameterizedItemAbstractBase

org.alfresco.repo.action.executer.ActionExecuterAbstractBase

org.alfresco.repo.rendition.executer.AbstractRenderingEngine

All Implemented Interfaces:

ActionExecuter, LoggingAwareExecuter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

Direct Known Subclasses:

AbstractTransformationRenderingEngine, BaseTemplateRenderingEngine, CompositeRenderingEngine, HTMLRenderingEngine

public abstract class AbstractRenderingEngine
extends ActionExecuterAbstractBase

This class adds some new behaviour to the standard ActionExecuterAbstractBase in order to support the RenditionService.

Since:

3.3

Author:

Neil McErlean, Nick Smith

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractRenderingEngine.RenderingContext

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionTrackingService	actionTrackingService
protected static String	CONTENT_READER_NOT_FOUND_MESSAGE
protected ContentService	contentService
protected static String	DEFAULT_RUN_AS_NAME
protected MimetypeMap	mimetypeMap
protected NamespaceService	namespaceService
protected NodeService	nodeService
static String	PARAM_ENCODING This optional String paramter specifies the encoding used to create the rendition content.
static String	PARAM_MIME_TYPE This optional String parameter specifies the mime type of the rendition content.
static String	PARAM_PLACEHOLDER_RESOURCE_PATH This optional String parameter specifies the location of a classpath resource which can be used as a placeholder while a rendition is being generated.
static String	PARAM_RUN_AS This optional String parameter specifies what user permissions are used when creating a rendition.
static String	PARAM_SOURCE_CONTENT_PROPERTY This optional QName parameter specifies which property the Rendering Engine uses to read content from the source node in order to create a rendition.
static String	PARAM_TARGET_CONTENT_PROPERTY This optional QName parameter specifies which property the Rendering Engine uses to write content to the rendition node.
static String	PARAM_UPDATE_RENDITIONS_ON_ANY_PROPERTY_CHANGE This optional Boolean flag property specifies whether a rendition should be updated automatically if the source node changes.

Fields inherited from class org.alfresco.repo.action.executer.ActionExecuterAbstractBase

actionDefinition, applicableTypes, publicAction

Fields inherited from class org.alfresco.repo.action.ParameterizedItemAbstractBase

adhocPropertiesAllowed, DISPLAY_LABEL, runtimeActionService

Fields inherited from class org.alfresco.repo.action.CommonResourceAbstractBase

name

Fields inherited from interface org.alfresco.repo.action.executer.ActionExecuter

PARAM_RESULT

Constructor Summary

Constructors

Constructor and Description
AbstractRenderingEngine()
AbstractRenderingEngine(NodeLocator temporaryParentNodeLocator, QName temporaryRenditionLinkType)

Method Summary

Modifier and Type	Method and Description
protected void	addParameterDefinitions(List<ParameterDefinition> paramList) Adds the parameter definitions to the list
protected RenditionDefinition	checkActionIsRenditionDefinition(Action action)
protected void	checkParameterValues(Action action) This method can be overridden by subclasses to provide checking of parameter values.
protected void	checkSourceNodeExists(NodeRef actionedUponNodeRef)
protected ActionDefinition	createActionDefinition(String definitionName) This method returns an instance of an ActionDefinition implementation class.
protected void	executeImpl(Action action, NodeRef sourceNode) Execute the action implementation
protected void	executeImpl(RenditionDefinition renditionDef, NodeRef sourceNode)
protected void	executeRenditionImpl(Action action, NodeRef sourceNode)
static <T> T	getCheckedParam(String paramName, Class<T> clazz, RenditionDefinition definition) Gets the value for the named parameter.
protected QName	getDefaultRenditionContentProp() This method returns the QName of the property that defines the location of the rendition content.
protected QName	getDefaultRenditionNodeType() This method returns the type of the default rendition node type.
protected ExecutionSummary	getExecutionSummary(AbstractRenderingEngine.RenderingContext renderingContext) Gets the ExecutionSummary for the given renderingContext from the ActionTrackingService.
protected String	getParamDisplayLabel(String paramName) This method gets the parameter definition display label from the properties file.
protected Collection<ParameterDefinition>	getParameterDefinitions() Supplies the list of parameters required by this rendering engine.
static <T> T	getParamWithDefault(String paramName, T defaultValue, RenditionDefinition definition) Gets the value for the named parameter.
protected QName	getRenditionContentProperty(RenditionDefinition renditionDefinition)
protected String	getTargetEncoding(AbstractRenderingEngine.RenderingContext context)
protected String	getTargetMimeType(AbstractRenderingEngine.RenderingContext context)
protected void	notifyCallbackOfException(RenditionDefinition renditionDefinition, Throwable t)
protected void	notifyCallbackOfResult(RenditionDefinition renditionDefinition, ChildAssociationRef result)
protected abstract void	render(AbstractRenderingEngine.RenderingContext context)
protected RenditionLocation	resolveRenditionLocation(NodeRef sourceNode, RenditionDefinition definition, NodeRef tempRendition) Given a rendition definition, a source node and a temporary rendition node, this method uses a RenditionLocationResolver to calculate the RenditionLocation of the rendition.
void	setActionTrackingService(ActionTrackingService actionTrackingService)
void	setBehaviourFilter(BehaviourFilter behaviourFilter)
void	setContentService(ContentService contentService) Set the content service
void	setDefaultRenditionContentProp(String prop) Sets the default rendition content property.
void	setDefaultRenditionNodeType(String type) Sets the default rendition-node type.
void	setMimetypeMap(MimetypeMap mimetypeMap)
void	setNamespaceService(NamespaceService namespaceService)
void	setNodeService(NodeService nodeService) Injects the nodeService bean.
void	setRenditionLocationResolver(RenditionLocationResolver renditionLocationResolver)
void	setRenditionService(RenditionService renditionService) Injects the renditionService bean.
protected void	switchToFinalRenditionNode(RenditionDefinition renditionDef, NodeRef actionedUponNodeRef)
protected void	tagSourceNodeAsRenditioned(RenditionDefinition renditionDef, NodeRef actionedUponNodeRef)
protected void	throwWrappedException(Throwable t)

Methods inherited from class org.alfresco.repo.action.executer.ActionExecuterAbstractBase

execute, getActionDefinition, getIgnoreLock, getQueueName, getTrackStatus, init, isApplicableType, onLogException, setApplicableTypes, setBaseNodeService, setDictionaryService, setIgnoreLock, setLockService, setMlAwareNodeService, setPublicAction, setQueueName, setTrackStatus

Methods inherited from class org.alfresco.repo.action.ParameterizedItemAbstractBase

checkMandatoryProperties, getAdhocPropertiesAllowed, getDescriptionKey, getLocalizedParameterDefinitions, getParamDisplayLabel, getParameterDefintions, getTitleKey, setAdhocPropertiesAllowed, setLocales, setRuntimeActionService, toString

Methods inherited from class org.alfresco.repo.action.CommonResourceAbstractBase

setBeanName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CONTENT_READER_NOT_FOUND_MESSAGE

protected static final String CONTENT_READER_NOT_FOUND_MESSAGE

See Also:

Constant Field Values

DEFAULT_RUN_AS_NAME

protected static final String DEFAULT_RUN_AS_NAME

contentService

protected ContentService contentService

mimetypeMap

protected MimetypeMap mimetypeMap

actionTrackingService

protected ActionTrackingService actionTrackingService

namespaceService

protected NamespaceService namespaceService

PARAM_PLACEHOLDER_RESOURCE_PATH

public static final String PARAM_PLACEHOLDER_RESOURCE_PATH

This optional String parameter specifies the location of a classpath resource which can be used as a placeholder while a rendition is being generated. For example, this might be a simple icon to indicate a rendition is not yet available. This is intended to be used in conjunction with asynchronous generation of renditions.

See Also:

Constant Field Values

PARAM_SOURCE_CONTENT_PROPERTY

public static final String PARAM_SOURCE_CONTENT_PROPERTY

This optional QName parameter specifies which property the Rendering Engine uses to read content from the source node in order to create a rendition. By default this property will be cm:content.

See Also:

Constant Field Values

PARAM_TARGET_CONTENT_PROPERTY

public static final String PARAM_TARGET_CONTENT_PROPERTY

This optional QName parameter specifies which property the Rendering Engine uses to write content to the rendition node. By default the property used is cm:content.

See Also:

Constant Field Values

PARAM_UPDATE_RENDITIONS_ON_ANY_PROPERTY_CHANGE

public static final String PARAM_UPDATE_RENDITIONS_ON_ANY_PROPERTY_CHANGE

This optional Boolean flag property specifies whether a rendition should be updated automatically if the source node changes. If set to true then the rendition will be re-rendered any time any property changes occur on the source node. This parameter defaults to false.

See Also:

Constant Field Values

PARAM_RUN_AS

public static final String PARAM_RUN_AS

This optional String parameter specifies what user permissions are used when creating a rendition. By default the system user is used.

See Also:

Constant Field Values

PARAM_MIME_TYPE

public static final String PARAM_MIME_TYPE

This optional String parameter specifies the mime type of the rendition content. This defaults to the mime type of the source node content.

See Also:

Constant Field Values

PARAM_ENCODING

public static final String PARAM_ENCODING

This optional String paramter specifies the encoding used to create the rendition content. The derfault encoding is UTF-8.

See Also:

Constant Field Values

nodeService

protected NodeService nodeService

Constructor Detail

AbstractRenderingEngine

public AbstractRenderingEngine(NodeLocator temporaryParentNodeLocator,
                               QName temporaryRenditionLinkType)

AbstractRenderingEngine

public AbstractRenderingEngine()

Method Detail

setNodeService

public void setNodeService(NodeService nodeService)

Injects the nodeService bean.

Parameters:

nodeService - the nodeService.

setRenditionService

public void setRenditionService(RenditionService renditionService)

Injects the renditionService bean.

Parameters:

renditionService - RenditionService

setBehaviourFilter

public void setBehaviourFilter(BehaviourFilter behaviourFilter)

Parameters:

behaviourFilter - policy behaviour filter

setRenditionLocationResolver

public void setRenditionLocationResolver(RenditionLocationResolver renditionLocationResolver)

setNamespaceService

public void setNamespaceService(NamespaceService namespaceService)

setDefaultRenditionNodeType

public void setDefaultRenditionNodeType(String type)

Sets the default rendition-node type.

Parameters:

type - String

getDefaultRenditionNodeType

protected QName getDefaultRenditionNodeType()

This method returns the type of the default rendition node type.

Returns:

the QName representing the type of the default rendition node type.

getTargetMimeType

protected String getTargetMimeType(AbstractRenderingEngine.RenderingContext context)

getTargetEncoding

protected String getTargetEncoding(AbstractRenderingEngine.RenderingContext context)

setDefaultRenditionContentProp

public void setDefaultRenditionContentProp(String prop)

Sets the default rendition content property.

Parameters:

prop - String

getDefaultRenditionContentProp

protected QName getDefaultRenditionContentProp()

This method returns the QName of the property that defines the location of the rendition content. An example would be cm:content.

Returns:

the QName the property defining the location of the rendition content.

setContentService

public void setContentService(ContentService contentService)

Set the content service

Parameters:

contentService - the content service

setMimetypeMap

public void setMimetypeMap(MimetypeMap mimetypeMap)

setActionTrackingService

public void setActionTrackingService(ActionTrackingService actionTrackingService)

createActionDefinition

protected ActionDefinition createActionDefinition(String definitionName)

Description copied from class: ActionExecuterAbstractBase

This method returns an instance of an ActionDefinition implementation class. By default this will be an ActionDefinitionImpl, but this could be overridden.

Overrides:

createActionDefinition in class ActionExecuterAbstractBase

executeImpl

protected void executeImpl(Action action,
                           NodeRef sourceNode)

Description copied from class: ActionExecuterAbstractBase

Execute the action implementation

Specified by:

executeImpl in class ActionExecuterAbstractBase

Parameters:

action - the action

sourceNode - the actioned upon node

executeImpl

protected void executeImpl(RenditionDefinition renditionDef,
                           NodeRef sourceNode)

executeRenditionImpl

protected void executeRenditionImpl(Action action,
                                    NodeRef sourceNode)

checkParameterValues

protected void checkParameterValues(Action action)

This method can be overridden by subclasses to provide checking of parameter values. If a parameter value is illegal or inappropriate, an exception should be thrown.

getRenditionContentProperty

protected QName getRenditionContentProperty(RenditionDefinition renditionDefinition)

Parameters:

renditionDefinition - RenditionDefinition

Returns:

QName

render

protected abstract void render(AbstractRenderingEngine.RenderingContext context)

checkSourceNodeExists

protected void checkSourceNodeExists(NodeRef actionedUponNodeRef)

Parameters:

actionedUponNodeRef - NodeRef

checkActionIsRenditionDefinition

protected RenditionDefinition checkActionIsRenditionDefinition(Action action)

Parameters:

action - Action

addParameterDefinitions

protected final void addParameterDefinitions(List<ParameterDefinition> paramList)

Description copied from class: ParameterizedItemAbstractBase

Adds the parameter definitions to the list

Specified by:

addParameterDefinitions in class ParameterizedItemAbstractBase

Parameters:

paramList - the parameter definitions list

getParamDisplayLabel

protected String getParamDisplayLabel(String paramName)

This method gets the parameter definition display label from the properties file. It looks first for a property whose key has a fixed rendition service-specific prefix and if that gets null, it then delegates to the standard bean name-based approach.

Overrides:

getParamDisplayLabel in class ParameterizedItemAbstractBase

Parameters:

paramName - the name of the parameter

Returns:

the display label of the parameter

getParameterDefinitions

protected Collection<ParameterDefinition> getParameterDefinitions()

Supplies the list of parameters required by this rendering engine.

getCheckedParam

public static <T> T getCheckedParam(String paramName,
                                    Class<T> clazz,
                                    RenditionDefinition definition)

Gets the value for the named parameter. Checks the type of the parameter is correct and throws a RenditionServiceException if it isn't. Returns null if the parameter value is null

Parameters:

paramName - the name of the parameter being checked.

clazz - the expected Class of the parameter value.

definition - the RenditionDefinition containing the parameters.

Returns:

the parameter value or null.

getParamWithDefault

public static <T> T getParamWithDefault(String paramName,
                                        T defaultValue,
                                        RenditionDefinition definition)

Gets the value for the named parameter. Checks the type of the parameter is the same as the type of defaultValue and throws a RenditionServiceException if it isn't. Returns defaultValue if the parameter value is null

Type Parameters:

T - T

Parameters:

paramName - String

defaultValue - T

definition - RenditionDefinition

Returns:

T

tagSourceNodeAsRenditioned

protected void tagSourceNodeAsRenditioned(RenditionDefinition renditionDef,
                                          NodeRef actionedUponNodeRef)

switchToFinalRenditionNode

protected void switchToFinalRenditionNode(RenditionDefinition renditionDef,
                                          NodeRef actionedUponNodeRef)

notifyCallbackOfException

protected void notifyCallbackOfException(RenditionDefinition renditionDefinition,
                                         Throwable t)

throwWrappedException

protected void throwWrappedException(Throwable t)

notifyCallbackOfResult

protected void notifyCallbackOfResult(RenditionDefinition renditionDefinition,
                                      ChildAssociationRef result)

resolveRenditionLocation

protected RenditionLocation resolveRenditionLocation(NodeRef sourceNode,
                                                     RenditionDefinition definition,
                                                     NodeRef tempRendition)

Given a rendition definition, a source node and a temporary rendition node, this method uses a RenditionLocationResolver to calculate the RenditionLocation of the rendition.

getExecutionSummary

protected ExecutionSummary getExecutionSummary(AbstractRenderingEngine.RenderingContext renderingContext)

Gets the ExecutionSummary for the given renderingContext from the ActionTrackingService.

Note that multiple summaries of the same action instance are not currently supported.

Parameters:

renderingContext - the rendering context

Returns:

the found summary or null