org.alfresco.repo.rendition.executer

Class FreemarkerRenderingEngine

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

org.alfresco.repo.rendition.executer.FreemarkerRenderingEngine

All Implemented Interfaces:

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

public class FreemarkerRenderingEngine
extends BaseTemplateRenderingEngine

Since:

3.3

Author:

Nick Smith

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	KEY_NODE The name of the source node as it appears in the model supplied to the freemarker template
static String	NAME

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

PARAM_MODEL, PARAM_TEMPLATE, PARAM_TEMPLATE_NODE, PARAM_TEMPLATE_PATH

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

Method Summary

Modifier and Type	Method and Description
protected Object	buildModel(AbstractRenderingEngine.RenderingContext context) Create the model that will be passed to the template service for rendering with the appropriate template.
protected Collection<ParameterDefinition>	getParameterDefinitions() Supplies the list of parameters required by this rendering engine.
protected String	getTemplateType() Get the type of template that is to be used.
void	setRepositoryHelper(Repository repository)
void	setServiceRegistry(ServiceRegistry serviceRegistry)

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

getParamDisplayLabel, getSearchService, getTemplateNode, getTemplateService, render, setSearchService, setTemplateService

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

NAME

public static final String NAME

See Also:

Constant Field Values

KEY_NODE

public static final String KEY_NODE

The name of the source node as it appears in the model supplied to the freemarker template

See Also:

Constant Field Values

Constructor Detail

FreemarkerRenderingEngine

public FreemarkerRenderingEngine()

Method Detail

getParameterDefinitions

protected Collection<ParameterDefinition> getParameterDefinitions()

Description copied from class: AbstractRenderingEngine

Supplies the list of parameters required by this rendering engine.

Overrides:

getParameterDefinitions in class BaseTemplateRenderingEngine

buildModel

protected Object buildModel(AbstractRenderingEngine.RenderingContext context)

Description copied from class: BaseTemplateRenderingEngine

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

Specified by:

buildModel in class BaseTemplateRenderingEngine

Parameters:

context - The context of the rendering request

Returns:

The model that is to be passed to the template service

getTemplateType

protected String getTemplateType()

Description copied from class: BaseTemplateRenderingEngine

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".

Specified by:

getTemplateType in class BaseTemplateRenderingEngine

Returns:

String

setRepositoryHelper

public void setRepositoryHelper(Repository repository)

Parameters:

repository - the repository to set

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

Parameters:

serviceRegistry - the serviceRegistry to set