Class TemplateEngineConfiguration

java.lang.Object
org.flowable.common.engine.impl.AbstractEngineConfiguration
org.flowable.common.engine.impl.AbstractBuildableEngineConfiguration<TemplateEngine>
com.flowable.template.engine.TemplateEngineConfiguration
All Implemented Interfaces:
TemplateEngineConfigurationApi, org.flowable.common.spring.SpringEngineConfiguration, Aware, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle

public class TemplateEngineConfiguration extends org.flowable.common.engine.impl.AbstractBuildableEngineConfiguration<TemplateEngine> implements org.flowable.common.spring.SpringEngineConfiguration, TemplateEngineConfigurationApi
Author:
Tijs Rademakers
  • Field Details

  • Constructor Details

    • TemplateEngineConfiguration

      public TemplateEngineConfiguration()
  • Method Details

    • getEngineCfgKey

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

      public 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 InputStream getMyBatisXmlConfigurationStream()
      Specified by:
      getMyBatisXmlConfigurationStream in class org.flowable.common.engine.impl.AbstractEngineConfiguration
    • getEngineName

      public String getEngineName()
      Specified by:
      getEngineName in class org.flowable.common.engine.impl.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 org.flowable.common.engine.impl.AbstractEngineConfiguration
    • buildTemplateEngine

      public TemplateEngine buildTemplateEngine()
    • createEngine

      protected TemplateEngine createEngine()
      Specified by:
      createEngine in class org.flowable.common.engine.impl.AbstractBuildableEngineConfiguration<TemplateEngine>
    • createPostEngineBuildConsumer

      protected Consumer<TemplateEngine> createPostEngineBuildConsumer()
      Specified by:
      createPostEngineBuildConsumer in class org.flowable.common.engine.impl.AbstractBuildableEngineConfiguration<TemplateEngine>
    • init

      protected void init()
      Specified by:
      init in class org.flowable.common.engine.impl.AbstractBuildableEngineConfiguration<TemplateEngine>
    • 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
    • createEngineSchemaManager

      protected org.flowable.common.engine.impl.db.SchemaManager createEngineSchemaManager()
      Specified by:
      createEngineSchemaManager in class org.flowable.common.engine.impl.AbstractEngineConfiguration
    • initDeployers

      protected void initDeployers()
    • getDefaultDeployers

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

      protected void initTemplateDefinitionCaches()
    • initTemplateResourceConverters

      protected void initTemplateResourceConverters()
    • initDeploymentManager

      protected void initDeploymentManager()
    • getTransactionManager

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

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

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

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

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

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

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

      public void setApplicationContext(ApplicationContext applicationContext)
      Specified by:
      setApplicationContext in interface ApplicationContextAware
      Specified by:
      setApplicationContext in interface org.flowable.common.spring.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 org.flowable.common.spring.SpringEngineConfiguration
    • setDeploymentMode

      public void setDeploymentMode(String deploymentMode)
      Specified by:
      setDeploymentMode in interface org.flowable.common.spring.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 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)
    • 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 org.flowable.common.spring.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 org.flowable.common.spring.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<org.flowable.common.spring.AutoDeploymentStrategy<TemplateEngine>> getDeploymentStrategies()
    • setDeploymentStrategies

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