org.alfresco.repo.rendition.executer

Class BaseTemplateRenderingEngine

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

org.alfresco.repo.rendition.executer.BaseTemplateRenderingEngine

All Implemented Interfaces:

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

Direct Known Subclasses:

FreemarkerRenderingEngine, XSLTRenderingEngine

public abstract class BaseTemplateRenderingEngine
extends AbstractRenderingEngine

This abstract class forms a basis for all rendering engines that are built around the Template Service.
A template must be specified either as a String using the PARAM_TEMPLATE parameter, as a NodeRef using the PARAM_TEMPLATE_NODE parameter or as a file path location using the PARAM_TEMPLATE_PATH parameter. The RenderingEngine reads from these parameters with the following priority: PARAM_TEMPLATE > PARAM_TEMPLATE_NODE > PARAM_TEMPLATE_PATH.

Since:

3.3

Author:

Brian Remmington

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.repo.rendition.executer.AbstractRenderingEngine

AbstractRenderingEngine.RenderingContext

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_MODEL This optional Map<String, Serializable> parameter can be used to pass additional arguments to the templating engine when processing a template.
static String	PARAM_TEMPLATE This optional String parameter specifies the template in a simple String format. If this parameter is set the Rendering Engine will use it in preference to templates specified by either the PARAM_TEMPLATE_NODE or the PARAM_TEMPLATE_PATH parameters.
static String	PARAM_TEMPLATE_NODE This optional NodeRef parameter specifies a node containing the template to be processed. If a value is specified for PARAM_TEMPLATE then this parameter will be ignored. If a value is specified for this parameter it will be used in preference to values specified for the PARAM_TEMPLATE_PATH parameter.
static String	PARAM_TEMPLATE_PATH This optional String parameter specifies a file path location for the template to be processed. If a value is specified for PARAM_TEMPLATE or PARAM_TEMPLATE_NODE then this parameter will be ignored.

Fields inherited from class org.alfresco.repo.rendition.executer.AbstractRenderingEngine

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

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
BaseTemplateRenderingEngine()

Method Summary

Modifier and Type	Method and Description
protected abstract Object	buildModel(AbstractRenderingEngine.RenderingContext context) Create the model that will be passed to the template service for rendering with the appropriate template.
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.
org.alfresco.service.cmr.search.SearchService	getSearchService()
protected org.alfresco.service.cmr.repository.NodeRef	getTemplateNode(AbstractRenderingEngine.RenderingContext context)
TemplateService	getTemplateService()
protected abstract String	getTemplateType() Get the type of template that is to be used.
protected void	render(AbstractRenderingEngine.RenderingContext context)
void	setSearchService(org.alfresco.service.cmr.search.SearchService searchService)
void	setTemplateService(TemplateService templateService)

Methods inherited from class org.alfresco.repo.rendition.executer.AbstractRenderingEngine

addParameterDefinitions, checkActionIsRenditionDefinition, checkParameterValues, checkSourceNodeExists, createActionDefinition, executeImpl, executeImpl, executeRenditionImpl, getCheckedParam, getDefaultRenditionContentProp, getDefaultRenditionNodeType, getExecutionSummary, getParamWithDefault, getRenditionContentProperty, getTargetEncoding, getTargetMimeType, notifyCallbackOfException, notifyCallbackOfResult, resolveRenditionLocation, setActionTrackingService, setBehaviourFilter, setContentService, setDefaultRenditionContentProp, setDefaultRenditionNodeType, setMimetypeMap, setNodeService, setRenditionLocationResolver, setRenditionService, switchToFinalRenditionNode, tagSourceNodeAsRenditioned, throwWrappedException

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

PARAM_MODEL

public static final String PARAM_MODEL

This optional Map<String, Serializable> parameter can be used to pass additional arguments to the templating engine when processing a template.

See Also:

Constant Field Values

PARAM_TEMPLATE

public static final String PARAM_TEMPLATE

This optional String parameter specifies the template in a simple String format.
If this parameter is set the Rendering Engine will use it in preference to templates specified by either the PARAM_TEMPLATE_NODE or the PARAM_TEMPLATE_PATH parameters.

See Also:

Constant Field Values

PARAM_TEMPLATE_NODE

public static final String PARAM_TEMPLATE_NODE

This optional NodeRef parameter specifies a node containing the template to be processed.
If a value is specified for PARAM_TEMPLATE then this parameter will be ignored.
If a value is specified for this parameter it will be used in preference to values specified for the PARAM_TEMPLATE_PATH parameter.

See Also:

Constant Field Values

PARAM_TEMPLATE_PATH

public static final String PARAM_TEMPLATE_PATH

This optional String parameter specifies a file path location for the template to be processed.
If a value is specified for PARAM_TEMPLATE or PARAM_TEMPLATE_NODE then this parameter will be ignored.

See Also:

Constant Field Values

Constructor Detail

BaseTemplateRenderingEngine

public BaseTemplateRenderingEngine()

Method Detail

render

protected void render(AbstractRenderingEngine.RenderingContext context)

Specified by:

render in class AbstractRenderingEngine

getTemplateNode

protected org.alfresco.service.cmr.repository.NodeRef getTemplateNode(AbstractRenderingEngine.RenderingContext context)

buildModel

protected abstract Object buildModel(AbstractRenderingEngine.RenderingContext context)

Create the model that will be passed to the template service for rendering with the appropriate template.

Parameters:

context - The context of the rendering request

Returns:

The model that is to be passed to the template service

getTemplateType

protected abstract String getTemplateType()

Get the type of template that is to be used. This identifies the name of the template processor that should be used, such as "freemarker" or "xslt".

Returns:

String

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 AbstractRenderingEngine

Parameters:

paramName - the name of the parameter

Returns:

the display label of the parameter

getParameterDefinitions

protected Collection<ParameterDefinition> getParameterDefinitions()

Description copied from class: AbstractRenderingEngine

Supplies the list of parameters required by this rendering engine.

Overrides:

getParameterDefinitions in class AbstractRenderingEngine

setTemplateService

public void setTemplateService(TemplateService templateService)

Parameters:

templateService - the templateService to set

setSearchService

public void setSearchService(org.alfresco.service.cmr.search.SearchService searchService)

Parameters:

searchService - the searchService to set

getTemplateService

public TemplateService getTemplateService()

getSearchService

public org.alfresco.service.cmr.search.SearchService getSearchService()