Package com.flowable.template.engine

Class TemplateEngineConfiguration

java.lang.Object

org.flowable.common.engine.impl.AbstractEngineConfiguration

com.flowable.template.engine.TemplateEngineConfiguration

All Implemented Interfaces:

TemplateEngineConfigurationApi, SpringEngineConfiguration, Aware, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle

public class TemplateEngineConfiguration
extends AbstractEngineConfiguration
implements SpringEngineConfiguration, TemplateEngineConfigurationApi

Author:

Tijs Rademakers

Field Summary

Fields

Modifier and Type	Field	Description
protected ApplicationContext	applicationContext
protected AsposeTemplateProcessorSettings	asposeTemplateProcessorSettings
protected boolean	checkVersionTimestamp
protected final TemplateDataManagers	dataManagers
static final String	DEFAULT_ENGINE_NAME
static final String	DEFAULT_MYBATIS_MAPPING_FILE
protected TemplateDeploymentManager	deploymentManager
protected String	deploymentMode
protected String	deploymentName
protected Resource[]	deploymentResources
protected Collection<AutoDeploymentStrategy<TemplateEngine>>	deploymentStrategies
protected List<String>	enginesBuild
protected final TemplateEntityManagers	entityManagers
static final String	KEY_TEMPLATE_ENGINE_CONFIG
protected final Object	lifeCycleMonitor
static final String	LIQUIBASE_CHANGELOG_PREFIX
protected ResourceHelper	resourceHelper
protected String	rootFolderName
protected boolean	running
protected DeploymentCache<TemplateDefinitionCacheEntry>	templateDefinitionCache
protected int	templateDefinitionCacheLimit
protected TemplateDefinitionDeployer	templateDefinitionDeployer
protected String	templateEngineName
protected boolean	templateProcessingStrictMode
protected List<TemplateProcessor>	templateProcessors
protected TemplateRepositoryService	templateRepositoryService
protected TemplateResourceConverter	templateResourceConverter
protected TemplateResourceResolver	templateResourceResolver
protected TemplateService	templateService
protected String	templatesFolderName
protected DeploymentCache<TemplateVariationDefinitionCacheEntry>	templateVariationDefinitionCache
protected int	templateVariationDefinitionCacheLimit
protected TemplateVariationDefinitionDeployer	templateVariationDefinitionDeployer
protected TemplateVariationResourceConverter	templateVariationResourceConverter
protected PlatformTransactionManager	transactionManager
protected Integer	transactionSynchronizationAdapterOrder

Fields inherited from class org.flowable.common.engine.impl.AbstractEngineConfiguration

additionalEventDispatchActions, agendaOperationExecutionListeners, agendaOperationRunner, allConfigurators, alwaysLookupLatestDefinitionVersion, beans, byteArrayDataManager, byteArrayEntityManager, classLoader, clock, commandContextFactory, commandExecutor, commandInterceptors, commandInvoker, commonSchemaManager, configurators, customMybatisInterceptors, customMybatisMappers, customMybatisXMLMappers, customPostCommandInterceptors, customPostDeployers, customPreCommandInterceptors, customPreDeployers, customSessionFactories, DATABASE_TYPE_COCKROACHDB, DATABASE_TYPE_DB2, DATABASE_TYPE_H2, DATABASE_TYPE_HSQL, DATABASE_TYPE_MSSQL, DATABASE_TYPE_MYSQL, DATABASE_TYPE_ORACLE, DATABASE_TYPE_POSTGRES, databaseCatalog, databaseSchema, databaseSchemaUpdate, databaseTablePrefix, databaseType, databaseTypeMappings, databaseWildcardEscapeCharacter, dataSource, dataSourceJndiName, DB_SCHEMA_UPDATE_CREATE, DB_SCHEMA_UPDATE_CREATE_DROP, DB_SCHEMA_UPDATE_DROP_CREATE, DB_SCHEMA_UPDATE_FALSE, DB_SCHEMA_UPDATE_TRUE, dbSqlSessionFactory, DEFAULT_GENERIC_MAX_LENGTH_STRING, DEFAULT_MAX_NR_OF_STATEMENTS_BULK_INSERT_SQL_SERVER, DEFAULT_ORACLE_MAX_LENGTH_STRING, defaultCommandConfig, defaultCommandInterceptors, defaultTenantProvider, dependentEngineMybatisTypeAliasConfigs, dependentEngineMybatisTypeHandlerConfigs, dependentEngineMyBatisXmlMappers, deployers, enableConfiguratorServiceLoader, enableEventDispatcher, enableLogSqlExecutionTime, engineConfigurations, engineLifecycleListeners, eventDispatcher, eventListeners, eventRegistryConfigurator, eventRegistryEventConsumers, fallbackToDefaultTenant, forceCloseMybatisConnectionPool, idGenerator, idmEngineConfigurator, isBulkInsertEnabled, isDbHistoryUsed, jdbcDefaultTransactionIsolationLevel, jdbcDriver, jdbcMaxActiveConnections, jdbcMaxCheckoutTime, jdbcMaxIdleConnections, jdbcMaxWaitTime, jdbcPassword, jdbcPingConnectionNotUsedFor, jdbcPingEnabled, jdbcPingQuery, jdbcUrl, jdbcUsername, lockPollRate, logger, loggingListener, maxLengthStringVariableType, maxNrOfStatementsInBulkInsert, mybatisMappingFile, NO_TENANT_ID, objectMapper, PRODUCT_NAME_CRDB, PRODUCT_NAME_POSTGRES, propertyDataManager, propertyEntityManager, schemaCommandConfig, schemaLockWaitTime, schemaManagementCmd, schemaManager, serviceConfigurations, sessionFactories, sqlSessionFactory, tableDataManager, tablePrefixIsSchema, transactionContextFactory, transactionFactory, transactionsExternallyManaged, typedEventListeners, useClassForNameClassLoading, useLockForDatabaseSchemaUpdate, usePrefixId, usingRelationalDatabase, usingSchemaMgmt, xmlEncoding

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Fields inherited from interface org.flowable.common.spring.SpringEngineConfiguration

PHASE, PHASE_DELTA

Constructor Summary

Constructors

Constructor	Description
TemplateEngineConfiguration()

Method Summary

Modifier and Type	Method	Description
protected void	autoDeployResources(TemplateEngine templateEngine)
TemplateEngine	buildTemplateEngine()
CommandInterceptor	createTransactionInterceptor()
ApplicationContext	getApplicationContext()
AsposeTemplateProcessorSettings	getAsposeTemplateProcessorSettings()
AutoDeploymentStrategy<TemplateEngine>	getAutoDeploymentStrategy(String mode)	Gets the AutoDeploymentStrategy for the provided mode.
TemplateDataManagers	getDataManagers()
Collection<? extends EngineDeployer>	getDefaultDeployers()
TemplateDeploymentManager	getDeploymentManager()
String	getDeploymentMode()
String	getDeploymentName()
Resource[]	getDeploymentResources()
Collection<AutoDeploymentStrategy<TemplateEngine>>	getDeploymentStrategies()
String	getEngineCfgKey()
String	getEngineName()
String	getEngineScopeType()
TemplateEntityManagers	getEntityManagers()
InputStream	getMyBatisXmlConfigurationStream()
int	getPhase()
ResourceHelper	getResourceHelper()
String	getRootFolderName()
DeploymentCache<TemplateDefinitionCacheEntry>	getTemplateDefinitionCache()
int	getTemplateDefinitionCacheLimit()
TemplateDefinitionDeployer	getTemplateDefinitionDeployer()
String	getTemplateEngineName()
List<TemplateProcessor>	getTemplateProcessors()	Returns the currently registered template processors.
TemplateRepositoryService	getTemplateRepositoryService()	Returns the template repository service to query for template definitions or to create template definition deployments.
TemplateResourceConverter	getTemplateResourceConverter()
TemplateResourceResolver	getTemplateResourceResolver()
TemplateService	getTemplateService()	Returns the template service used to render templates based on a template definition.
String	getTemplatesFolderName()
DeploymentCache<TemplateVariationDefinitionCacheEntry>	getTemplateVariationDefinitionCache()
int	getTemplateVariationDefinitionCacheLimit()
TemplateVariationDefinitionDeployer	getTemplateVariationDefinitionDeployer()
TemplateVariationResourceConverter	getTemplateVariationResourceConverter()
PlatformTransactionManager	getTransactionManager()
protected void	init()
void	initDataManagers()
protected void	initDbSqlSessionFactoryEntitySettings()
void	initDefaultCommandConfig()
protected void	initDefaultProcessors()
protected void	initDeployers()
protected void	initDeploymentManager()
void	initEntityManagers()
protected void	initProcessors()
void	initSchemaManagementCommand()
void	initSchemaManager()
protected void	initServices()
protected void	initTemplateDefinitionCaches()
protected void	initTemplateResourceConverters()
protected void	initTemplateResourceResolver()
void	initTransactionContextFactory()
boolean	isCheckVersionTimestamp()
boolean	isRunning()
boolean	isTemplateProcessingStrictMode()
void	registerTemplateProcessor(TemplateProcessor templateProcessor)	Registers the given template processor for processing template content.
void	removeTemplateProcessor(TemplateProcessor templateProcessor)	Removes a previously registered template processor.
void	setApplicationContext(ApplicationContext applicationContext)
void	setAsposeTemplateProcessorSettings(AsposeTemplateProcessorSettings asposeTemplateProcessorSettings)
void	setCheckVersionTimestamp(boolean checkVersionTimestamp)
TemplateEngineConfiguration	setDataSource(DataSource dataSource)
void	setDeploymentManager(TemplateDeploymentManager deploymentManager)
void	setDeploymentMode(String deploymentMode)
void	setDeploymentName(String deploymentName)
void	setDeploymentResources(Resource[] deploymentResources)
void	setDeploymentStrategies(Collection<AutoDeploymentStrategy<TemplateEngine>> deploymentStrategies)
void	setResourceHelper(ResourceHelper resourceHelper)
void	setRootFolderName(String rootFolderName)
void	setTemplateDefinitionCache(DeploymentCache<TemplateDefinitionCacheEntry> templateDefinitionCache)
void	setTemplateDefinitionCacheLimit(int templateDefinitionCacheLimit)
void	setTemplateDefinitionDeployer(TemplateDefinitionDeployer templateDefinitionDeployer)
void	setTemplateEngineName(String templateEngineName)
void	setTemplateProcessingStrictMode(boolean templateProcessingStrictMode)
void	setTemplateProcessors(List<TemplateProcessor> processors)	If you need / want to overwrite the full list of processors, use this method to provide a list of processors (they are consumed in exactly the given order in the list).
void	setTemplateRepositoryService(TemplateRepositoryService templateRepositoryService)
void	setTemplateResourceConverter(TemplateResourceConverter templateResourceConverter)
void	setTemplateResourceResolver(TemplateResourceResolver templateResourceResolver)
void	setTemplateService(TemplateService templateService)
void	setTemplatesFolderName(String templatesFolderName)
void	setTemplateVariationDefinitionCache(DeploymentCache<TemplateVariationDefinitionCacheEntry> templateVariationDefinitionCache)
void	setTemplateVariationDefinitionCacheLimit(int templateVariationDefinitionCacheLimit)
void	setTemplateVariationDefinitionDeployer(TemplateVariationDefinitionDeployer templateVariationDefinitionDeployer)
void	setTemplateVariationResourceConverter(TemplateVariationResourceConverter templateVariationResourceConverter)
void	setTransactionManager(PlatformTransactionManager transactionManager)
void	setTransactionSynchronizationAdapterOrder(Integer transactionSynchronizationAdapterOrder)
void	start()
void	stop()

Methods inherited from class org.flowable.common.engine.impl.AbstractEngineConfiguration

addAgendaOperationExecutionListener, addConfigurator, addCustomPostCommandInterceptor, addCustomPreCommandInterceptor, addCustomSessionFactory, addEngineConfiguration, addEngineLifecycleListener, addEventRegistryEventConsumer, addServiceConfiguration, addSessionFactory, applyCustomMybatisCustomizations, close, configuratorsAfterInit, configuratorsBeforeInit, createDbSqlSessionFactory, defaultInitDbSqlSessionFactoryEntitySettings, getAdditionalDefaultCommandInterceptors, getAdditionalEventDispatchActions, getAgendaOperationExecutionListeners, getAgendaOperationRunner, getAllConfigurators, getBeans, getByteArrayDataManager, getByteArrayEntityManager, getClassLoader, getClock, getCommandContextFactory, getCommandExecutor, getCommandInterceptors, getCommandInvoker, getCommonSchemaManager, getConfigurators, getCustomMybatisInterceptors, getCustomMybatisMappers, getCustomMybatisXMLMappers, getCustomPostCommandInterceptors, getCustomPostDeployers, getCustomPreCommandInterceptors, getCustomPreDeployers, getCustomSessionFactories, getDatabaseCatalog, getDatabaseSchema, getDatabaseSchemaUpdate, getDatabaseTablePrefix, getDatabaseType, getDatabaseWildcardEscapeCharacter, getDataSource, getDataSourceJndiName, getDbSqlSessionFactory, getDefaultCommandConfig, getDefaultCommandInterceptors, getDefaultDatabaseTypeMappings, getDefaultTenantProvider, getDependentEngineMybatisTypeAliasConfigs, getDependentEngineMybatisTypeHandlerConfigs, getDependentEngineMyBatisXmlMappers, getDeployers, getEngineConfigurations, getEngineLifecycleListeners, getEngineSpecificEngineConfigurators, getEventDispatcher, getEventListeners, getEventRegistryConfigurator, getEventRegistryEventConsumers, getIdGenerator, getIdmEngineConfigurator, getJdbcDefaultTransactionIsolationLevel, getJdbcDriver, getJdbcMaxActiveConnections, getJdbcMaxCheckoutTime, getJdbcMaxIdleConnections, getJdbcMaxWaitTime, getJdbcPassword, getJdbcPingConnectionNotUsedFor, getJdbcPingQuery, getJdbcUrl, getJdbcUsername, getLockManager, getLockPollRate, getLoggingListener, getMaxLengthString, getMaxLengthStringVariableType, getMaxNrOfStatementsInBulkInsert, getMybatisMappingFile, getObjectMapper, getPropertyDataManager, getPropertyEntityManager, getResourceAsStream, getSchemaCommandConfig, getSchemaLockWaitTime, getSchemaManagementCmd, getSchemaManager, getServiceConfigurations, getSessionFactories, getSqlSessionFactory, getTableDataManager, getTransactionContextFactory, getTransactionFactory, getTypedEventListeners, getXmlEncoding, initAdditionalEventDispatchActions, initBeans, initClock, initCommandContextFactory, initCommandExecutor, initCommandExecutors, initCommandInterceptors, initCommandInvoker, initConfigurators, initCustomMybatisInterceptors, initCustomMybatisMappers, initDatabaseType, initDataSource, initDbSqlSessionFactory, initEngineConfigurations, initEventDispatcher, initEventListeners, initIdGenerator, initInterceptorChain, initMybatisConfiguration, initMyBatisLogSqlExecutionTimePlugin, initMybatisTypeHandlers, initObjectMapper, initSchemaCommandConfig, initService, initSessionFactories, initSqlSessionFactory, initTransactionFactory, initTypedEventListeners, isAlwaysLookupLatestDefinitionVersion, isBulkInsertEnabled, isDbHistoryUsed, isEnableConfiguratorServiceLoader, isEnableEventDispatcher, isEnableLogSqlExecutionTime, isFallbackToDefaultTenant, isForceCloseMybatisConnectionPool, isJdbcPingEnabled, isLoggingSessionEnabled, isTablePrefixIsSchema, isTransactionsExternallyManaged, isUseClassForNameClassLoading, isUseLockForDatabaseSchemaUpdate, isUsePrefixId, isUsingRelationalDatabase, isUsingSchemaMgmt, parseCustomMybatisXMLMappers, parseDependentEngineMybatisXMLMappers, parseMybatisConfiguration, parseMybatisXmlMapping, pathToEngineDbProperties, setAdditionalEventDispatchActions, setAgendaOperationExecutionListeners, setAgendaOperationRunner, setAlwaysLookupLatestDefinitionVersion, setBeans, setBulkInsertEnabled, setByteArrayDataManager, setByteArrayEntityManager, setClassLoader, setClock, setCommandContextFactory, setCommandExecutor, setCommandInterceptors, setCommandInvoker, setCommonSchemaManager, setConfigurators, setCustomMybatisInterceptors, setCustomMybatisMappers, setCustomMybatisXMLMappers, setCustomPostCommandInterceptors, setCustomPostDeployers, setCustomPreCommandInterceptors, setCustomPreDeployers, setCustomSessionFactories, setDatabaseCatalog, setDatabaseSchema, setDatabaseSchemaUpdate, setDatabaseTablePrefix, setDatabaseType, setDatabaseWildcardEscapeCharacter, setDataSourceJndiName, setDbHistoryUsed, setDbSqlSessionFactory, setDefaultCommandConfig, setDefaultCommandInterceptors, setDefaultTenantProvider, setDefaultTenantValue, setDependentEngineMybatisTypeAliasConfigs, setDependentEngineMybatisTypeHandlerConfigs, setDependentEngineMyBatisXmlMappers, setDeployers, setEnableConfiguratorServiceLoader, setEnableEventDispatcher, setEnableLogSqlExecutionTime, setEngineConfigurations, setEngineLifecycleListeners, setEventDispatcher, setEventListeners, setEventRegistryConfigurator, setEventRegistryEventConsumers, setFallbackToDefaultTenant, setForceCloseMybatisConnectionPool, setIdGenerator, setIdmEngineConfigurator, setJdbcDefaultTransactionIsolationLevel, setJdbcDriver, setJdbcMaxActiveConnections, setJdbcMaxCheckoutTime, setJdbcMaxIdleConnections, setJdbcMaxWaitTime, setJdbcPassword, setJdbcPingConnectionNotUsedFor, setJdbcPingEnabled, setJdbcPingQuery, setJdbcUrl, setJdbcUsername, setLockPollRate, setLoggingListener, setMaxLengthStringVariableType, setMaxNrOfStatementsInBulkInsert, setMybatisMappingFile, setObjectMapper, setPropertyDataManager, setPropertyEntityManager, setSchemaCommandConfig, setSchemaLockWaitTime, setSchemaManagementCmd, setSchemaManager, setServiceConfigurations, setSessionFactories, setSqlSessionFactory, setTableDataManager, setTablePrefixIsSchema, setTransactionContextFactory, setTransactionFactory, setTransactionsExternallyManaged, setTypedEventListeners, setUseClassForNameClassLoading, setUseLockForDatabaseSchemaUpdate, setUsePrefixId, setUsingRelationalDatabase, setUsingSchemaMgmt, setXmlEncoding

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.flowable.common.spring.SpringEngineConfiguration

getBeans, isAutoStartup, stop

Field Details

DEFAULT_MYBATIS_MAPPING_FILE

public static final String DEFAULT_MYBATIS_MAPPING_FILE

See Also:

• Constant Field Values

DEFAULT_ENGINE_NAME

public static final String DEFAULT_ENGINE_NAME

See Also:

• Constant Field Values

KEY_TEMPLATE_ENGINE_CONFIG

public static final String KEY_TEMPLATE_ENGINE_CONFIG

See Also:

• Constant Field Values

LIQUIBASE_CHANGELOG_PREFIX

public static final String LIQUIBASE_CHANGELOG_PREFIX

See Also:

• Constant Field Values

templateEngineName

protected String templateEngineName

templateRepositoryService

protected TemplateRepositoryService templateRepositoryService

templateService

protected TemplateService templateService

templateProcessors

protected List<TemplateProcessor> templateProcessors

templateProcessingStrictMode

protected boolean templateProcessingStrictMode

dataManagers

protected final TemplateDataManagers dataManagers

entityManagers

protected final TemplateEntityManagers entityManagers

transactionManager

protected PlatformTransactionManager transactionManager

transactionSynchronizationAdapterOrder

protected Integer transactionSynchronizationAdapterOrder

applicationContext

protected ApplicationContext applicationContext

resourceHelper

protected ResourceHelper resourceHelper

templateResourceResolver

protected TemplateResourceResolver templateResourceResolver

rootFolderName

protected String rootFolderName

templatesFolderName

protected String templatesFolderName

running

protected volatile boolean running

templateDefinitionDeployer

protected TemplateDefinitionDeployer templateDefinitionDeployer

templateVariationDefinitionDeployer

protected TemplateVariationDefinitionDeployer templateVariationDefinitionDeployer

deploymentManager

protected TemplateDeploymentManager deploymentManager

templateResourceConverter

protected TemplateResourceConverter templateResourceConverter

templateVariationResourceConverter

protected TemplateVariationResourceConverter templateVariationResourceConverter

templateDefinitionCacheLimit

protected int templateDefinitionCacheLimit

templateVariationDefinitionCacheLimit

protected int templateVariationDefinitionCacheLimit

templateDefinitionCache

protected DeploymentCache<TemplateDefinitionCacheEntry> templateDefinitionCache

templateVariationDefinitionCache

protected DeploymentCache<TemplateVariationDefinitionCacheEntry> templateVariationDefinitionCache

deploymentName

protected String deploymentName

deploymentResources

protected Resource[] deploymentResources

deploymentMode

protected String deploymentMode

deploymentStrategies

protected Collection<AutoDeploymentStrategy<TemplateEngine>> deploymentStrategies

checkVersionTimestamp

protected boolean checkVersionTimestamp

enginesBuild

protected List<String> enginesBuild

lifeCycleMonitor

protected final Object lifeCycleMonitor

asposeTemplateProcessorSettings

protected AsposeTemplateProcessorSettings asposeTemplateProcessorSettings

Constructor Details

TemplateEngineConfiguration

public TemplateEngineConfiguration()

Method Details

getEngineCfgKey

public String getEngineCfgKey()

Specified by:

getEngineCfgKey in class AbstractEngineConfiguration

getEngineScopeType

public String getEngineScopeType()

Specified by:

getEngineScopeType in class AbstractEngineConfiguration

createTransactionInterceptor

public CommandInterceptor createTransactionInterceptor()

Specified by:

createTransactionInterceptor in class AbstractEngineConfiguration

initDbSqlSessionFactoryEntitySettings

protected void initDbSqlSessionFactoryEntitySettings()

Specified by:

initDbSqlSessionFactoryEntitySettings in class AbstractEngineConfiguration

getMyBatisXmlConfigurationStream

public InputStream getMyBatisXmlConfigurationStream()

Specified by:

getMyBatisXmlConfigurationStream in class AbstractEngineConfiguration

getEngineName

public String getEngineName()

Specified by:

getEngineName in class AbstractEngineConfiguration

setTransactionSynchronizationAdapterOrder

public void setTransactionSynchronizationAdapterOrder(Integer transactionSynchronizationAdapterOrder)

getDataManagers

public TemplateDataManagers getDataManagers()

getEntityManagers

public TemplateEntityManagers getEntityManagers()

setDataSource

public TemplateEngineConfiguration setDataSource(DataSource dataSource)

Overrides:

setDataSource in class AbstractEngineConfiguration

buildTemplateEngine

public TemplateEngine buildTemplateEngine()

init

protected void init()

initServices

protected void initServices()

initTemplateResourceResolver

protected void initTemplateResourceResolver()

initProcessors

protected void initProcessors()

initDefaultProcessors

protected void initDefaultProcessors()

initTransactionContextFactory

public void initTransactionContextFactory()

Overrides:

initTransactionContextFactory in class AbstractEngineConfiguration

initDefaultCommandConfig

public void initDefaultCommandConfig()

Overrides:

initDefaultCommandConfig in class AbstractEngineConfiguration

initDataManagers

public void initDataManagers()

Overrides:

initDataManagers in class AbstractEngineConfiguration

initEntityManagers

public void initEntityManagers()

Overrides:

initEntityManagers in class AbstractEngineConfiguration

initSchemaManager

public void initSchemaManager()

Overrides:

initSchemaManager in class AbstractEngineConfiguration

initSchemaManagementCommand

public void initSchemaManagementCommand()

initDeployers

protected void initDeployers()

getDefaultDeployers

public Collection<? extends EngineDeployer> getDefaultDeployers()

initTemplateDefinitionCaches

protected void initTemplateDefinitionCaches()

initTemplateResourceConverters

protected void initTemplateResourceConverters()

initDeploymentManager

protected void initDeploymentManager()

getTransactionManager

public PlatformTransactionManager getTransactionManager()

Specified by:

getTransactionManager in interface SpringEngineConfiguration

setTransactionManager

public void setTransactionManager(PlatformTransactionManager transactionManager)

Specified by:

setTransactionManager in interface SpringEngineConfiguration

getDeploymentName

public String getDeploymentName()

Specified by:

getDeploymentName in interface SpringEngineConfiguration

setDeploymentName

public void setDeploymentName(String deploymentName)

Specified by:

setDeploymentName in interface SpringEngineConfiguration

getDeploymentResources

public Resource[] getDeploymentResources()

Specified by:

getDeploymentResources in interface SpringEngineConfiguration

setDeploymentResources

public void setDeploymentResources(Resource[] deploymentResources)

Specified by:

setDeploymentResources in interface SpringEngineConfiguration

getApplicationContext

public ApplicationContext getApplicationContext()

Specified by:

getApplicationContext in interface SpringEngineConfiguration

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface ApplicationContextAware

Specified by:

setApplicationContext in interface SpringEngineConfiguration

getResourceHelper

public ResourceHelper getResourceHelper()

setResourceHelper

public void setResourceHelper(ResourceHelper resourceHelper)

getTemplateResourceResolver

public TemplateResourceResolver getTemplateResourceResolver()

setTemplateResourceResolver

public void setTemplateResourceResolver(TemplateResourceResolver templateResourceResolver)

getRootFolderName

public String getRootFolderName()

setRootFolderName

public void setRootFolderName(String rootFolderName)

getTemplatesFolderName

public String getTemplatesFolderName()

setTemplatesFolderName

public void setTemplatesFolderName(String templatesFolderName)

getDeploymentMode

public String getDeploymentMode()

Specified by:

getDeploymentMode in interface SpringEngineConfiguration

setDeploymentMode

public void setDeploymentMode(String deploymentMode)

Specified by:

setDeploymentMode in interface SpringEngineConfiguration

getTemplateEngineName

public String getTemplateEngineName()

setTemplateEngineName

public void setTemplateEngineName(String templateEngineName)

getTemplateDefinitionDeployer

public TemplateDefinitionDeployer getTemplateDefinitionDeployer()

setTemplateDefinitionDeployer

public void setTemplateDefinitionDeployer(TemplateDefinitionDeployer templateDefinitionDeployer)

getTemplateVariationDefinitionDeployer

public TemplateVariationDefinitionDeployer getTemplateVariationDefinitionDeployer()

setTemplateVariationDefinitionDeployer

public void setTemplateVariationDefinitionDeployer(TemplateVariationDefinitionDeployer templateVariationDefinitionDeployer)

getDeploymentManager

public TemplateDeploymentManager getDeploymentManager()

setDeploymentManager

public void setDeploymentManager(TemplateDeploymentManager deploymentManager)

getTemplateResourceConverter

public TemplateResourceConverter getTemplateResourceConverter()

setTemplateResourceConverter

public void setTemplateResourceConverter(TemplateResourceConverter templateResourceConverter)

getTemplateVariationResourceConverter

public TemplateVariationResourceConverter getTemplateVariationResourceConverter()

setTemplateVariationResourceConverter

public void setTemplateVariationResourceConverter(TemplateVariationResourceConverter templateVariationResourceConverter)

getTemplateDefinitionCacheLimit

public int getTemplateDefinitionCacheLimit()

setTemplateDefinitionCacheLimit

public void setTemplateDefinitionCacheLimit(int templateDefinitionCacheLimit)

getTemplateVariationDefinitionCacheLimit

public int getTemplateVariationDefinitionCacheLimit()

setTemplateVariationDefinitionCacheLimit

public void setTemplateVariationDefinitionCacheLimit(int templateVariationDefinitionCacheLimit)

getTemplateDefinitionCache

public DeploymentCache<TemplateDefinitionCacheEntry> getTemplateDefinitionCache()

setTemplateDefinitionCache

public void setTemplateDefinitionCache(DeploymentCache<TemplateDefinitionCacheEntry> templateDefinitionCache)

getTemplateVariationDefinitionCache

public DeploymentCache<TemplateVariationDefinitionCacheEntry> getTemplateVariationDefinitionCache()

setTemplateVariationDefinitionCache

public void setTemplateVariationDefinitionCache(DeploymentCache<TemplateVariationDefinitionCacheEntry> templateVariationDefinitionCache)

isCheckVersionTimestamp

public boolean isCheckVersionTimestamp()

setCheckVersionTimestamp

public void setCheckVersionTimestamp(boolean checkVersionTimestamp)

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

Specified by:

getPhase in interface SpringEngineConfiguration

getTemplateRepositoryService

public TemplateRepositoryService getTemplateRepositoryService()

Description copied from interface: TemplateEngineConfigurationApi

Returns the template repository service to query for template definitions or to create template definition deployments.

Specified by:

getTemplateRepositoryService in interface TemplateEngineConfigurationApi

setTemplateRepositoryService

public void setTemplateRepositoryService(TemplateRepositoryService templateRepositoryService)

getTemplateService

public TemplateService getTemplateService()

Description copied from interface: TemplateEngineConfigurationApi

Returns the template service used to render templates based on a template definition.

Specified by:

getTemplateService in interface TemplateEngineConfigurationApi

registerTemplateProcessor

public void registerTemplateProcessor(TemplateProcessor templateProcessor)

Description copied from interface: TemplateEngineConfigurationApi

Registers the given template processor for processing template content. They will be asked for supporting templates in exactly the same order as they have been registered.

Specified by:

registerTemplateProcessor in interface TemplateEngineConfigurationApi

Parameters:

templateProcessor - the template processor to register

removeTemplateProcessor

public void removeTemplateProcessor(TemplateProcessor templateProcessor)

Description copied from interface: TemplateEngineConfigurationApi

Removes a previously registered template processor.

Specified by:

removeTemplateProcessor in interface TemplateEngineConfigurationApi

Parameters:

templateProcessor - the processor to be removed

setTemplateProcessors

public void setTemplateProcessors(List<TemplateProcessor> processors)

Description copied from interface: TemplateEngineConfigurationApi

If you need / want to overwrite the full list of processors, use this method to provide a list of processors (they are consumed in exactly the given order in the list).

Specified by:

setTemplateProcessors in interface TemplateEngineConfigurationApi

Parameters:

processors - the processors to register

getTemplateProcessors

public List<TemplateProcessor> getTemplateProcessors()

Description copied from interface: TemplateEngineConfigurationApi

Returns the currently registered template processors.

Specified by:

getTemplateProcessors in interface TemplateEngineConfigurationApi

isTemplateProcessingStrictMode

public boolean isTemplateProcessingStrictMode()

setTemplateProcessingStrictMode

public void setTemplateProcessingStrictMode(boolean templateProcessingStrictMode)

setTemplateService

public void setTemplateService(TemplateService templateService)

getAsposeTemplateProcessorSettings

public AsposeTemplateProcessorSettings getAsposeTemplateProcessorSettings()

setAsposeTemplateProcessorSettings

public void setAsposeTemplateProcessorSettings(AsposeTemplateProcessorSettings asposeTemplateProcessorSettings)

autoDeployResources

protected void autoDeployResources(TemplateEngine templateEngine)

getAutoDeploymentStrategy

public AutoDeploymentStrategy<TemplateEngine> getAutoDeploymentStrategy(String mode)

Gets the AutoDeploymentStrategy for the provided mode. This method may be overridden to implement custom deployment strategies if required, but implementors should take care not to return null.

Parameters:

mode - the mode to get the strategy for

Returns:

the deployment strategy to use for the mode. Never null

getDeploymentStrategies

public Collection<AutoDeploymentStrategy<TemplateEngine>> getDeploymentStrategies()

setDeploymentStrategies

public void setDeploymentStrategies(Collection<AutoDeploymentStrategy<TemplateEngine>> deploymentStrategies)