org.flowable.form.spring

Class SpringFormEngineConfiguration

java.lang.Object

org.flowable.common.engine.impl.AbstractEngineConfiguration

org.flowable.form.engine.FormEngineConfiguration

org.flowable.form.spring.SpringFormEngineConfiguration

All Implemented Interfaces:

org.flowable.common.engine.impl.HasExpressionManagerEngineConfiguration, SpringEngineConfiguration, org.flowable.form.api.FormEngineConfigurationApi, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

public class SpringFormEngineConfiguration
extends FormEngineConfiguration
implements SpringEngineConfiguration

Author:

Tijs Rademakers, David Syer, Joram Barrez

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	applicationContext
protected String	deploymentMode
protected String	deploymentName
protected org.springframework.core.io.Resource[]	deploymentResources
protected List<String>	enginesBuild
protected Object	lifeCycleMonitor
protected boolean	running
protected org.springframework.transaction.PlatformTransactionManager	transactionManager
protected Integer	transactionSynchronizationAdapterOrder

Fields inherited from class org.flowable.form.engine.FormEngineConfiguration

cachingAndArtifactsManager, customPostDeployers, customPreDeployers, DEFAULT_MYBATIS_MAPPING_FILE, deployers, deploymentDataManager, deploymentEntityManager, deploymentManager, expressionManager, formDefinitionCache, formDefinitionCacheLimit, formDefinitionDataManager, formDefinitionEntityManager, formDeployer, formDeploymentHelper, formEngineName, formInstanceDataManager, formInstanceEntityManager, formJsonConverter, formManagementService, formParseFactory, formRepositoryService, formService, LIQUIBASE_CHANGELOG_PREFIX, parsedDeploymentBuilderFactory, resourceDataManager, resourceEntityManager

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

additionalEventDispatchActions, agendaOperationRunner, allConfigurators, alwaysLookupLatestDefinitionVersion, beans, byteArrayDataManager, byteArrayEntityManager, classLoader, clock, commandContextFactory, commandExecutor, commandInterceptors, commandInvoker, commonSchemaManager, configurators, customMybatisInterceptors, customMybatisMappers, customMybatisXMLMappers, customPostCommandInterceptors, customPreCommandInterceptors, 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, 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.flowable.common.spring.SpringEngineConfiguration

PHASE, PHASE_DELTA

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor and Description
SpringFormEngineConfiguration()

Method Summary

Modifier and Type	Method and Description
protected void	autoDeployResources(FormEngine formEngine)
FormEngine	buildFormEngine()
org.flowable.common.engine.impl.interceptor.CommandInterceptor	createTransactionInterceptor()
org.springframework.context.ApplicationContext	getApplicationContext()
protected AutoDeploymentStrategy<FormEngine>	getAutoDeploymentStrategy(String mode) Gets the AutoDeploymentStrategy for the provided mode.
String	getDeploymentMode()
String	getDeploymentName()
org.springframework.core.io.Resource[]	getDeploymentResources()
Collection<AutoDeploymentStrategy<FormEngine>>	getDeploymentStrategies()
int	getPhase()
org.springframework.transaction.PlatformTransactionManager	getTransactionManager()
void	initDefaultCommandConfig()
void	initTransactionContextFactory()
boolean	isRunning()
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
FormEngineConfiguration	setDataSource(DataSource dataSource)
void	setDeploymentMode(String deploymentMode)
void	setDeploymentName(String deploymentName)
void	setDeploymentResources(org.springframework.core.io.Resource[] deploymentResources)
void	setDeploymentStrategies(Collection<AutoDeploymentStrategy<FormEngine>> deploymentStrategies)
void	setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)
void	setTransactionSynchronizationAdapterOrder(Integer transactionSynchronizationAdapterOrder)
void	start()
void	stop()

Methods inherited from class org.flowable.form.engine.FormEngineConfiguration

createDbSqlSessionFactory, createFormEngineConfigurationFromInputStream, createFormEngineConfigurationFromInputStream, createFormEngineConfigurationFromResource, createFormEngineConfigurationFromResource, createFormEngineConfigurationFromResourceDefault, createStandaloneFormEngineConfiguration, createStandaloneInMemFormEngineConfiguration, getDefaultDeployers, getDeploymentDataManager, getDeploymentEntityManager, getDeploymentManager, getEngineCfgKey, getEngineName, getEngineScopeType, getExpressionManager, getFormCacheLimit, getFormDefinitionCache, getFormDefinitionDataManager, getFormDefinitionEntityManager, getFormDeployer, getFormEngineConfiguration, getFormInstanceDataManager, getFormInstanceEntityManager, getFormJsonConverter, getFormManagementService, getFormParseFactory, getFormRepositoryService, getFormService, getMyBatisXmlConfigurationStream, getResourceDataManager, getResourceEntityManager, init, initCommandExecutors, initCommandInterceptors, initDataManagers, initDbSqlSessionFactory, initDbSqlSessionFactoryEntitySettings, initDeployers, initDmnDeployerDependencies, initEntityManagers, initExpressionManager, initSchemaManagementCommand, initSchemaManager, initServices, setDeploymentDataManager, setDeploymentEntityManager, setEngineName, setExpressionManager, setFormDefinitionCache, setFormDefinitionCacheLimit, setFormDefinitionDataManager, setFormDefinitionEntityManager, setFormDeployer, setFormInstanceDataManager, setFormInstanceEntityManager, setFormJsonConverter, setFormManagementService, setFormParseFactory, setFormRepositoryService, setFormService, setResourceDataManager, setResourceEntityManager, setTableDataManager

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

addConfigurator, addCustomSessionFactory, addEngineConfiguration, addEngineLifecycleListener, addEventRegistryEventConsumer, addServiceConfiguration, addSessionFactory, close, configuratorsAfterInit, configuratorsBeforeInit, defaultInitDbSqlSessionFactoryEntitySettings, getAdditionalDefaultCommandInterceptors, getAdditionalEventDispatchActions, 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, getDefaultTenantValue, 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, initCommandInvoker, initConfigurators, initCustomMybatisInterceptors, initCustomMybatisMappers, initDatabaseType, initDataSource, initEngineConfigurations, initEventDispatcher, initEventListeners, initIdGenerator, initInterceptorChain, initMybatisConfiguration, initMyBatisLogSqlExecutionTimePlugin, initMybatisTypeHandlers, initSchemaCommandConfig, 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, 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, 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, isAutoStartup, stop

Field Detail

transactionManager

protected org.springframework.transaction.PlatformTransactionManager transactionManager

deploymentName

protected String deploymentName

deploymentResources

protected org.springframework.core.io.Resource[] deploymentResources

deploymentMode

protected String deploymentMode

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

transactionSynchronizationAdapterOrder

protected Integer transactionSynchronizationAdapterOrder

running

protected volatile boolean running

enginesBuild

protected List<String> enginesBuild

lifeCycleMonitor

protected final Object lifeCycleMonitor

Constructor Detail

SpringFormEngineConfiguration

public SpringFormEngineConfiguration()

Method Detail

buildFormEngine

public FormEngine buildFormEngine()

Overrides:

buildFormEngine in class FormEngineConfiguration

setTransactionSynchronizationAdapterOrder

public void setTransactionSynchronizationAdapterOrder(Integer transactionSynchronizationAdapterOrder)

initDefaultCommandConfig

public void initDefaultCommandConfig()

Overrides:

initDefaultCommandConfig in class org.flowable.common.engine.impl.AbstractEngineConfiguration

createTransactionInterceptor

public org.flowable.common.engine.impl.interceptor.CommandInterceptor createTransactionInterceptor()

Overrides:

createTransactionInterceptor in class FormEngineConfiguration

initTransactionContextFactory

public void initTransactionContextFactory()

Overrides:

initTransactionContextFactory in class org.flowable.common.engine.impl.AbstractEngineConfiguration

autoDeployResources

protected void autoDeployResources(FormEngine formEngine)

setDataSource

public FormEngineConfiguration setDataSource(DataSource dataSource)

Overrides:

setDataSource in class org.flowable.common.engine.impl.AbstractEngineConfiguration

getTransactionManager

public org.springframework.transaction.PlatformTransactionManager getTransactionManager()

Specified by:

getTransactionManager in interface SpringEngineConfiguration

setTransactionManager

public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)

Specified by:

setTransactionManager in interface SpringEngineConfiguration

getDeploymentName

public String getDeploymentName()

Specified by:

getDeploymentName in interface SpringEngineConfiguration

setDeploymentName

public void setDeploymentName(String deploymentName)

Specified by:

setDeploymentName in interface SpringEngineConfiguration

getDeploymentResources

public org.springframework.core.io.Resource[] getDeploymentResources()

Specified by:

getDeploymentResources in interface SpringEngineConfiguration

setDeploymentResources

public void setDeploymentResources(org.springframework.core.io.Resource[] deploymentResources)

Specified by:

setDeploymentResources in interface SpringEngineConfiguration

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

Specified by:

getApplicationContext in interface SpringEngineConfiguration

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface SpringEngineConfiguration

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

getDeploymentMode

public String getDeploymentMode()

Specified by:

getDeploymentMode in interface SpringEngineConfiguration

setDeploymentMode

public void setDeploymentMode(String deploymentMode)

Specified by:

setDeploymentMode in interface SpringEngineConfiguration

getAutoDeploymentStrategy

protected AutoDeploymentStrategy<FormEngine> getAutoDeploymentStrategy(String mode)

Gets the AutoDeploymentStrategy for the provided mode. This method may be overridden to implement custom deployment strategies if required, but implementors should take care not to return null.

Parameters:

mode - the mode to get the strategy for

Returns:

the deployment strategy to use for the mode. Never null

getDeploymentStrategies

public Collection<AutoDeploymentStrategy<FormEngine>> getDeploymentStrategies()

setDeploymentStrategies

public void setDeploymentStrategies(Collection<AutoDeploymentStrategy<FormEngine>> deploymentStrategies)

start

public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface SpringEngineConfiguration

Specified by:

getPhase in interface org.springframework.context.Phased

Specified by:

getPhase in interface org.springframework.context.SmartLifecycle