Package org.flowable.common.engine.impl

Class AbstractEngineConfigurator<E extends Engine>

java.lang.Object

org.flowable.common.engine.impl.AbstractEngineConfigurator<E>

All Implemented Interfaces:

EngineConfigurator

Direct Known Subclasses:

CmmnEngineConfigurator, DmnEngineConfigurator, EventRegistryEngineConfigurator, ProcessEngineConfigurator

public abstract class AbstractEngineConfigurator<E extends Engine>
extends Object
implements EngineConfigurator

Convenience class for external engines (IDM/DMN/Form/...) to work together with the process engine while also sharing as much internal resources as possible.

Author:

Joram Barrez

Field Summary

Fields

Modifier and Type	Field	Description
protected E	buildEngine
protected boolean	enableMybatisXmlMappingValidation

Constructor Summary

Constructors

Constructor	Description
AbstractEngineConfigurator()

Method Summary

Modifier and Type	Method	Description
void	beforeInit(AbstractEngineConfiguration engineConfiguration)	Called before any initialisation has been done.
protected abstract E	buildEngine()
protected DocumentBuilderFactory	createDocumentBuilderFactory()
protected abstract List<EngineDeployer>	getCustomDeployers()
protected abstract List<Class<? extends Entity>>	getEntityDeletionOrder()
protected abstract List<Class<? extends Entity>>	getEntityInsertionOrder()
protected abstract String	getMybatisCfgPath()
protected List<MybatisTypeAliasConfigurator>	getMybatisTypeAliases()	Override when custom type aliases are needed.
protected List<MybatisTypeHandlerConfigurator>	getMybatisTypeHandlers()	Override when custom type handlers are needed.
protected void	initClock(AbstractEngineConfiguration engineConfiguration, AbstractEngineConfiguration targetEngineConfiguration)
protected void	initCommandContextFactory(AbstractEngineConfiguration engineConfiguration, AbstractEngineConfiguration targetEngineConfiguration)
protected void	initDataSource(AbstractEngineConfiguration engineConfiguration, AbstractEngineConfiguration targetEngineConfiguration)
protected void	initDbProperties(AbstractEngineConfiguration engineConfiguration, AbstractEngineConfiguration targetEngineConfiguration)
protected void	initDbSqlSessionFactory(AbstractEngineConfiguration engineConfiguration, AbstractEngineConfiguration targetEngineConfiguration)
protected E	initEngine()
protected void	initEngineConfigurations(AbstractEngineConfiguration engineConfiguration, AbstractEngineConfiguration targetEngineConfiguration)
protected void	initEventDispatcher(AbstractEngineConfiguration engineConfiguration, AbstractEngineConfiguration targetEngineConfiguration)
protected void	initEventRegistryEventConsumers(AbstractEngineConfiguration engineConfiguration, AbstractEngineConfiguration targetEngineConfiguration)
protected void	initialiseCommonProperties(AbstractEngineConfiguration engineConfiguration, AbstractBuildableEngineConfiguration<E> targetEngineConfiguration)
protected void	initialiseCommonProperties(AbstractEngineConfiguration engineConfiguration, AbstractEngineConfiguration targetEngineConfiguration)
protected void	initIdGenerator(AbstractEngineConfiguration engineConfiguration, AbstractEngineConfiguration targetEngineConfiguration)
protected void	initObjectMapper(AbstractEngineConfiguration engineConfiguration, AbstractEngineConfiguration targetEngineConfiguration)
protected void	initSchemaManager(AbstractEngineConfiguration engineConfiguration, AbstractEngineConfiguration targetEngineConfiguration)
protected void	initServiceConfigurations(AbstractEngineConfiguration engineConfiguration, AbstractEngineConfiguration targetEngineConfiguration)
protected void	initSessionFactories(AbstractEngineConfiguration engineConfiguration, AbstractEngineConfiguration targetEngineConfiguration)
protected void	initVariableTypes(AbstractEngineConfiguration engineConfiguration, AbstractEngineConfiguration targetEngineConfiguration)
boolean	isEnableMybatisXmlMappingValidation()
protected void	registerCustomDeployers(AbstractEngineConfiguration engineConfiguration)
protected void	registerCustomMybatisMappings(AbstractEngineConfiguration engineConfiguration)
void	setEnableMybatisXmlMappingValidation(boolean enableMybatisXmlMappingValidation)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.flowable.common.engine.impl.EngineConfigurator

configure, getPriority

Field Details

enableMybatisXmlMappingValidation

protected boolean enableMybatisXmlMappingValidation

buildEngine

protected E extends Engine buildEngine

Constructor Details

AbstractEngineConfigurator

public AbstractEngineConfigurator()

Method Details

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

registerCustomDeployers

protected void registerCustomDeployers(AbstractEngineConfiguration engineConfiguration)

getCustomDeployers

protected abstract List<EngineDeployer> getCustomDeployers()

getMybatisCfgPath

protected abstract String getMybatisCfgPath()

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.

registerCustomMybatisMappings

protected void registerCustomMybatisMappings(AbstractEngineConfiguration engineConfiguration)

createDocumentBuilderFactory

protected DocumentBuilderFactory createDocumentBuilderFactory()
                                                       throws ParserConfigurationException

Throws:

ParserConfigurationException

getMybatisTypeAliases

protected List<MybatisTypeAliasConfigurator> getMybatisTypeAliases()

Override when custom type aliases are needed.

getMybatisTypeHandlers

protected List<MybatisTypeHandlerConfigurator> getMybatisTypeHandlers()

Override when custom type handlers are needed.

initEngine

protected E initEngine()

buildEngine

protected abstract E buildEngine()

initialiseCommonProperties

protected void initialiseCommonProperties(AbstractEngineConfiguration engineConfiguration,
 AbstractBuildableEngineConfiguration<E> targetEngineConfiguration)

initialiseCommonProperties

protected void initialiseCommonProperties(AbstractEngineConfiguration engineConfiguration,
 AbstractEngineConfiguration targetEngineConfiguration)

initEngineConfigurations

protected void initEngineConfigurations(AbstractEngineConfiguration engineConfiguration,
 AbstractEngineConfiguration targetEngineConfiguration)

initServiceConfigurations

protected void initServiceConfigurations(AbstractEngineConfiguration engineConfiguration,
 AbstractEngineConfiguration targetEngineConfiguration)

initEventRegistryEventConsumers

protected void initEventRegistryEventConsumers(AbstractEngineConfiguration engineConfiguration,
 AbstractEngineConfiguration targetEngineConfiguration)

initCommandContextFactory

protected void initCommandContextFactory(AbstractEngineConfiguration engineConfiguration,
 AbstractEngineConfiguration targetEngineConfiguration)

initIdGenerator

protected void initIdGenerator(AbstractEngineConfiguration engineConfiguration,
 AbstractEngineConfiguration targetEngineConfiguration)

initDataSource

protected void initDataSource(AbstractEngineConfiguration engineConfiguration,
 AbstractEngineConfiguration targetEngineConfiguration)

initDbSqlSessionFactory

protected void initDbSqlSessionFactory(AbstractEngineConfiguration engineConfiguration,
 AbstractEngineConfiguration targetEngineConfiguration)

initSessionFactories

protected void initSessionFactories(AbstractEngineConfiguration engineConfiguration,
 AbstractEngineConfiguration targetEngineConfiguration)

initDbProperties

protected void initDbProperties(AbstractEngineConfiguration engineConfiguration,
 AbstractEngineConfiguration targetEngineConfiguration)

initEventDispatcher

protected void initEventDispatcher(AbstractEngineConfiguration engineConfiguration,
 AbstractEngineConfiguration targetEngineConfiguration)

initClock

protected void initClock(AbstractEngineConfiguration engineConfiguration,
 AbstractEngineConfiguration targetEngineConfiguration)

initObjectMapper

protected void initObjectMapper(AbstractEngineConfiguration engineConfiguration,
 AbstractEngineConfiguration targetEngineConfiguration)

initVariableTypes

protected void initVariableTypes(AbstractEngineConfiguration engineConfiguration,
 AbstractEngineConfiguration targetEngineConfiguration)

initSchemaManager

protected void initSchemaManager(AbstractEngineConfiguration engineConfiguration,
 AbstractEngineConfiguration targetEngineConfiguration)

getEntityInsertionOrder

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

getEntityDeletionOrder

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

isEnableMybatisXmlMappingValidation

public boolean isEnableMybatisXmlMappingValidation()

setEnableMybatisXmlMappingValidation

public void setEnableMybatisXmlMappingValidation(boolean enableMybatisXmlMappingValidation)