Class ActionEngineConfiguration

java.lang.Object
org.flowable.common.engine.impl.AbstractEngineConfiguration
org.flowable.common.engine.impl.AbstractBuildableEngineConfiguration<ActionEngine>
com.flowable.action.engine.ActionEngineConfiguration
All Implemented Interfaces:
ActionEngineConfigurationApi, org.flowable.common.spring.SpringEngineConfiguration, Aware, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle

public class ActionEngineConfiguration extends org.flowable.common.engine.impl.AbstractBuildableEngineConfiguration<ActionEngine> implements org.flowable.common.spring.SpringEngineConfiguration, ActionEngineConfigurationApi
Author:
Filip Hrisafov
  • Field Details

    • DEFAULT_MYBATIS_MAPPING_FILE

      public static final String DEFAULT_MYBATIS_MAPPING_FILE
      See Also:
    • DEFAULT_ENGINE_NAME

      public static final String DEFAULT_ENGINE_NAME
      See Also:
    • KEY_ACTION_ENGINE_CONFIG

      public static final String KEY_ACTION_ENGINE_CONFIG
      See Also:
    • actionEngineName

      protected String actionEngineName
    • actionRepositoryService

      protected ActionRepositoryService actionRepositoryService
    • actionRuntimeService

      protected ActionRuntimeService actionRuntimeService
    • actionHistoryService

      protected ActionHistoryService actionHistoryService
    • actionManagementService

      protected ActionManagementService actionManagementService
    • changeTenantIdManager

      protected org.flowable.common.engine.impl.tenant.ChangeTenantIdManager changeTenantIdManager
    • dataManagers

      protected final ActionDataManagers dataManagers
    • entityManagers

      protected final ActionEntityManagers entityManagers
    • identityLinkSchemaManager

      protected org.flowable.common.engine.impl.db.SchemaManager identityLinkSchemaManager
    • scopedObjectActionFilters

      protected Map<String,List<ScopedObjectActionFilter>> scopedObjectActionFilters
    • scopedObjectProviders

      protected Map<String,ScopedObjectProvider<?,?>> scopedObjectProviders
    • scopedObjectFormProviders

      protected Map<String,ScopedObjectFormProvider> scopedObjectFormProviders
    • defaultScopedObjectFormProvider

      protected ScopedObjectFormProvider defaultScopedObjectFormProvider
    • transactionManager

      protected PlatformTransactionManager transactionManager
    • transactionSynchronizationAdapterOrder

      protected Integer transactionSynchronizationAdapterOrder
    • applicationContext

      protected ApplicationContext applicationContext
    • running

      protected volatile boolean running
    • actionDefinitionDeployer

      protected ActionDefinitionDeployer actionDefinitionDeployer
    • deploymentManager

      protected ActionDeploymentManager deploymentManager
    • actionResourceConverter

      protected ActionResourceConverter actionResourceConverter
    • actionDefinitionCacheLimit

      protected int actionDefinitionCacheLimit
    • actionDefinitionCache

      protected org.flowable.common.engine.impl.persistence.deploy.DeploymentCache<ActionDefinitionCacheEntry> actionDefinitionCache
    • deploymentName

      protected String deploymentName
    • deploymentResources

      protected Resource[] deploymentResources
    • deploymentMode

      protected String deploymentMode
    • enginesBuild

      protected List<String> enginesBuild
    • lifeCycleMonitor

      protected final Object lifeCycleMonitor
    • history

      protected String history
    • historyLevel

      protected org.flowable.common.engine.impl.history.HistoryLevel historyLevel
    • identityLinkServiceConfiguration

      protected org.flowable.identitylink.service.IdentityLinkServiceConfiguration identityLinkServiceConfiguration
    • botRegistry

      protected Map<String,BotService> botRegistry
  • Constructor Details

    • ActionEngineConfiguration

      public ActionEngineConfiguration()
  • 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 ActionDataManagers getDataManagers()
    • getEntityManagers

      public ActionEntityManagers getEntityManagers()
    • getScopedObjectActionFilters

      public List<ScopedObjectActionFilter> getScopedObjectActionFilters(String scopeType)
      Description copied from interface: ActionEngineConfigurationApi
      Get the list of ScopedObjectActionFilter(s) for the given scopeType. If there are no registered filters then an empty list should be returned. The method never returns null
      Specified by:
      getScopedObjectActionFilters in interface ActionEngineConfigurationApi
      Parameters:
      scopeType - the type of the scoped object action filters
      Returns:
      the scoped object action filters for the given scopeType, never null
    • getScopedObjectActionFilters

      public Map<String,List<ScopedObjectActionFilter>> getScopedObjectActionFilters()
    • setScopedObjectActionFilters

      public void setScopedObjectActionFilters(Map<String,List<ScopedObjectActionFilter>> scopedObjectActionFilters)
    • addScopedObjectActionFilter

      public void addScopedObjectActionFilter(ScopedObjectActionFilter actionFilter)
    • addScopedObjectActionFilter

      public void addScopedObjectActionFilter(String scopeType, ScopedObjectActionFilter actionFilter)
    • removeScopedObjectActionFilter

      public void removeScopedObjectActionFilter(ScopedObjectActionFilter actionFilter)
    • getScopedObjectProvider

      public ScopedObjectProvider<?,?> getScopedObjectProvider(String scopeType)
      Description copied from interface: ActionEngineConfigurationApi
      Get the ScopedObjectProvider for the given scopeType. If there is no registered ScopedObjectProvider then this method should throw an exception. It never returns null
      Specified by:
      getScopedObjectProvider in interface ActionEngineConfigurationApi
      Parameters:
      scopeType - the type of the scoped object provider
      Returns:
      the scoped object provider for the given scopeType, never null
    • getScopedObjectProviders

      public Map<String,ScopedObjectProvider<?,?>> getScopedObjectProviders()
    • setScopedObjectProviders

      public void setScopedObjectProviders(Map<String,ScopedObjectProvider<?,?>> scopedObjectProviders)
    • addScopedObjectProvider

      public void addScopedObjectProvider(ScopedObjectProvider<?,?> scopedObjectProvider)
    • addScopedObjectProvider

      public void addScopedObjectProvider(String scopeType, ScopedObjectProvider<?,?> scopedObjectProvider)
    • removeScopedObjectProvider

      public void removeScopedObjectProvider(ScopedObjectProvider<?,?> scopedObjectProvider)
    • getScopedObjectFormProviders

      public Map<String,ScopedObjectFormProvider> getScopedObjectFormProviders()
    • setScopedObjectFormProviders

      public void setScopedObjectFormProviders(Map<String,ScopedObjectFormProvider> scopedObjectFormProviders)
    • addScopedObjectFormProvider

      public void addScopedObjectFormProvider(ScopedObjectFormProvider scopedObjectFormProvider)
    • removeScopedObjectFormProvider

      public void removeScopedObjectFormProvider(ScopedObjectFormProvider scopedObjectFormProvider)
    • getDefaultScopedObjectFormProvider

      public ScopedObjectFormProvider getDefaultScopedObjectFormProvider()
    • setDefaultScopedObjectFormProvider

      public void setDefaultScopedObjectFormProvider(ScopedObjectFormProvider defaultScopedObjectFormProvider)
    • setDataSource

      public ActionEngineConfiguration setDataSource(DataSource dataSource)
      Overrides:
      setDataSource in class org.flowable.common.engine.impl.AbstractEngineConfiguration
    • buildActionEngine

      public ActionEngine buildActionEngine()
    • createEngine

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

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

      protected void init()
      Specified by:
      init in class org.flowable.common.engine.impl.AbstractBuildableEngineConfiguration<ActionEngine>
    • initServices

      protected void initServices()
    • initChangeTenantIdManager

      public void initChangeTenantIdManager()
    • 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
    • createEngineSchemaManager

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

      public void initMybatisTypeHandlers(org.apache.ibatis.session.Configuration configuration)
      Overrides:
      initMybatisTypeHandlers 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
    • initHistoryLevel

      public void initHistoryLevel()
    • initDeployers

      protected void initDeployers()
    • getDefaultDeployers

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

      protected void initActionDefinitionCache()
    • initActionResourceConverter

      protected void initActionResourceConverter()
    • initDeploymentManager

      protected void initDeploymentManager()
    • initIdentityLinkServiceConfiguration

      protected void initIdentityLinkServiceConfiguration()
    • instantiateIdentityLinkServiceConfiguration

      protected org.flowable.identitylink.service.IdentityLinkServiceConfiguration instantiateIdentityLinkServiceConfiguration()
    • 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
    • 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
    • getActionEngineName

      public String getActionEngineName()
    • setActionEngineName

      public void setActionEngineName(String actionEngineName)
    • getIdentityLinkSchemaManager

      public org.flowable.common.engine.impl.db.SchemaManager getIdentityLinkSchemaManager()
    • setIdentityLinkSchemaManager

      public void setIdentityLinkSchemaManager(org.flowable.common.engine.impl.db.SchemaManager identityLinkSchemaManager)
    • getActionDefinitionDeployer

      public ActionDefinitionDeployer getActionDefinitionDeployer()
    • getIdentityLinkServiceConfiguration

      public org.flowable.identitylink.service.IdentityLinkServiceConfiguration getIdentityLinkServiceConfiguration()
    • setActionDefinitionDeployer

      public void setActionDefinitionDeployer(ActionDefinitionDeployer actionDefinitionDeployer)
    • getDeploymentManager

      public ActionDeploymentManager getDeploymentManager()
    • setDeploymentManager

      public void setDeploymentManager(ActionDeploymentManager deploymentManager)
    • getActionResourceConverter

      public ActionResourceConverter getActionResourceConverter()
    • setActionResourceConverter

      public void setActionResourceConverter(ActionResourceConverter actionResourceConverter)
    • getActionDefinitionCacheLimit

      public int getActionDefinitionCacheLimit()
    • setActionDefinitionCacheLimit

      public void setActionDefinitionCacheLimit(int actionDefinitionCacheLimit)
    • getActionDefinitionCache

      public org.flowable.common.engine.impl.persistence.deploy.DeploymentCache<ActionDefinitionCacheEntry> getActionDefinitionCache()
    • setActionDefinitionCache

      public void setActionDefinitionCache(org.flowable.common.engine.impl.persistence.deploy.DeploymentCache<ActionDefinitionCacheEntry> actionDefinitionCache)
    • getHistory

      public String getHistory()
    • setHistory

      public void setHistory(String history)
    • getHistoryLevel

      public org.flowable.common.engine.impl.history.HistoryLevel getHistoryLevel()
    • setHistoryLevel

      public void setHistoryLevel(org.flowable.common.engine.impl.history.HistoryLevel historyLevel)
    • getBotRegistry

      public Map<String,BotService> getBotRegistry()
    • setBotRegistry

      public void setBotRegistry(Map<String,BotService> botRegistry)
    • addBotService

      public void addBotService(String key, BotService botService)
    • registerBotService

      public void registerBotService(BotService botService)
    • unregisterBotService

      public void unregisterBotService(BotService botService)
    • getDeploymentStrategies

      public Collection<org.flowable.common.spring.AutoDeploymentStrategy<ActionEngine>> getDeploymentStrategies()
    • setDeploymentStrategies

      public void setDeploymentStrategies(Collection<org.flowable.common.spring.AutoDeploymentStrategy<ActionEngine>> deploymentStrategies)
    • 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
    • getActionRepositoryService

      public ActionRepositoryService getActionRepositoryService()
      Specified by:
      getActionRepositoryService in interface ActionEngineConfigurationApi
    • setActionRepositoryService

      public void setActionRepositoryService(ActionRepositoryService actionRepositoryService)
    • getActionRuntimeService

      public ActionRuntimeService getActionRuntimeService()
      Specified by:
      getActionRuntimeService in interface ActionEngineConfigurationApi
    • setActionRuntimeService

      public void setActionRuntimeService(ActionRuntimeService actionRuntimeService)
    • getActionHistoryService

      public ActionHistoryService getActionHistoryService()
      Specified by:
      getActionHistoryService in interface ActionEngineConfigurationApi
    • setActionHistoryService

      public void setActionHistoryService(ActionHistoryService actionHistoryService)
    • getActionManagementService

      public ActionManagementService getActionManagementService()
      Specified by:
      getActionManagementService in interface ActionEngineConfigurationApi
    • setActionManagementService

      public void setActionManagementService(ActionManagementService actionManagementService)
    • getChangeTenantIdManager

      public org.flowable.common.engine.impl.tenant.ChangeTenantIdManager getChangeTenantIdManager()
    • setChangeTenantIdManager

      public void setChangeTenantIdManager(org.flowable.common.engine.impl.tenant.ChangeTenantIdManager changeTenantIdManager)
    • isMigrateActionTypeLinks

      public boolean isMigrateActionTypeLinks()
    • setMigrateActionTypeLinks

      public void setMigrateActionTypeLinks(boolean migrateActionTypeLinks)
    • autoDeployResources

      protected void autoDeployResources(ActionEngine actionEngine)
    • getAutoDeploymentStrategy

      public org.flowable.common.spring.AutoDeploymentStrategy<ActionEngine> 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