Package org.flowable.engine.configurator

Class ProcessEngineConfigurator

java.lang.Object

org.flowable.common.engine.impl.AbstractEngineConfigurator

org.flowable.engine.configurator.ProcessEngineConfigurator

All Implemented Interfaces:

EngineConfigurator

Direct Known Subclasses:

SpringProcessEngineConfigurator

public class ProcessEngineConfigurator
extends AbstractEngineConfigurator

Author:

Tijs Rademakers

Field Summary

Fields

Modifier and Type	Field	Description
protected ProcessEngineConfiguration	processEngineConfiguration

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

enableMybatisXmlMappingValidation

Constructor Summary

Constructors

Constructor	Description
ProcessEngineConfigurator()

Method Summary

Modifier and Type	Method	Description
void	configure(AbstractEngineConfiguration engineConfiguration)	Called when the engine boots up, before it is usable, but after the initialisation of internal objects is done.
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).
ProcessEngineConfiguration	getProcessEngineConfiguration()
protected void	initDbSqlSessionFactory(AbstractEngineConfiguration engineConfiguration, AbstractEngineConfiguration targetEngineConfiguration)
protected ProcessEngine	initProcessEngine()
ProcessEngineConfigurator	setProcessEngineConfiguration(ProcessEngineConfiguration processEngineConfiguration)

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

beforeInit, createDocumentBuilderFactory, getMybatisTypeAliases, getMybatisTypeHandlers, initClock, initCommandContextFactory, initDataSource, initDbProperties, 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

processEngineConfiguration

protected ProcessEngineConfiguration processEngineConfiguration

Constructor Details

ProcessEngineConfigurator

public ProcessEngineConfigurator()

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.

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.

initDbSqlSessionFactory

protected void initDbSqlSessionFactory(AbstractEngineConfiguration engineConfiguration,
 AbstractEngineConfiguration targetEngineConfiguration)

Overrides:

initDbSqlSessionFactory in class AbstractEngineConfigurator

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

initProcessEngine

protected ProcessEngine initProcessEngine()

getProcessEngineConfiguration

public ProcessEngineConfiguration getProcessEngineConfiguration()

setProcessEngineConfiguration

public ProcessEngineConfigurator setProcessEngineConfiguration(ProcessEngineConfiguration processEngineConfiguration)

getJobServiceConfiguration

protected JobServiceConfiguration getJobServiceConfiguration(AbstractEngineConfiguration engineConfiguration)