Package com.flowable.audit.engine

Class AuditEngineConfiguration

java.lang.Object

org.flowable.common.engine.impl.AbstractEngineConfiguration

org.flowable.common.engine.impl.AbstractBuildableEngineConfiguration<AuditEngine>

com.flowable.audit.engine.AuditEngineConfiguration

All Implemented Interfaces:

AuditEngineConfigurationApi, SpringEngineConfiguration, Aware, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle

public class AuditEngineConfiguration
extends AbstractBuildableEngineConfiguration<AuditEngine>
implements SpringEngineConfiguration, AuditEngineConfigurationApi

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field	Description
protected String	actionEngineName
protected ApplicationContext	applicationContext
protected AuditManagementService	auditManagementService
protected AuditService	auditService
protected ChangeTenantIdManager	changeTenantIdManager
protected final AuditDataManagers	dataManagers
static final String	DEFAULT_ENGINE_NAME
static final String	DEFAULT_MYBATIS_MAPPING_FILE
protected List<String>	enginesBuild
protected final AuditEntityManagers	entityManagers
static final String	KEY_AUDIT_ENGINE_CONFIG
protected boolean	running
protected PlatformTransactionManager	transactionManager
protected Integer	transactionSynchronizationAdapterOrder

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

postEngineBuildConsumer, runPostEngineBuildConsumer

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

additionalEventDispatchActions, additionalSchemaManagers, agendaOperationExecutionListeners, agendaOperationRunner, allConfigurators, alwaysLookupLatestDefinitionVersion, beans, byteArrayDataManager, byteArrayEntityManager, classLoader, clock, commandContextFactory, commandExecutor, commandInterceptors, commandInvoker, commonSchemaManager, configurators, customMybatisInterceptors, customMybatisMappers, customMybatisXMLMappers, customPostCommandInterceptors, customPostDeployers, customPreCommandInterceptors, customPreDeployers, customSessionFactories, DATABASE_TYPE_COCKROACHDB, DATABASE_TYPE_DB2, DATABASE_TYPE_H2, DATABASE_TYPE_HSQL, DATABASE_TYPE_MSSQL, DATABASE_TYPE_MYSQL, DATABASE_TYPE_ORACLE, DATABASE_TYPE_POSTGRES, databaseCatalog, databaseSchema, databaseSchemaUpdate, databaseTablePrefix, databaseType, databaseTypeMappings, databaseWildcardEscapeCharacter, dataSource, dataSourceJndiName, DB_SCHEMA_UPDATE_CREATE, DB_SCHEMA_UPDATE_CREATE_DROP, DB_SCHEMA_UPDATE_DROP_CREATE, DB_SCHEMA_UPDATE_FALSE, DB_SCHEMA_UPDATE_TRUE, dbSqlSessionFactory, DEFAULT_GENERIC_MAX_LENGTH_STRING, DEFAULT_MAX_NR_OF_STATEMENTS_BULK_INSERT_SQL_SERVER, DEFAULT_ORACLE_MAX_LENGTH_STRING, defaultCommandConfig, defaultCommandInterceptors, defaultTenantProvider, dependentEngineMybatisTypeAliasConfigs, dependentEngineMybatisTypeHandlerConfigs, dependentEngineMyBatisXmlMappers, deployers, enableConfiguratorServiceLoader, enableEventDispatcher, enableLogSqlExecutionTime, engineConfigurations, engineLifecycleListeners, eventDispatcher, eventListeners, eventRegistryConfigurator, eventRegistryEventConsumers, fallbackToDefaultTenant, forceCloseMybatisConnectionPool, idGenerator, idmEngineConfigurator, isBulkInsertEnabled, isDbHistoryUsed, jdbcDefaultTransactionIsolationLevel, jdbcDriver, jdbcMaxActiveConnections, jdbcMaxCheckoutTime, jdbcMaxIdleConnections, jdbcMaxWaitTime, jdbcPassword, jdbcPingConnectionNotUsedFor, jdbcPingEnabled, jdbcPingQuery, jdbcUrl, jdbcUsername, lockPollRate, logger, loggingListener, maxLengthStringVariableType, maxNrOfStatementsInBulkInsert, mybatisMappingFile, NO_TENANT_ID, objectMapper, PRODUCT_NAME_CRDB, PRODUCT_NAME_POSTGRES, propertyDataManager, propertyEntityManager, schemaCommandConfig, schemaLockWaitTime, schemaManagementCmd, schemaManager, serviceConfigurations, sessionFactories, sqlSessionFactory, tableDataManager, tablePrefixIsSchema, transactionContextFactory, transactionFactory, transactionsExternallyManaged, typedEventListeners, useClassForNameClassLoading, useLockForDatabaseSchemaUpdate, usePrefixId, usingRelationalDatabase, usingSchemaMgmt, xmlEncoding

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Fields inherited from interface org.flowable.common.spring.SpringEngineConfiguration

PHASE, PHASE_DELTA

Constructor Summary

Constructors

Constructor	Description
AuditEngineConfiguration()

Method Summary

Modifier and Type	Method	Description
AuditEngine	buildAuditEngine()
protected AuditEngine	createEngine()
protected SchemaManager	createEngineSchemaManager()
protected Consumer<AuditEngine>	createPostEngineBuildConsumer()
CommandInterceptor	createTransactionInterceptor()
String	getActionEngineName()
ApplicationContext	getApplicationContext()
AuditManagementService	getAuditManagementService()
AuditService	getAuditService()	Returns the audit service where audit entries can be created and retrieved.
ChangeTenantIdManager	getChangeTenantIdManager()
AuditDataManagers	getDataManagers()
String	getDeploymentMode()
String	getDeploymentName()
Resource[]	getDeploymentResources()
String	getEngineCfgKey()
String	getEngineName()
String	getEngineScopeType()
AuditEntityManagers	getEntityManagers()
InputStream	getMyBatisXmlConfigurationStream()
PlatformTransactionManager	getTransactionManager()
protected void	init()
void	initChangeTenantIdManager()
void	initDataManagers()
protected void	initDbSqlSessionFactoryEntitySettings()
void	initDefaultCommandConfig()
void	initEntityManagers()
void	initMybatisTypeHandlers(org.apache.ibatis.session.Configuration configuration)
protected void	initServices()
void	initTransactionContextFactory()
boolean	isRunning()
void	setActionEngineName(String actionEngineName)
void	setApplicationContext(ApplicationContext applicationContext)
void	setAuditManagementService(AuditManagementService auditManagementService)
void	setAuditService(AuditService auditService)
void	setChangeTenantIdManager(ChangeTenantIdManager changeTenantIdManager)
AuditEngineConfiguration	setDataSource(DataSource dataSource)
void	setDeploymentMode(String deploymentMode)
void	setDeploymentName(String deploymentName)
void	setDeploymentResources(Resource[] deploymentResources)
void	setTransactionManager(PlatformTransactionManager transactionManager)
void	setTransactionSynchronizationAdapterOrder(Integer transactionSynchronizationAdapterOrder)
void	start()
void	stop()

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

buildEngine, getPostEngineBuildConsumer, initPostEngineBuildConsumer, isRunPostEngineBuildConsumer, setPostEngineBuildConsumer, setRunPostEngineBuildConsumer

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

addAdditionalSchemaManager, addAgendaOperationExecutionListener, addConfigurator, addCustomPostCommandInterceptor, addCustomPreCommandInterceptor, addCustomSessionFactory, addEngineConfiguration, addEngineLifecycleListener, addEventRegistryEventConsumer, addServiceConfiguration, addSessionFactory, applyCustomMybatisCustomizations, close, configuratorsAfterInit, configuratorsBeforeInit, createDbSqlSessionFactory, defaultInitDbSqlSessionFactoryEntitySettings, defaultInitDbSqlSessionFactoryEntitySettings, getAdditionalDefaultCommandInterceptors, getAdditionalEventDispatchActions, getAdditionalSchemaManagers, getAgendaOperationExecutionListeners, getAgendaOperationRunner, getAllConfigurators, getBeans, getByteArrayDataManager, getByteArrayEntityManager, getClassLoader, getClock, getCommandContextFactory, getCommandExecutor, getCommandInterceptors, getCommandInvoker, getCommonSchemaManager, getConfigurators, getCustomMybatisInterceptors, getCustomMybatisMappers, getCustomMybatisXMLMappers, getCustomPostCommandInterceptors, getCustomPostDeployers, getCustomPreCommandInterceptors, getCustomPreDeployers, getCustomSessionFactories, getDatabaseCatalog, getDatabaseSchema, getDatabaseSchemaUpdate, getDatabaseTablePrefix, getDatabaseType, getDatabaseWildcardEscapeCharacter, getDataSource, getDataSourceJndiName, getDbSqlSessionFactory, getDefaultCommandConfig, getDefaultCommandInterceptors, getDefaultDatabaseTypeMappings, getDefaultTenantProvider, getDependentEngineMybatisTypeAliasConfigs, getDependentEngineMybatisTypeHandlerConfigs, getDependentEngineMyBatisXmlMappers, getDeployers, getEngineConfigurations, getEngineLifecycleListeners, getEngineSpecificEngineConfigurators, getEventDispatcher, getEventListeners, getEventRegistryConfigurator, getEventRegistryEventConsumers, getIdGenerator, getIdmEngineConfigurator, getJdbcDefaultTransactionIsolationLevel, getJdbcDriver, getJdbcMaxActiveConnections, getJdbcMaxCheckoutTime, getJdbcMaxIdleConnections, getJdbcMaxWaitTime, getJdbcPassword, getJdbcPingConnectionNotUsedFor, getJdbcPingQuery, getJdbcUrl, getJdbcUsername, getLockManager, getLockPollRate, getLoggingListener, getMaxLengthString, getMaxLengthStringVariableType, getMaxNrOfStatementsInBulkInsert, getMybatisMappingFile, getObjectMapper, getPropertyDataManager, getPropertyEntityManager, getResourceAsStream, getSchemaCommandConfig, getSchemaLockWaitTime, getSchemaManagementCmd, getSchemaManager, getServiceConfigurations, getSessionFactories, getSqlSessionFactory, getTableDataManager, getTransactionContextFactory, getTransactionFactory, getTypedEventListeners, getXmlEncoding, initAdditionalEventDispatchActions, initBeans, initClock, initCommandContextFactory, initCommandExecutor, initCommandExecutors, initCommandInterceptors, initCommandInvoker, initConfigurators, initCustomMybatisInterceptors, initCustomMybatisMappers, initDatabaseType, initDataSource, initDbSqlSessionFactory, initEngineConfigurations, initEventDispatcher, initEventListeners, initIdGenerator, initInterceptorChain, initMybatisConfiguration, initMyBatisLogSqlExecutionTimePlugin, initObjectMapper, initSchemaCommandConfig, initSchemaManagementCommand, initSchemaManager, initSchemaManagerDatabaseConfigurationSessionFactory, initService, initSessionFactories, initSqlSessionFactory, initTransactionFactory, initTypedEventListeners, isAlwaysLookupLatestDefinitionVersion, isBulkInsertEnabled, isDbHistoryUsed, isEnableConfiguratorServiceLoader, isEnableEventDispatcher, isEnableLogSqlExecutionTime, isFallbackToDefaultTenant, isForceCloseMybatisConnectionPool, isJdbcPingEnabled, isLoggingSessionEnabled, isTablePrefixIsSchema, isTransactionsExternallyManaged, isUseClassForNameClassLoading, isUseLockForDatabaseSchemaUpdate, isUsePrefixId, isUsingRelationalDatabase, isUsingSchemaMgmt, parseCustomMybatisXMLMappers, parseDependentEngineMybatisXMLMappers, parseMybatisConfiguration, parseMybatisXmlMapping, pathToEngineDbProperties, setAdditionalEventDispatchActions, setAgendaOperationExecutionListeners, setAgendaOperationRunner, setAlwaysLookupLatestDefinitionVersion, setBeans, setBulkInsertEnabled, setByteArrayDataManager, setByteArrayEntityManager, setClassLoader, setClock, setCommandContextFactory, setCommandExecutor, setCommandInterceptors, setCommandInvoker, setCommonSchemaManager, setConfigurators, setCustomMybatisInterceptors, setCustomMybatisMappers, setCustomMybatisXMLMappers, setCustomPostCommandInterceptors, setCustomPostDeployers, setCustomPreCommandInterceptors, setCustomPreDeployers, setCustomSessionFactories, setDatabaseCatalog, setDatabaseSchema, setDatabaseSchemaUpdate, setDatabaseTablePrefix, setDatabaseType, setDatabaseWildcardEscapeCharacter, setDataSourceJndiName, setDbHistoryUsed, setDbSqlSessionFactory, setDefaultCommandConfig, setDefaultCommandInterceptors, setDefaultTenantProvider, setDefaultTenantValue, setDependentEngineMybatisTypeAliasConfigs, setDependentEngineMybatisTypeHandlerConfigs, setDependentEngineMyBatisXmlMappers, setDeployers, setEnableConfiguratorServiceLoader, setEnableEventDispatcher, setEnableLogSqlExecutionTime, setEngineConfigurations, setEngineLifecycleListeners, setEventDispatcher, setEventListeners, setEventRegistryConfigurator, setEventRegistryEventConsumers, setFallbackToDefaultTenant, setForceCloseMybatisConnectionPool, setIdGenerator, setIdmEngineConfigurator, setJdbcDefaultTransactionIsolationLevel, setJdbcDriver, setJdbcMaxActiveConnections, setJdbcMaxCheckoutTime, setJdbcMaxIdleConnections, setJdbcMaxWaitTime, setJdbcPassword, setJdbcPingConnectionNotUsedFor, setJdbcPingEnabled, setJdbcPingQuery, setJdbcUrl, setJdbcUsername, setLockPollRate, setLoggingListener, setMaxLengthStringVariableType, setMaxNrOfStatementsInBulkInsert, setMybatisMappingFile, setObjectMapper, setPropertyDataManager, setPropertyEntityManager, setSchemaCommandConfig, setSchemaLockWaitTime, setSchemaManagementCmd, setSchemaManager, setServiceConfigurations, setSessionFactories, setSqlSessionFactory, setTableDataManager, setTablePrefixIsSchema, setTransactionContextFactory, setTransactionFactory, setTransactionsExternallyManaged, setTypedEventListeners, setUseClassForNameClassLoading, setUseLockForDatabaseSchemaUpdate, setUsePrefixId, setUsingRelationalDatabase, setUsingSchemaMgmt, setXmlEncoding

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.spring.SpringEngineConfiguration

getBeans, getPhase, isAutoStartup, stop

Field Details

DEFAULT_MYBATIS_MAPPING_FILE

public static final String DEFAULT_MYBATIS_MAPPING_FILE

See Also:

• Constant Field Values

DEFAULT_ENGINE_NAME

public static final String DEFAULT_ENGINE_NAME

See Also:

• Constant Field Values

KEY_AUDIT_ENGINE_CONFIG

public static final String KEY_AUDIT_ENGINE_CONFIG

See Also:

• Constant Field Values

actionEngineName

protected String actionEngineName

auditService

protected AuditService auditService

auditManagementService

protected AuditManagementService auditManagementService

changeTenantIdManager

protected ChangeTenantIdManager changeTenantIdManager

dataManagers

protected final AuditDataManagers dataManagers

entityManagers

protected final AuditEntityManagers entityManagers

transactionManager

protected PlatformTransactionManager transactionManager

transactionSynchronizationAdapterOrder

protected Integer transactionSynchronizationAdapterOrder

applicationContext

protected ApplicationContext applicationContext

running

protected volatile boolean running

enginesBuild

protected List<String> enginesBuild

Constructor Details

AuditEngineConfiguration

public AuditEngineConfiguration()

Method Details

getEngineCfgKey

public String getEngineCfgKey()

Specified by:

getEngineCfgKey in class AbstractEngineConfiguration

getEngineScopeType

public String getEngineScopeType()

Specified by:

getEngineScopeType in class AbstractEngineConfiguration

createTransactionInterceptor

public CommandInterceptor createTransactionInterceptor()

Specified by:

createTransactionInterceptor in class AbstractEngineConfiguration

initDbSqlSessionFactoryEntitySettings

protected void initDbSqlSessionFactoryEntitySettings()

Specified by:

initDbSqlSessionFactoryEntitySettings in class AbstractEngineConfiguration

getMyBatisXmlConfigurationStream

public InputStream getMyBatisXmlConfigurationStream()

Specified by:

getMyBatisXmlConfigurationStream in class AbstractEngineConfiguration

getEngineName

public String getEngineName()

Specified by:

getEngineName in class AbstractEngineConfiguration

setTransactionSynchronizationAdapterOrder

public void setTransactionSynchronizationAdapterOrder(Integer transactionSynchronizationAdapterOrder)

getDataManagers

public AuditDataManagers getDataManagers()

getEntityManagers

public AuditEntityManagers getEntityManagers()

setDataSource

public AuditEngineConfiguration setDataSource(DataSource dataSource)

Overrides:

setDataSource in class AbstractEngineConfiguration

buildAuditEngine

public AuditEngine buildAuditEngine()

createEngine

protected AuditEngine createEngine()

Specified by:

createEngine in class AbstractBuildableEngineConfiguration<AuditEngine>

createPostEngineBuildConsumer

protected Consumer<AuditEngine> createPostEngineBuildConsumer()

Specified by:

createPostEngineBuildConsumer in class AbstractBuildableEngineConfiguration<AuditEngine>

init

protected void init()

Specified by:

init in class AbstractBuildableEngineConfiguration<AuditEngine>

initServices

protected void initServices()

initChangeTenantIdManager

public void initChangeTenantIdManager()

initTransactionContextFactory

public void initTransactionContextFactory()

Overrides:

initTransactionContextFactory in class AbstractEngineConfiguration

initDefaultCommandConfig

public void initDefaultCommandConfig()

Overrides:

initDefaultCommandConfig in class AbstractEngineConfiguration

initMybatisTypeHandlers

public void initMybatisTypeHandlers(org.apache.ibatis.session.Configuration configuration)

Overrides:

initMybatisTypeHandlers in class AbstractEngineConfiguration

initDataManagers

public void initDataManagers()

Overrides:

initDataManagers in class AbstractEngineConfiguration

initEntityManagers

public void initEntityManagers()

Overrides:

initEntityManagers in class AbstractEngineConfiguration

createEngineSchemaManager

protected SchemaManager createEngineSchemaManager()

Specified by:

createEngineSchemaManager in class AbstractEngineConfiguration

getTransactionManager

public PlatformTransactionManager getTransactionManager()

Specified by:

getTransactionManager in interface SpringEngineConfiguration

setTransactionManager

public void setTransactionManager(PlatformTransactionManager transactionManager)

Specified by:

setTransactionManager in interface SpringEngineConfiguration

getApplicationContext

public ApplicationContext getApplicationContext()

Specified by:

getApplicationContext in interface SpringEngineConfiguration

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface ApplicationContextAware

Specified by:

setApplicationContext in interface SpringEngineConfiguration

getActionEngineName

public String getActionEngineName()

setActionEngineName

public void setActionEngineName(String actionEngineName)

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

getAuditService

public AuditService getAuditService()

Description copied from interface: AuditEngineConfigurationApi

Returns the audit service where audit entries can be created and retrieved.

Specified by:

getAuditService in interface AuditEngineConfigurationApi

setAuditService

public void setAuditService(AuditService auditService)

getAuditManagementService

public AuditManagementService getAuditManagementService()

Specified by:

getAuditManagementService in interface AuditEngineConfigurationApi

setAuditManagementService

public void setAuditManagementService(AuditManagementService auditManagementService)

getChangeTenantIdManager

public ChangeTenantIdManager getChangeTenantIdManager()

setChangeTenantIdManager

public void setChangeTenantIdManager(ChangeTenantIdManager changeTenantIdManager)

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

getDeploymentName

public String getDeploymentName()

Specified by:

getDeploymentName in interface SpringEngineConfiguration

setDeploymentName

public void setDeploymentName(String deploymentName)

Specified by:

setDeploymentName in interface SpringEngineConfiguration

getDeploymentResources

public Resource[] getDeploymentResources()

Specified by:

getDeploymentResources in interface SpringEngineConfiguration

setDeploymentResources

public void setDeploymentResources(Resource[] deploymentResources)

Specified by:

setDeploymentResources in interface SpringEngineConfiguration

getDeploymentMode

public String getDeploymentMode()

Specified by:

getDeploymentMode in interface SpringEngineConfiguration

setDeploymentMode

public void setDeploymentMode(String deploymentMode)

Specified by:

setDeploymentMode in interface SpringEngineConfiguration