Class TemplateEngineConfiguration

  • All Implemented Interfaces:
    TemplateEngineConfigurationApi, org.flowable.common.spring.SpringEngineConfiguration, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

    public class TemplateEngineConfiguration
    extends org.flowable.common.engine.impl.AbstractEngineConfiguration
    implements org.flowable.common.spring.SpringEngineConfiguration, TemplateEngineConfigurationApi
    Author:
    Tijs Rademakers
    • Field Detail

      • DEFAULT_MYBATIS_MAPPING_FILE

        public static final java.lang.String DEFAULT_MYBATIS_MAPPING_FILE
        See Also:
        Constant Field Values
      • DEFAULT_ENGINE_NAME

        public static final java.lang.String DEFAULT_ENGINE_NAME
        See Also:
        Constant Field Values
      • KEY_TEMPLATE_ENGINE_CONFIG

        public static final java.lang.String KEY_TEMPLATE_ENGINE_CONFIG
        See Also:
        Constant Field Values
      • LIQUIBASE_CHANGELOG_PREFIX

        public static final java.lang.String LIQUIBASE_CHANGELOG_PREFIX
        See Also:
        Constant Field Values
      • templateEngineName

        protected java.lang.String templateEngineName
      • templateProcessingStrictMode

        protected boolean templateProcessingStrictMode
      • transactionManager

        protected org.springframework.transaction.PlatformTransactionManager transactionManager
      • transactionSynchronizationAdapterOrder

        protected java.lang.Integer transactionSynchronizationAdapterOrder
      • applicationContext

        protected org.springframework.context.ApplicationContext applicationContext
      • rootFolderName

        protected java.lang.String rootFolderName
      • templatesFolderName

        protected java.lang.String templatesFolderName
      • running

        protected volatile boolean running
      • templateDefinitionCacheLimit

        protected int templateDefinitionCacheLimit
      • templateVariationDefinitionCacheLimit

        protected int templateVariationDefinitionCacheLimit
      • templateDefinitionCache

        protected org.flowable.common.engine.impl.persistence.deploy.DeploymentCache<TemplateDefinitionCacheEntry> templateDefinitionCache
      • deploymentName

        protected java.lang.String deploymentName
      • deploymentResources

        protected org.springframework.core.io.Resource[] deploymentResources
      • deploymentMode

        protected java.lang.String deploymentMode
      • enginesBuild

        protected java.util.List<java.lang.String> enginesBuild
      • lifeCycleMonitor

        protected final java.lang.Object lifeCycleMonitor
    • Constructor Detail

      • TemplateEngineConfiguration

        public TemplateEngineConfiguration()
    • Method Detail

      • getEngineCfgKey

        public java.lang.String getEngineCfgKey()
        Specified by:
        getEngineCfgKey in class org.flowable.common.engine.impl.AbstractEngineConfiguration
      • getEngineScopeType

        public java.lang.String getEngineScopeType()
        Specified by:
        getEngineScopeType in class org.flowable.common.engine.impl.AbstractEngineConfiguration
      • createTransactionInterceptor

        public org.flowable.common.engine.impl.interceptor.CommandInterceptor createTransactionInterceptor()
        Specified by:
        createTransactionInterceptor in class org.flowable.common.engine.impl.AbstractEngineConfiguration
      • initDbSqlSessionFactoryEntitySettings

        protected void initDbSqlSessionFactoryEntitySettings()
        Specified by:
        initDbSqlSessionFactoryEntitySettings in class org.flowable.common.engine.impl.AbstractEngineConfiguration
      • getMyBatisXmlConfigurationStream

        public java.io.InputStream getMyBatisXmlConfigurationStream()
        Specified by:
        getMyBatisXmlConfigurationStream in class org.flowable.common.engine.impl.AbstractEngineConfiguration
      • getEngineName

        public java.lang.String getEngineName()
        Specified by:
        getEngineName in class org.flowable.common.engine.impl.AbstractEngineConfiguration
      • setTransactionSynchronizationAdapterOrder

        public void setTransactionSynchronizationAdapterOrder​(java.lang.Integer transactionSynchronizationAdapterOrder)
      • setDataSource

        public TemplateEngineConfiguration setDataSource​(javax.sql.DataSource dataSource)
        Overrides:
        setDataSource in class org.flowable.common.engine.impl.AbstractEngineConfiguration
      • 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 org.flowable.common.engine.impl.AbstractEngineConfiguration
      • initDefaultCommandConfig

        public void initDefaultCommandConfig()
        Overrides:
        initDefaultCommandConfig in class org.flowable.common.engine.impl.AbstractEngineConfiguration
      • initDataManagers

        public void initDataManagers()
        Overrides:
        initDataManagers in class org.flowable.common.engine.impl.AbstractEngineConfiguration
      • initEntityManagers

        public void initEntityManagers()
        Overrides:
        initEntityManagers in class org.flowable.common.engine.impl.AbstractEngineConfiguration
      • initSchemaManager

        public void initSchemaManager()
        Overrides:
        initSchemaManager in class org.flowable.common.engine.impl.AbstractEngineConfiguration
      • initSchemaManagementCommand

        public void initSchemaManagementCommand()
      • initDeployers

        protected void initDeployers()
      • getDefaultDeployers

        public java.util.Collection<? extends org.flowable.common.engine.impl.EngineDeployer> getDefaultDeployers()
      • initTemplateDefinitionCaches

        protected void initTemplateDefinitionCaches()
      • initTemplateResourceConverters

        protected void initTemplateResourceConverters()
      • initDeploymentManager

        protected void initDeploymentManager()
      • getTransactionManager

        public org.springframework.transaction.PlatformTransactionManager getTransactionManager()
        Specified by:
        getTransactionManager in interface org.flowable.common.spring.SpringEngineConfiguration
      • setTransactionManager

        public void setTransactionManager​(org.springframework.transaction.PlatformTransactionManager transactionManager)
        Specified by:
        setTransactionManager in interface org.flowable.common.spring.SpringEngineConfiguration
      • getDeploymentName

        public java.lang.String getDeploymentName()
        Specified by:
        getDeploymentName in interface org.flowable.common.spring.SpringEngineConfiguration
      • setDeploymentName

        public void setDeploymentName​(java.lang.String deploymentName)
        Specified by:
        setDeploymentName in interface org.flowable.common.spring.SpringEngineConfiguration
      • getDeploymentResources

        public org.springframework.core.io.Resource[] getDeploymentResources()
        Specified by:
        getDeploymentResources in interface org.flowable.common.spring.SpringEngineConfiguration
      • setDeploymentResources

        public void setDeploymentResources​(org.springframework.core.io.Resource[] deploymentResources)
        Specified by:
        setDeploymentResources in interface org.flowable.common.spring.SpringEngineConfiguration
      • getApplicationContext

        public org.springframework.context.ApplicationContext getApplicationContext()
        Specified by:
        getApplicationContext in interface org.flowable.common.spring.SpringEngineConfiguration
      • setApplicationContext

        public void setApplicationContext​(org.springframework.context.ApplicationContext applicationContext)
        Specified by:
        setApplicationContext in interface org.springframework.context.ApplicationContextAware
        Specified by:
        setApplicationContext in interface org.flowable.common.spring.SpringEngineConfiguration
      • setResourceHelper

        public void setResourceHelper​(ResourceHelper resourceHelper)
      • setTemplateResourceResolver

        public void setTemplateResourceResolver​(TemplateResourceResolver templateResourceResolver)
      • getRootFolderName

        public java.lang.String getRootFolderName()
      • setRootFolderName

        public void setRootFolderName​(java.lang.String rootFolderName)
      • getTemplatesFolderName

        public java.lang.String getTemplatesFolderName()
      • setTemplatesFolderName

        public void setTemplatesFolderName​(java.lang.String templatesFolderName)
      • getDeploymentMode

        public java.lang.String getDeploymentMode()
        Specified by:
        getDeploymentMode in interface org.flowable.common.spring.SpringEngineConfiguration
      • setDeploymentMode

        public void setDeploymentMode​(java.lang.String deploymentMode)
        Specified by:
        setDeploymentMode in interface org.flowable.common.spring.SpringEngineConfiguration
      • getTemplateEngineName

        public java.lang.String getTemplateEngineName()
      • setTemplateEngineName

        public void setTemplateEngineName​(java.lang.String templateEngineName)
      • setTemplateDefinitionDeployer

        public void setTemplateDefinitionDeployer​(TemplateDefinitionDeployer templateDefinitionDeployer)
      • setTemplateResourceConverter

        public void setTemplateResourceConverter​(TemplateResourceConverter templateResourceConverter)
      • getTemplateDefinitionCacheLimit

        public int getTemplateDefinitionCacheLimit()
      • setTemplateDefinitionCacheLimit

        public void setTemplateDefinitionCacheLimit​(int templateDefinitionCacheLimit)
      • getTemplateVariationDefinitionCacheLimit

        public int getTemplateVariationDefinitionCacheLimit()
      • setTemplateVariationDefinitionCacheLimit

        public void setTemplateVariationDefinitionCacheLimit​(int templateVariationDefinitionCacheLimit)
      • getTemplateDefinitionCache

        public org.flowable.common.engine.impl.persistence.deploy.DeploymentCache<TemplateDefinitionCacheEntry> getTemplateDefinitionCache()
      • setTemplateDefinitionCache

        public void setTemplateDefinitionCache​(org.flowable.common.engine.impl.persistence.deploy.DeploymentCache<TemplateDefinitionCacheEntry> templateDefinitionCache)
      • getTemplateVariationDefinitionCache

        public org.flowable.common.engine.impl.persistence.deploy.DeploymentCache<TemplateVariationDefinitionCacheEntry> getTemplateVariationDefinitionCache()
      • setTemplateVariationDefinitionCache

        public void setTemplateVariationDefinitionCache​(org.flowable.common.engine.impl.persistence.deploy.DeploymentCache<TemplateVariationDefinitionCacheEntry> templateVariationDefinitionCache)
      • start

        public void start()
        Specified by:
        start in interface org.springframework.context.Lifecycle
      • stop

        public void stop()
        Specified by:
        stop in interface org.springframework.context.Lifecycle
      • isRunning

        public boolean isRunning()
        Specified by:
        isRunning in interface org.springframework.context.Lifecycle
      • getPhase

        public int getPhase()
        Specified by:
        getPhase in interface org.springframework.context.Phased
        Specified by:
        getPhase in interface org.springframework.context.SmartLifecycle
        Specified by:
        getPhase in interface org.flowable.common.spring.SpringEngineConfiguration
      • setTemplateRepositoryService

        public void setTemplateRepositoryService​(TemplateRepositoryService templateRepositoryService)
      • isTemplateProcessingStrictMode

        public boolean isTemplateProcessingStrictMode()
      • setTemplateProcessingStrictMode

        public void setTemplateProcessingStrictMode​(boolean templateProcessingStrictMode)
      • setTemplateService

        public void setTemplateService​(TemplateService templateService)
      • autoDeployResources

        protected void autoDeployResources​(TemplateEngine templateEngine)
      • getAutoDeploymentStrategy

        public org.flowable.common.spring.AutoDeploymentStrategy<TemplateEngine> getAutoDeploymentStrategy​(java.lang.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 java.util.Collection<org.flowable.common.spring.AutoDeploymentStrategy<TemplateEngine>> getDeploymentStrategies()
      • setDeploymentStrategies

        public void setDeploymentStrategies​(java.util.Collection<org.flowable.common.spring.AutoDeploymentStrategy<TemplateEngine>> deploymentStrategies)