Package org.flowable.eventregistry.impl.configurator

Class EventRegistryEngineConfigurator

java.lang.Object

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

org.flowable.eventregistry.impl.configurator.EventRegistryEngineConfigurator

All Implemented Interfaces:

EngineConfigurator

Direct Known Subclasses:

SpringEventRegistryConfigurator

public class EventRegistryEngineConfigurator
extends AbstractEngineConfigurator<EventRegistryEngine>

Author:

Tijs Rademakers, Joram Barrez

Field Summary

Fields

Modifier and Type	Field	Description
protected EventRegistryEngineConfiguration	eventEngineConfiguration

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

buildEngine, enableMybatisXmlMappingValidation

Constructor Summary

Constructors

Constructor	Description
EventRegistryEngineConfigurator()

Method Summary

Modifier and Type	Method	Description
protected EventRegistryEngine	buildEngine()
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()
EventRegistryEngineConfiguration	getEventEngineConfiguration()
EventRegistryEngine	getEventRegistryEngine()
protected String	getMybatisCfgPath()
int	getPriority()	When the EngineConfigurator instances are used, they are first ordered by this priority number (lowest to highest).
protected void	initialiseEventRegistryEngineConfiguration(EventRegistryEngineConfiguration eventRegistryEngineConfiguration)
EventRegistryEngineConfigurator	setEventEngineConfiguration(EventRegistryEngineConfiguration eventEngineConfiguration)
void	setEventRegistryEngine(EventRegistryEngine eventRegistryEngine)

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

beforeInit, createDocumentBuilderFactory, getMybatisTypeAliases, getMybatisTypeHandlers, initClock, initCommandContextFactory, initDataSource, initDbProperties, initDbSqlSessionFactory, initEngine, initEngineConfigurations, initEventDispatcher, initEventRegistryEventConsumers, initialiseCommonProperties, initialiseCommonProperties, initIdGenerator, initObjectMapper, initSchemaManager, 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

eventEngineConfiguration

protected EventRegistryEngineConfiguration eventEngineConfiguration

Constructor Details

EventRegistryEngineConfigurator

public EventRegistryEngineConfigurator()

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<EventRegistryEngine>

getMybatisCfgPath

protected String getMybatisCfgPath()

Specified by:

getMybatisCfgPath in class AbstractEngineConfigurator<EventRegistryEngine>

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.

initialiseEventRegistryEngineConfiguration

protected void initialiseEventRegistryEngineConfiguration(EventRegistryEngineConfiguration eventRegistryEngineConfiguration)

getEntityInsertionOrder

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

Specified by:

getEntityInsertionOrder in class AbstractEngineConfigurator<EventRegistryEngine>

getEntityDeletionOrder

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

Specified by:

getEntityDeletionOrder in class AbstractEngineConfigurator<EventRegistryEngine>

buildEngine

protected EventRegistryEngine buildEngine()

Specified by:

buildEngine in class AbstractEngineConfigurator<EventRegistryEngine>

getEventEngineConfiguration

public EventRegistryEngineConfiguration getEventEngineConfiguration()

setEventEngineConfiguration

public EventRegistryEngineConfigurator setEventEngineConfiguration(EventRegistryEngineConfiguration eventEngineConfiguration)

getEventRegistryEngine

public EventRegistryEngine getEventRegistryEngine()

setEventRegistryEngine

public void setEventRegistryEngine(EventRegistryEngine eventRegistryEngine)