Package org.flowable.cmmn.engine.configurator

Class CmmnEngineConfigurator

java.lang.Object

org.flowable.common.engine.impl.AbstractEngineConfigurator

org.flowable.cmmn.engine.configurator.CmmnEngineConfigurator

All Implemented Interfaces:

EngineConfigurator

Direct Known Subclasses:

SpringCmmnEngineConfigurator

public class CmmnEngineConfigurator
extends AbstractEngineConfigurator

Author:

Joram Barrez

Field Summary

Fields

Modifier and Type	Field	Description
protected CmmnEngineConfiguration	cmmnEngineConfiguration

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

enableMybatisXmlMappingValidation

Constructor Summary

Constructors

Constructor	Description
CmmnEngineConfigurator()

Method Summary

Modifier and Type	Method	Description
void	beforeInit(AbstractEngineConfiguration engineConfiguration)	Called before any initialisation has been done.
void	configure(AbstractEngineConfiguration engineConfiguration)	Called when the engine boots up, before it is usable, but after the initialisation of internal objects is done.
protected void	copyProcessEngineProperties(ProcessEngineConfigurationImpl processEngineConfiguration)
CmmnEngineConfiguration	getCmmnEngineConfiguration()
protected List<EngineDeployer>	getCustomDeployers()
protected List<Class<? extends Entity>>	getEntityDeletionOrder()
protected List<Class<? extends Entity>>	getEntityInsertionOrder()
protected JobServiceConfiguration	getJobServiceConfiguration(AbstractEngineConfiguration engineConfiguration)
protected String	getMybatisCfgPath()
int	getPriority()	When the EngineConfigurator instances are used, they are first ordered by this priority number (lowest to highest).
protected ProcessEngineConfigurationImpl	getProcessEngineConfiguration(AbstractEngineConfiguration engineConfiguration)
protected void	initCaseInstanceService(ProcessEngineConfigurationImpl processEngineConfiguration)
protected CmmnEngine	initCmmnEngine()
protected void	initProcessInstanceService(ProcessEngineConfigurationImpl processEngineConfiguration)
protected void	initProcessInstanceStateChangedCallbacks(ProcessEngineConfigurationImpl processEngineConfiguration)
CmmnEngineConfigurator	setCmmnEngineConfiguration(CmmnEngineConfiguration cmmnEngineConfiguration)

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

createDocumentBuilderFactory, getMybatisTypeAliases, getMybatisTypeHandlers, initClock, initCommandContextFactory, initDataSource, initDbProperties, initDbSqlSessionFactory, initEngineConfigurations, initEventDispatcher, initEventRegistryEventConsumers, initialiseCommonProperties, initIdGenerator, initObjectMapper, initServiceConfigurations, initSessionFactories, initVariableTypes, isEnableMybatisXmlMappingValidation, registerCustomDeployers, registerCustomMybatisMappings, setEnableMybatisXmlMappingValidation

Methods inherited from class java.lang.Object

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

Field Details

cmmnEngineConfiguration

protected CmmnEngineConfiguration cmmnEngineConfiguration

Constructor Details

CmmnEngineConfigurator

public CmmnEngineConfigurator()

Method Details

getPriority

public int getPriority()

Description copied from interface: EngineConfigurator

When the EngineConfigurator instances are used, they are first ordered by this priority number (lowest to highest). If you have dependencies between EngineConfigurator instances, use the priorities accordingly to order them as needed.

getCustomDeployers

protected List<EngineDeployer> getCustomDeployers()

Specified by:

getCustomDeployers in class AbstractEngineConfigurator

getMybatisCfgPath

protected String getMybatisCfgPath()

Specified by:

getMybatisCfgPath in class AbstractEngineConfigurator

Returns:

The path to the Mybatis cfg file that is normally used for the engine (so the full cfg, not an individual mapper). Return null in case no custom mappers should be loaded.

beforeInit

public void beforeInit(AbstractEngineConfiguration engineConfiguration)

Description copied from interface: EngineConfigurator

Called before any initialisation has been done. This can for example be useful to change configuration settings before anything that uses those properties is created. Allows to tweak the engine by passing the AbstractEngineConfiguration which allows tweaking it programmatically. An example is the jdbc url. When a EngineConfigurator instance wants to change it, it needs to do it in this method, or otherwise the datasource would already have been created with the 'old' value for the jdbc url.

Specified by:

beforeInit in interface EngineConfigurator

Overrides:

beforeInit in class AbstractEngineConfigurator

configure

public void configure(AbstractEngineConfiguration engineConfiguration)

Description copied from interface: EngineConfigurator

Called when the engine boots up, before it is usable, but after the initialisation of internal objects is done. Allows to tweak the engine by passing the AbstractEngineConfiguration which allows tweaking it programmatically. An example is the ldap user/group manager, which is an addition to the engine. No default properties need to be overridden for this (otherwise the EngineConfigurator.beforeInit(AbstractEngineConfiguration) method should be used) so the logic contained in this method is executed after initialisation of the default objects. Probably a better name would be 'afterInit' (cfr EngineConfigurator.beforeInit(AbstractEngineConfiguration)), but not possible due to backwards compatibility.

copyProcessEngineProperties

protected void copyProcessEngineProperties(ProcessEngineConfigurationImpl processEngineConfiguration)

getProcessEngineConfiguration

protected ProcessEngineConfigurationImpl getProcessEngineConfiguration(AbstractEngineConfiguration engineConfiguration)

getJobServiceConfiguration

protected JobServiceConfiguration getJobServiceConfiguration(AbstractEngineConfiguration engineConfiguration)

initProcessInstanceService

protected void initProcessInstanceService(ProcessEngineConfigurationImpl processEngineConfiguration)

initCaseInstanceService

protected void initCaseInstanceService(ProcessEngineConfigurationImpl processEngineConfiguration)

initProcessInstanceStateChangedCallbacks

protected void initProcessInstanceStateChangedCallbacks(ProcessEngineConfigurationImpl processEngineConfiguration)

getEntityInsertionOrder

protected List<Class<? extends Entity>> getEntityInsertionOrder()

Specified by:

getEntityInsertionOrder in class AbstractEngineConfigurator

getEntityDeletionOrder

protected List<Class<? extends Entity>> getEntityDeletionOrder()

Specified by:

getEntityDeletionOrder in class AbstractEngineConfigurator

initCmmnEngine

protected CmmnEngine initCmmnEngine()

getCmmnEngineConfiguration

public CmmnEngineConfiguration getCmmnEngineConfiguration()

setCmmnEngineConfiguration

public CmmnEngineConfigurator setCmmnEngineConfiguration(CmmnEngineConfiguration cmmnEngineConfiguration)