EngageEngineConfiguration (Flowable Engage 3.10.0)

java.lang.Object
- org.flowable.common.engine.impl.AbstractEngineConfiguration
- - com.flowable.engage.engine.EngageEngineConfiguration

All Implemented Interfaces:

EngageEngineConfigurationApi, HasVariableTypes, SpringEngineConfiguration, Aware, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle
```
public class EngageEngineConfiguration
extends AbstractEngineConfiguration
implements SpringEngineConfiguration, EngageEngineConfigurationApi, HasVariableTypes
```
Author:

Filip Hrisafov

Field Summary

Fields
Modifier and Type	Field and Description
`protected ApplicationContext`	`applicationContext`
`protected boolean`	`asyncHistoryEnabled`
`protected AsyncExecutor`	`asyncHistoryExecutor`
`protected boolean`	`asyncHistoryExecutorActivate`
`protected boolean`	`asyncHistoryExecutorAsyncJobAcquisitionEnabled`
`protected int`	`asyncHistoryExecutorAsyncJobLockTimeInMillis`
`protected int`	`asyncHistoryExecutorDefaultAsyncJobAcquireWaitTime`
`protected int`	`asyncHistoryExecutorDefaultQueueSizeFullWaitTime`
`protected String`	`asyncHistoryExecutorLockOwner`
`protected boolean`	`asyncHistoryExecutorMessageQueueMode`
`protected int`	`asyncHistoryExecutorNumberOfRetries`
`protected boolean`	`asyncHistoryExecutorResetExpiredJobsEnabled`
`protected int`	`asyncHistoryExecutorResetExpiredJobsInterval`
`protected int`	`asyncHistoryExecutorResetExpiredJobsPageSize`
`protected int`	`asyncHistoryExecutorSecondsToWaitOnShutdown`
`protected int`	`asyncHistoryJsonGroupingThreshold`
`protected AsyncHistoryListener`	`asyncHistoryListener`
`protected DeploymentCache<ConversationDefinitionModel>`	`conversationDefinitionModelCache`
`protected int`	`conversationDefinitionModelCacheLimit`
`protected ConversationDefinitionModelManager`	`conversationDefinitionModelManager`
`protected ConversationDefinitionService`	`conversationDefinitionService`
`protected Resource[]`	`conversationFilterDefinitions`
`protected ConversationFilterFactory`	`conversationFilterFactory`
`protected ConversationFilterService`	`conversationFilterService`
`protected ConversationIndexingService`	`conversationIndexingService`
`protected ConversationIndexQueryService`	`conversationIndexQueryService`
`protected ConversationNotificationService`	`conversationNotificationService`
`protected ConversationPermissionService`	`conversationPermissionService`
`protected ConversationQueryTemplateHandler`	`conversationQueryTemplateHandler`
`protected ConversationRegistryEntryService`	`conversationRegistryEntryService`
`protected ConversationResultMapper`	`conversationResultMapper`
`protected ConversationService`	`conversationService`
`protected ConversationStarterHelper`	`conversationStarterHelper`
`protected List<ConversationTagProvider>`	`conversationTagProviders`
`protected List<HistoryJobHandler>`	`customHistoryJobHandlers`
`protected List<HistoryJsonTransformer>`	`customHistoryJsonTransformers`
`protected List<VariableType>`	`customPostVariableTypes`
`protected List<VariableType>`	`customPreVariableTypes`
`protected EngageDataManagers`	`dataManagers`
`protected String`	`decisionKeyArchiveConversationPermissions`
`protected String`	`decisionKeyCreateConversationPermissions`
`protected String`	`decisionKeyDefaultPermissions`
`protected String`	`decisionKeyDropParticipantPermissions`
`protected String`	`decisionKeyEditMessagePermissions`
`protected String`	`decisionKeyInviteParticipantPermissions`
`protected String`	`decisionKeyJoinParticipantPermissions`
`protected String`	`decisionKeyPostDocumentPermissions`
`protected String`	`decisionKeyPostImagePermissions`
`protected String`	`decisionKeyPostMessagePermissions`
`protected String`	`decisionKeyPostVideoMessagePermissions`
`protected String`	`decisionKeyPostVoiceMessagePermissions`
`protected String`	`decisionKeyReopenConversationPermissions`
`static String`	`DEFAULT_ENGINE_NAME`
`static String`	`DEFAULT_MYBATIS_MAPPING_FILE`
`protected String`	`deploymentMode`
`protected String`	`deploymentName`
`protected Resource[]`	`deploymentResources`
`protected Collection<AutoDeploymentStrategy<EngageEngine>>`	`deploymentStrategies`
`protected DeskService`	`deskService`
`protected DeviceService`	`deviceService`
`protected String`	`engageEngineName`
`protected EngageIndexingScheduler`	`engageIndexingScheduler`
`protected List<String>`	`enginesBuild`
`protected EngageEntityManagers`	`entityManagers`
`protected ExternalConversationService`	`externalConversationService`
`protected Map<String,ExternalConversationSystemAdapter>`	`externalConversationSystemAdapters`
`protected ExternalMessageSendHelper`	`externalMessageSendHelper`
`protected Map<String,HistoryJobHandler>`	`historyJobHandlers`
`protected IdentityLinkServiceConfiguration`	`identityLinkServiceConfiguration`
`protected boolean`	`indexingEnabled`
`protected IndexingService`	`indexingService`
`protected IndexManager`	`indexManager`
`protected boolean`	`isAsyncHistoryJsonGroupingEnabled`
`protected boolean`	`isAsyncHistoryJsonGzipCompressionEnabled`
`static String`	`JOB_EXECUTION_SCOPE`
`protected String`	`jobExecutionScope`
`protected JobServiceConfiguration`	`jobServiceConfiguration`
`protected boolean`	`jsonVariableTypeTrackObjects` This flag determines whether variables of the type 'json' and 'longJson' will be tracked.
`static String`	`KEY_ENGAGE_ENGINE_CONFIG`
`protected Object`	`lifeCycleMonitor`
`static String`	`LIQUIBASE_CHANGELOG_PREFIX`
`protected MessageComplianceResultMapper`	`messageComplianceResultMapper`
`protected MessageIndexQueryService`	`messageIndexQueryService`
`protected MessageResultMapper`	`messageResultMapper`
`protected MessageSendHelper`	`messageSendHelper`
`protected MessageService`	`messageService`
`protected boolean`	`multiTenantEnabled`
`protected NotificationEvaluationProvider`	`notificationEvaluationProvider`
`protected ReindexManager`	`reindexManager`
`protected boolean`	`running`
`protected SearchService`	`searchService`
`protected boolean`	`serializableVariableTypeTrackDeserializedObjects`
`protected TaskExecutor`	`taskExecutor`
`protected String`	`templateFilterLocation`
`protected TemplateLoader`	`templateLoader`
`protected TemporaryMessageHandler`	`temporaryMessageHandler`
`protected List<TemporaryMessageProcessor>`	`temporaryMessageProcessors`
`protected PlatformTransactionManager`	`transactionManager`
`protected Integer`	`transactionSynchronizationAdapterOrder`
`protected UserSubscriptionService`	`userSubscriptionService`
`protected VariableServiceConfiguration`	`variableServiceConfiguration`
`protected VariableTypes`	`variableTypes`

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, 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.flowable.common.spring.SpringEngineConfiguration
PHASE, PHASE_DELTA

Fields inherited from interface org.springframework.context.SmartLifecycle
DEFAULT_PHASE

Constructor Summary

Constructors
Constructor and Description

EngageEngineConfiguration()

Constructors
Constructor and Description
`EngageEngineConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EngageEngineConfiguration`	`addAutoDeploymentStrategy(AutoDeploymentStrategy<EngageEngine> autoDeploymentStrategy)`
`void`	`addEventListener(String type, FlowableEventListener eventListener)`
`void`	`addExternalConversationSystemAdapter(ExternalConversationSystemAdapter externalConversationSystemAdapter)`
`void`	`addTemporaryMessageProcessor(TemporaryMessageProcessor temporaryMessageProcessor)`
`protected void`	`autoDeployResources(EngageEngine engageEngine)`
`EngageEngine`	`buildEngageEngine()`
`void`	`configureJobServiceConfiguration()`
`CommandInterceptor`	`createTransactionInterceptor()`
`ApplicationContext`	`getApplicationContext()`
`AsyncExecutor`	`getAsyncHistoryExecutor()`
`int`	`getAsyncHistoryExecutorAsyncJobLockTimeInMillis()`
`int`	`getAsyncHistoryExecutorDefaultAsyncJobAcquireWaitTime()`
`int`	`getAsyncHistoryExecutorDefaultQueueSizeFullWaitTime()`
`String`	`getAsyncHistoryExecutorLockOwner()`
`int`	`getAsyncHistoryExecutorNumberOfRetries()`
`int`	`getAsyncHistoryExecutorResetExpiredJobsInterval()`
`int`	`getAsyncHistoryExecutorResetExpiredJobsPageSize()`
`int`	`getAsyncHistoryExecutorSecondsToWaitOnShutdown()`
`int`	`getAsyncHistoryJsonGroupingThreshold()`
`AsyncHistoryListener`	`getAsyncHistoryListener()`
`protected AutoDeploymentStrategy<EngageEngine>`	`getAutoDeploymentStrategy(String mode)` Gets the `AutoDeploymentStrategy` for the provided mode.
`DeploymentCache<ConversationDefinitionModel>`	`getConversationDefinitionModelCache()`
`int`	`getConversationDefinitionModelCacheLimit()`
`ConversationDefinitionModelManager`	`getConversationDefinitionModelManager()`
`ConversationDefinitionService`	`getConversationDefinitionService()`
`Resource[]`	`getConversationFilterDefinitions()`
`ConversationFilterFactory`	`getConversationFilterFactory()`
`ConversationFilterService`	`getConversationFilterService()`
`ConversationIndexingService`	`getConversationIndexingService()`
`ConversationIndexQueryService`	`getConversationIndexQueryService()`
`ConversationNotificationService`	`getConversationNotificationService()`
`ConversationPermissionService`	`getConversationPermissionService()`
`ConversationQueryTemplateHandler`	`getConversationQueryTemplateHandler()`
`ConversationRegistryEntryService`	`getConversationRegistryEntryService()`
`ConversationResultMapper`	`getConversationResultMapper()`
`ConversationService`	`getConversationService()`
`ConversationStarterHelper`	`getConversationStarterHelper()`
`List<ConversationTagProvider>`	`getConversationTagProviders()`
`List<HistoryJobHandler>`	`getCustomHistoryJobHandlers()`
`List<HistoryJsonTransformer>`	`getCustomHistoryJsonTransformers()`
`List<VariableType>`	`getCustomPostVariableTypes()`
`List<VariableType>`	`getCustomPreVariableTypes()`
`EngageDataManagers`	`getDataManagers()`
`String`	`getDecisionKeyArchiveConversationPermissions()`
`String`	`getDecisionKeyCreateConversationPermissions()`
`String`	`getDecisionKeyDefaultPermissions()`
`String`	`getDecisionKeyDropParticipantPermissions()`
`String`	`getDecisionKeyEditMessagePermissions()`
`String`	`getDecisionKeyInviteParticipantPermissions()`
`String`	`getDecisionKeyJoinParticipantPermissions()`
`String`	`getDecisionKeyPostDocumentPermissions()`
`String`	`getDecisionKeyPostImagePermissions()`
`String`	`getDecisionKeyPostMessagePermissions()`
`String`	`getDecisionKeyPostVideoMessagePermissions()`
`String`	`getDecisionKeyPostVoiceMessagePermissions()`
`String`	`getDecisionKeyReopenConversationPermissions()`
`String`	`getDeploymentMode()`
`String`	`getDeploymentName()`
`Resource[]`	`getDeploymentResources()`
`Collection<AutoDeploymentStrategy<EngageEngine>>`	`getDeploymentStrategies()`
`DeskService`	`getDeskService()`
`DeviceService`	`getDeviceService()`
`EngageIndexingScheduler`	`getEngageIndexingScheduler()`
`String`	`getEngineCfgKey()`
`String`	`getEngineName()`
`String`	`getEngineScopeType()`
`EngageEntityManagers`	`getEntityManagers()`
`ExternalConversationService`	`getExternalConversationService()`
`Map<String,ExternalConversationSystemAdapter>`	`getExternalConversationSystemAdapters()`
`ExternalMessageSendHelper`	`getExternalMessageSendHelper()`
`Map<String,HistoryJobHandler>`	`getHistoryJobHandlers()`
`IdentityLinkServiceConfiguration`	`getIdentityLinkServiceConfiguration()`
`IndexingService`	`getIndexingService()`
`IndexManager`	`getIndexManager()`
`String`	`getJobExecutionScope()`
`JobServiceConfiguration`	`getJobServiceConfiguration()`
`MessageIndexQueryService`	`getMessageIndexQueryService()`
`MessageResultMapper`	`getMessageResultMapper()`
`MessageSendHelper`	`getMessageSendHelper()`
`MessageService`	`getMessageService()`
`InputStream`	`getMyBatisXmlConfigurationStream()`
`NotificationEvaluationProvider`	`getNotificationEvaluationProvider()`
`int`	`getPhase()`
`ReindexManager`	`getReindexManager()`
`SearchService`	`getSearchService()`
`TaskExecutor`	`getTaskExecutor()`
`String`	`getTemplateFilterLocation()`
`TemplateLoader`	`getTemplateLoader()`
`TemporaryMessageHandler`	`getTemporaryMessageHandler()`
`List<TemporaryMessageProcessor>`	`getTemporaryMessageProcessors()`
`PlatformTransactionManager`	`getTransactionManager()`
`UserSubscriptionService`	`getUserSubscriptionService()`
`VariableServiceConfiguration`	`getVariableServiceConfiguration()`
`VariableTypes`	`getVariableTypes()`
`protected void`	`init()`
`protected void`	`initAsyncHistoryExecutor()`
`protected void`	`initAsyncHistorySessionFactory()`
`void`	`initConversationDefinitionModelCache()`
`void`	`initConversationDefinitionModelManager()`
`protected void`	`initConversationFilterFactory()`
`protected void`	`initConversationQueryTemplateHandler()`
`protected void`	`initConversationService()`
`void`	`initConversationStarterHelper()`
`void`	`initDataManagers()`
`protected void`	`initDbSqlSessionFactoryEntitySettings()`
`protected void`	`initDefaultAsyncHistoryListener()`
`void`	`initDefaultCommandConfig()`
`protected List<HistoryJsonTransformer>`	`initDefaultHistoryJsonTransformers()`
`void`	`initEngageIndexingScheduler()`
`void`	`initEntityManagers()`
`void`	`initEventDispatcher()`
`void`	`initExternalMessageSendHelper()`
`protected void`	`initHistoryJobHandlers()`
`void`	`initIdentityLinkServiceConfiguration()`
`void`	`initIndexQueryService()`
`void`	`initJobServiceConfiguration()`
`void`	`initMessageSendHelper()`
`void`	`initMybatisTypeHandlers(org.apache.ibatis.session.Configuration configuration)`
`void`	`initNotificationEvaluatorProvider()`
`protected void`	`initProviders()`
`void`	`initSchemaManagementCommand()`
`void`	`initSchemaManager()`
`protected void`	`initServices()`
`void`	`initSessionFactories()`
`protected void`	`initTaskExecutor()`
`void`	`initTemplateLoader()`
`void`	`initTemporaryMessageHandling()`
`void`	`initTransactionContextFactory()`
`void`	`initVariableServiceConfiguration()`
`void`	`initVariableTypes()`
`boolean`	`isAsyncHistoryEnabled()`
`boolean`	`isAsyncHistoryExecutorActivate()`
`boolean`	`isAsyncHistoryExecutorAsyncJobAcquisitionEnabled()`
`boolean`	`isAsyncHistoryExecutorMessageQueueMode()`
`boolean`	`isAsyncHistoryExecutorResetExpiredJobsEnabled()`
`boolean`	`isAsyncHistoryJsonGroupingEnabled()`
`boolean`	`isAsyncHistoryJsonGzipCompressionEnabled()`
`boolean`	`isIndexingEnabled()`
`boolean`	`isJsonVariableTypeTrackObjects()`
`boolean`	`isMultiTenantEnabled()`
`boolean`	`isRunning()`
`boolean`	`isSerializableVariableTypeTrackDeserializedObjects()`
`void`	`setApplicationContext(ApplicationContext applicationContext)`
`void`	`setAsyncHistoryEnabled(boolean asyncHistoryEnabled)`
`void`	`setAsyncHistoryExecutor(AsyncExecutor asyncHistoryExecutor)`
`void`	`setAsyncHistoryExecutorActivate(boolean asyncHistoryExecutorActivate)`
`void`	`setAsyncHistoryExecutorAsyncJobAcquisitionEnabled(boolean asyncHistoryExecutorAsyncJobAcquisitionEnabled)`
`void`	`setAsyncHistoryExecutorAsyncJobLockTimeInMillis(int asyncHistoryExecutorAsyncJobLockTimeInMillis)`
`void`	`setAsyncHistoryExecutorDefaultAsyncJobAcquireWaitTime(int asyncHistoryExecutorDefaultAsyncJobAcquireWaitTime)`
`void`	`setAsyncHistoryExecutorDefaultQueueSizeFullWaitTime(int asyncHistoryExecutorDefaultQueueSizeFullWaitTime)`
`void`	`setAsyncHistoryExecutorLockOwner(String asyncHistoryExecutorLockOwner)`
`void`	`setAsyncHistoryExecutorMessageQueueMode(boolean asyncHistoryExecutorMessageQueueMode)`
`void`	`setAsyncHistoryExecutorNumberOfRetries(int asyncHistoryExecutorNumberOfRetries)`
`void`	`setAsyncHistoryExecutorResetExpiredJobsEnabled(boolean asyncHistoryExecutorResetExpiredJobsEnabled)`
`void`	`setAsyncHistoryExecutorResetExpiredJobsInterval(int asyncHistoryExecutorResetExpiredJobsInterval)`
`void`	`setAsyncHistoryExecutorResetExpiredJobsPageSize(int asyncHistoryExecutorResetExpiredJobsPageSize)`
`void`	`setAsyncHistoryExecutorSecondsToWaitOnShutdown(int asyncHistoryExecutorSecondsToWaitOnShutdown)`
`void`	`setAsyncHistoryJsonGroupingEnabled(boolean asyncHistoryJsonGroupingEnabled)`
`void`	`setAsyncHistoryJsonGroupingThreshold(int asyncHistoryJsonGroupingThreshold)`
`void`	`setAsyncHistoryJsonGzipCompressionEnabled(boolean asyncHistoryJsonGzipCompressionEnabled)`
`void`	`setAsyncHistoryListener(AsyncHistoryListener asyncHistoryListener)`
`void`	`setConversationDefinitionModelCache(DeploymentCache<ConversationDefinitionModel> conversationDefinitionModelCache)`
`void`	`setConversationDefinitionModelCacheLimit(int conversationDefinitionModelCacheLimit)`
`void`	`setConversationDefinitionModelManager(ConversationDefinitionModelManager conversationDefinitionModelManager)`
`void`	`setConversationDefinitionService(ConversationDefinitionService conversationDefinitionService)`
`void`	`setConversationFilterDefinitions(Resource[] conversationFilterDefinitions)`
`void`	`setConversationFilterFactory(ConversationFilterFactory conversationFilterFactory)`
`void`	`setConversationFilterService(ConversationFilterService conversationFilterService)`
`void`	`setConversationIndexingService(ConversationIndexingService conversationIndexingService)`
`void`	`setConversationIndexQueryService(ConversationIndexQueryService conversationIndexQueryService)`
`void`	`setConversationNotificationService(ConversationNotificationService conversationNotificationService)`
`void`	`setConversationPermissionService(ConversationPermissionService conversationPermissionService)`
`void`	`setConversationQueryTemplateHandler(ConversationQueryTemplateHandler conversationQueryTemplateHandler)`
`void`	`setConversationRegistryEntryService(ConversationRegistryEntryService conversationRegistryEntryService)`
`void`	`setConversationResultMapper(ConversationResultMapper conversationResultMapper)`
`void`	`setConversationService(ConversationService conversationService)`
`void`	`setConversationStarterHelper(ConversationStarterHelper conversationStarterHelper)`
`void`	`setConversationTagProviders(List<ConversationTagProvider> conversationTagProviders)`
`void`	`setCustomHistoryJobHandlers(List<HistoryJobHandler> customHistoryJobHandlers)`
`void`	`setCustomHistoryJsonTransformers(List<HistoryJsonTransformer> customHistoryJsonTransformers)`
`void`	`setCustomPostVariableTypes(List<VariableType> customPostVariableTypes)`
`void`	`setCustomPreVariableTypes(List<VariableType> customPreVariableTypes)`
`EngageEngineConfiguration`	`setDataSource(DataSource dataSource)`
`void`	`setDecisionKeyArchiveConversationPermissions(String decisionKeyArchiveConversationPermissions)`
`void`	`setDecisionKeyCreateConversationPermissions(String decisionKeyCreateConversationPermissions)`
`void`	`setDecisionKeyDefaultPermissions(String decisionKeyDefaultPermissions)`
`void`	`setDecisionKeyDropParticipantPermissions(String decisionKeyDropParticipantPermissions)`
`void`	`setDecisionKeyEditMessagePermissions(String decisionKeyEditMessagePermissions)`
`void`	`setDecisionKeyInviteParticipantPermissions(String decisionKeyInviteParticipantPermissions)`
`void`	`setDecisionKeyJoinParticipantPermissions(String decisionKeyJoinParticipantPermissions)`
`void`	`setDecisionKeyPostDocumentPermissions(String decisionKeyPostDocumentPermissions)`
`void`	`setDecisionKeyPostImagePermissions(String decisionKeyPostImagePermissions)`
`void`	`setDecisionKeyPostMessagePermissions(String decisionKeyPostMessagePermissions)`
`void`	`setDecisionKeyPostVideoMessagePermissions(String decisionKeyPostVideoMessagePermissions)`
`void`	`setDecisionKeyPostVoiceMessagePermissions(String decisionKeyPostVoiceMessagePermissions)`
`void`	`setDecisionKeyReopenConversationPermissions(String decisionKeyReopenConversationPermissions)`
`void`	`setDeploymentMode(String deploymentMode)`
`void`	`setDeploymentName(String deploymentName)`
`void`	`setDeploymentResources(Resource[] deploymentResources)`
`void`	`setDeploymentStrategies(Collection<AutoDeploymentStrategy<EngageEngine>> deploymentStrategies)`
`void`	`setDeskService(DeskService deskService)`
`void`	`setDeviceService(DeviceService deviceService)`
`void`	`setEngageIndexingScheduler(EngageIndexingScheduler engageIndexingScheduler)`
`void`	`setExternalConversationService(ExternalConversationService externalConversationService)`
`void`	`setExternalMessageSendHelper(ExternalMessageSendHelper externalMessageSendHelper)`
`void`	`setHistoryJobHandlers(Map<String,HistoryJobHandler> historyJobHandlers)`
`void`	`setIdentityLinkServiceConfiguration(IdentityLinkServiceConfiguration identityLinkServiceConfiguration)`
`void`	`setIndexingEnabled(boolean indexingEnabled)`
`void`	`setIndexingService(IndexingService indexingService)`
`void`	`setIndexManager(IndexManager indexManager)`
`void`	`setJobExecutionScope(String jobExecutionScope)`
`void`	`setJobServiceConfiguration(JobServiceConfiguration jobServiceConfiguration)`
`void`	`setJsonVariableTypeTrackObjects(boolean jsonVariableTypeTrackObjects)`
`void`	`setMessageIndexQueryService(MessageIndexQueryService messageIndexQueryService)`
`void`	`setMessageResultMapper(MessageResultMapper messageResultMapper)`
`void`	`setMessageSendHelper(MessageSendHelper messageSendHelper)`
`void`	`setMessageService(MessageService messageService)`
`void`	`setMultiTenantEnabled(boolean multiTenantEnabled)`
`void`	`setNotificationEvaluationProvider(NotificationEvaluationProvider notificationEvaluationProvider)`
`void`	`setReindexManager(ReindexManager reindexManager)`
`void`	`setSearchService(SearchService searchService)`
`void`	`setSerializableVariableTypeTrackDeserializedObjects(boolean serializableVariableTypeTrackDeserializedObjects)`
`void`	`setTaskExecutor(TaskExecutor taskExecutor)`
`void`	`setTemplateFilterLocation(String templateFilterLocation)`
`void`	`setTemplateLoader(TemplateLoader templateLoader)`
`void`	`setTemporaryMessageHandler(TemporaryMessageHandler temporaryMessageHandler)`
`void`	`setTemporaryMessageProcessors(List<TemporaryMessageProcessor> temporaryMessageProcessors)`
`void`	`setTransactionManager(PlatformTransactionManager transactionManager)`
`void`	`setTransactionSynchronizationAdapterOrder(Integer transactionSynchronizationAdapterOrder)`
`void`	`setUserSubscriptionService(UserSubscriptionService userSubscriptionService)`
`void`	`setVariableServiceConfiguration(VariableServiceConfiguration variableServiceConfiguration)`
`EngageEngineConfiguration`	`setVariableTypes(VariableTypes variableTypes)`
`void`	`start()`
`void`	`stop()`

Methods inherited from class org.flowable.common.engine.impl.AbstractEngineConfiguration
addConfigurator, addCustomSessionFactory, addEngineConfiguration, addEngineLifecycleListener, addEventRegistryEventConsumer, addServiceConfiguration, addSessionFactory, close, configuratorsAfterInit, configuratorsBeforeInit, createDbSqlSessionFactory, 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, initCommandExecutors, initCommandInterceptors, initCommandInvoker, initConfigurators, initCustomMybatisInterceptors, initCustomMybatisMappers, initDatabaseType, initDataSource, initDbSqlSessionFactory, initEngineConfigurations, initEventListeners, initIdGenerator, initInterceptorChain, initMybatisConfiguration, initMyBatisLogSqlExecutionTimePlugin, initObjectMapper, initSchemaCommandConfig, initService, 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, 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, isAutoStartup, stop

Field Detail

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_ENGAGE_ENGINE_CONFIG

public static final String KEY_ENGAGE_ENGINE_CONFIG

See Also:: Constant Field Values

LIQUIBASE_CHANGELOG_PREFIX

public static final String LIQUIBASE_CHANGELOG_PREFIX

See Also:: Constant Field Values

engageEngineName
```
protected String engageEngineName
```

conversationService

protected ConversationService conversationService

conversationDefinitionService

protected ConversationDefinitionService conversationDefinitionService

messageService

protected MessageService messageService

userSubscriptionService

protected UserSubscriptionService userSubscriptionService

conversationNotificationService

protected ConversationNotificationService conversationNotificationService

externalConversationService

protected ExternalConversationService externalConversationService

deskService
```
protected DeskService deskService
```

conversationRegistryEntryService

protected ConversationRegistryEntryService conversationRegistryEntryService

conversationStarterHelper

protected ConversationStarterHelper conversationStarterHelper

messageSendHelper

protected MessageSendHelper messageSendHelper

externalMessageSendHelper

protected ExternalMessageSendHelper externalMessageSendHelper

notificationEvaluationProvider

protected NotificationEvaluationProvider notificationEvaluationProvider

conversationPermissionService

protected ConversationPermissionService conversationPermissionService

deviceService
```
protected DeviceService deviceService
```

temporaryMessageHandler

protected TemporaryMessageHandler temporaryMessageHandler

temporaryMessageProcessors

protected List<TemporaryMessageProcessor> temporaryMessageProcessors

indexingEnabled
```
protected boolean indexingEnabled
```

indexingService

protected IndexingService indexingService

reindexManager

protected ReindexManager reindexManager

indexManager
```
protected IndexManager indexManager
```

engageIndexingScheduler

protected EngageIndexingScheduler engageIndexingScheduler

externalConversationSystemAdapters

protected Map<String,ExternalConversationSystemAdapter> externalConversationSystemAdapters

conversationTagProviders

protected List<ConversationTagProvider> conversationTagProviders

dataManagers

protected final EngageDataManagers dataManagers

entityManagers

protected final EngageEntityManagers entityManagers

transactionManager

protected PlatformTransactionManager transactionManager

transactionSynchronizationAdapterOrder

protected Integer transactionSynchronizationAdapterOrder

applicationContext

protected ApplicationContext applicationContext

taskExecutor
```
protected TaskExecutor taskExecutor
```

running
```
protected volatile boolean running
```

deploymentName
```
protected String deploymentName
```

deploymentResources

protected Resource[] deploymentResources

deploymentMode
```
protected String deploymentMode
```

deploymentStrategies

protected Collection<AutoDeploymentStrategy<EngageEngine>> deploymentStrategies

enginesBuild
```
protected List<String> enginesBuild
```

lifeCycleMonitor

protected final Object lifeCycleMonitor

conversationDefinitionModelManager

protected ConversationDefinitionModelManager conversationDefinitionModelManager

conversationDefinitionModelCacheLimit

protected int conversationDefinitionModelCacheLimit

conversationDefinitionModelCache

protected DeploymentCache<ConversationDefinitionModel> conversationDefinitionModelCache

multiTenantEnabled
```
protected boolean multiTenantEnabled
```

identityLinkServiceConfiguration

protected IdentityLinkServiceConfiguration identityLinkServiceConfiguration

variableTypes
```
protected VariableTypes variableTypes
```

customPreVariableTypes

protected List<VariableType> customPreVariableTypes

customPostVariableTypes

protected List<VariableType> customPostVariableTypes

variableServiceConfiguration

protected VariableServiceConfiguration variableServiceConfiguration

serializableVariableTypeTrackDeserializedObjects

protected boolean serializableVariableTypeTrackDeserializedObjects

JOB_EXECUTION_SCOPE

public static final String JOB_EXECUTION_SCOPE

See Also:: Constant Field Values

jobServiceConfiguration

protected JobServiceConfiguration jobServiceConfiguration

historyJobHandlers

protected Map<String,HistoryJobHandler> historyJobHandlers

customHistoryJobHandlers

protected List<HistoryJobHandler> customHistoryJobHandlers

customHistoryJsonTransformers

protected List<HistoryJsonTransformer> customHistoryJsonTransformers

asyncHistoryExecutor

protected AsyncExecutor asyncHistoryExecutor

asyncHistoryEnabled
```
protected boolean asyncHistoryEnabled
```

asyncHistoryExecutorActivate

protected boolean asyncHistoryExecutorActivate

asyncHistoryExecutorMessageQueueMode

protected boolean asyncHistoryExecutorMessageQueueMode

jobExecutionScope
```
protected String jobExecutionScope
```

isAsyncHistoryJsonGzipCompressionEnabled

protected boolean isAsyncHistoryJsonGzipCompressionEnabled

isAsyncHistoryJsonGroupingEnabled

protected boolean isAsyncHistoryJsonGroupingEnabled

asyncHistoryJsonGroupingThreshold

protected int asyncHistoryJsonGroupingThreshold

asyncHistoryExecutorAsyncJobAcquisitionEnabled

protected boolean asyncHistoryExecutorAsyncJobAcquisitionEnabled

asyncHistoryExecutorResetExpiredJobsEnabled

protected boolean asyncHistoryExecutorResetExpiredJobsEnabled

asyncHistoryExecutorDefaultAsyncJobAcquireWaitTime

protected int asyncHistoryExecutorDefaultAsyncJobAcquireWaitTime

asyncHistoryExecutorDefaultQueueSizeFullWaitTime

protected int asyncHistoryExecutorDefaultQueueSizeFullWaitTime

asyncHistoryExecutorLockOwner

protected String asyncHistoryExecutorLockOwner

asyncHistoryExecutorAsyncJobLockTimeInMillis

protected int asyncHistoryExecutorAsyncJobLockTimeInMillis

asyncHistoryExecutorResetExpiredJobsInterval

protected int asyncHistoryExecutorResetExpiredJobsInterval

asyncHistoryExecutorResetExpiredJobsPageSize

protected int asyncHistoryExecutorResetExpiredJobsPageSize

asyncHistoryExecutorSecondsToWaitOnShutdown

protected int asyncHistoryExecutorSecondsToWaitOnShutdown

asyncHistoryExecutorNumberOfRetries

protected int asyncHistoryExecutorNumberOfRetries

asyncHistoryListener

protected AsyncHistoryListener asyncHistoryListener

searchService
```
protected SearchService searchService
```

conversationQueryTemplateHandler

protected ConversationQueryTemplateHandler conversationQueryTemplateHandler

conversationFilterDefinitions

protected Resource[] conversationFilterDefinitions

conversationFilterFactory

protected ConversationFilterFactory conversationFilterFactory

conversationFilterService

protected ConversationFilterService conversationFilterService

conversationIndexingService

protected ConversationIndexingService conversationIndexingService

messageIndexQueryService

protected MessageIndexQueryService messageIndexQueryService

conversationIndexQueryService

protected ConversationIndexQueryService conversationIndexQueryService

conversationResultMapper

protected ConversationResultMapper conversationResultMapper

messageResultMapper

protected MessageResultMapper messageResultMapper

messageComplianceResultMapper

protected MessageComplianceResultMapper messageComplianceResultMapper

templateFilterLocation

protected String templateFilterLocation

templateLoader

protected TemplateLoader templateLoader

decisionKeyDefaultPermissions

protected String decisionKeyDefaultPermissions

decisionKeyCreateConversationPermissions

protected String decisionKeyCreateConversationPermissions

decisionKeyArchiveConversationPermissions

protected String decisionKeyArchiveConversationPermissions

decisionKeyReopenConversationPermissions

protected String decisionKeyReopenConversationPermissions

decisionKeyInviteParticipantPermissions

protected String decisionKeyInviteParticipantPermissions

decisionKeyJoinParticipantPermissions

protected String decisionKeyJoinParticipantPermissions

decisionKeyDropParticipantPermissions

protected String decisionKeyDropParticipantPermissions

decisionKeyPostMessagePermissions

protected String decisionKeyPostMessagePermissions

decisionKeyPostVoiceMessagePermissions

protected String decisionKeyPostVoiceMessagePermissions

decisionKeyPostVideoMessagePermissions

protected String decisionKeyPostVideoMessagePermissions

decisionKeyPostImagePermissions

protected String decisionKeyPostImagePermissions

decisionKeyPostDocumentPermissions

protected String decisionKeyPostDocumentPermissions

decisionKeyEditMessagePermissions

protected String decisionKeyEditMessagePermissions

jsonVariableTypeTrackObjects
```
protected boolean jsonVariableTypeTrackObjects
```
This flag determines whether variables of the type 'json' and 'longJson' will be tracked.
This means that, when true, in a JavaDelegate you can write:
```
     JsonNode jsonNode = (JsonNode) execution.getVariable("customer");
     customer.put("name", "Kermit");
 
```
And the changes to the JsonNode will be reflected in the database. Otherwise, a manual call to setVariable will be needed.

Constructor Detail
- EngageEngineConfiguration
```
public EngageEngineConfiguration()
```

Method Detail

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 EngageDataManagers getDataManagers()

getEntityManagers

public EngageEntityManagers getEntityManagers()

isMultiTenantEnabled
```
public boolean isMultiTenantEnabled()
```

setMultiTenantEnabled

public void setMultiTenantEnabled(boolean multiTenantEnabled)

setDataSource

public EngageEngineConfiguration setDataSource(DataSource dataSource)

Overrides:: setDataSource in class AbstractEngineConfiguration

buildEngageEngine

public EngageEngine buildEngageEngine()

init
```
protected void init()
```

initSessionFactories
```
public void initSessionFactories()
```
Overrides:

initSessionFactories in class AbstractEngineConfiguration

initProviders
```
protected void initProviders()
```

initTemplateLoader
```
public void initTemplateLoader()
```

initConversationQueryTemplateHandler

protected void initConversationQueryTemplateHandler()

initConversationFilterFactory

protected void initConversationFilterFactory()

initServices
```
protected void initServices()
```

initConversationService

protected void initConversationService()

initTransactionContextFactory
```
public void initTransactionContextFactory()
```
Overrides:

initTransactionContextFactory in class AbstractEngineConfiguration

initTaskExecutor
```
protected void initTaskExecutor()
```

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

initSchemaManager
```
public void initSchemaManager()
```
Overrides:

initSchemaManager in class AbstractEngineConfiguration

initSchemaManagementCommand

public void initSchemaManagementCommand()

initConversationStarterHelper

public void initConversationStarterHelper()

initMessageSendHelper
```
public void initMessageSendHelper()
```

initExternalMessageSendHelper

public void initExternalMessageSendHelper()

initNotificationEvaluatorProvider

public void initNotificationEvaluatorProvider()

initEngageIndexingScheduler

public void initEngageIndexingScheduler()

initIndexQueryService
```
public void initIndexQueryService()
```

initTemporaryMessageHandling

public void initTemporaryMessageHandling()

initEventDispatcher
```
public void initEventDispatcher()
```
Overrides:

initEventDispatcher in class AbstractEngineConfiguration

initConversationDefinitionModelCache

public void initConversationDefinitionModelCache()

initConversationDefinitionModelManager

public void initConversationDefinitionModelManager()

initHistoryJobHandlers

protected void initHistoryJobHandlers()

initDefaultHistoryJsonTransformers

protected List<HistoryJsonTransformer> initDefaultHistoryJsonTransformers()

initVariableTypes
```
public void initVariableTypes()
```

initIdentityLinkServiceConfiguration

public void initIdentityLinkServiceConfiguration()

initVariableServiceConfiguration

public void initVariableServiceConfiguration()

configureJobServiceConfiguration

public void configureJobServiceConfiguration()

initJobServiceConfiguration

public void initJobServiceConfiguration()

initAsyncHistoryExecutor

protected void initAsyncHistoryExecutor()

initAsyncHistorySessionFactory

protected void initAsyncHistorySessionFactory()

initDefaultAsyncHistoryListener

protected void initDefaultAsyncHistoryListener()

autoDeployResources

protected void autoDeployResources(EngageEngine engageEngine)

getAutoDeploymentStrategy
```
protected AutoDeploymentStrategy<EngageEngine> 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

addAutoDeploymentStrategy

public EngageEngineConfiguration addAutoDeploymentStrategy(AutoDeploymentStrategy<EngageEngine> autoDeploymentStrategy)

getDeploymentStrategies

public Collection<AutoDeploymentStrategy<EngageEngine>> getDeploymentStrategies()

setDeploymentStrategies

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

start
```
public void start()
```
Specified by:

start in interface Lifecycle

stop
```
public void stop()
```
Specified by:

stop in interface Lifecycle

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 SpringEngineConfiguration

Specified by:

setApplicationContext in interface ApplicationContextAware

isRunning
```
public boolean isRunning()
```
Specified by:

isRunning in interface Lifecycle

getPhase
```
public int getPhase()
```
Specified by:

getPhase in interface SpringEngineConfiguration

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

getTaskExecutor
```
public TaskExecutor getTaskExecutor()
```

setTaskExecutor

public void setTaskExecutor(TaskExecutor taskExecutor)

getConversationStarterHelper

public ConversationStarterHelper getConversationStarterHelper()

setConversationStarterHelper

public void setConversationStarterHelper(ConversationStarterHelper conversationStarterHelper)

getMessageSendHelper

public MessageSendHelper getMessageSendHelper()

setMessageSendHelper

public void setMessageSendHelper(MessageSendHelper messageSendHelper)

getExternalMessageSendHelper

public ExternalMessageSendHelper getExternalMessageSendHelper()

setExternalMessageSendHelper

public void setExternalMessageSendHelper(ExternalMessageSendHelper externalMessageSendHelper)

getNotificationEvaluationProvider

public NotificationEvaluationProvider getNotificationEvaluationProvider()

setNotificationEvaluationProvider

public void setNotificationEvaluationProvider(NotificationEvaluationProvider notificationEvaluationProvider)

getConversationPermissionService
```
public ConversationPermissionService getConversationPermissionService()
```
Specified by:

getConversationPermissionService in interface EngageEngineConfigurationApi

setConversationPermissionService

public void setConversationPermissionService(ConversationPermissionService conversationPermissionService)

getDeviceService
```
public DeviceService getDeviceService()
```
Specified by:

getDeviceService in interface EngageEngineConfigurationApi

setDeviceService

public void setDeviceService(DeviceService deviceService)

getTemporaryMessageHandler

public TemporaryMessageHandler getTemporaryMessageHandler()

setTemporaryMessageHandler

public void setTemporaryMessageHandler(TemporaryMessageHandler temporaryMessageHandler)

getTemporaryMessageProcessors

public List<TemporaryMessageProcessor> getTemporaryMessageProcessors()

setTemporaryMessageProcessors

public void setTemporaryMessageProcessors(List<TemporaryMessageProcessor> temporaryMessageProcessors)

addTemporaryMessageProcessor

public void addTemporaryMessageProcessor(TemporaryMessageProcessor temporaryMessageProcessor)

isIndexingEnabled
```
public boolean isIndexingEnabled()
```

setIndexingEnabled

public void setIndexingEnabled(boolean indexingEnabled)

getIndexingService

public IndexingService getIndexingService()

setIndexingService

public void setIndexingService(IndexingService indexingService)

getIndexManager
```
public IndexManager getIndexManager()
```

setIndexManager

public void setIndexManager(IndexManager indexManager)

getReindexManager

public ReindexManager getReindexManager()

setReindexManager

public void setReindexManager(ReindexManager reindexManager)

getEngageIndexingScheduler

public EngageIndexingScheduler getEngageIndexingScheduler()

setEngageIndexingScheduler

public void setEngageIndexingScheduler(EngageIndexingScheduler engageIndexingScheduler)

getConversationService
```
public ConversationService getConversationService()
```
Specified by:

getConversationService in interface EngageEngineConfigurationApi

setConversationService

public void setConversationService(ConversationService conversationService)

getConversationDefinitionService
```
public ConversationDefinitionService getConversationDefinitionService()
```
Specified by:

getConversationDefinitionService in interface EngageEngineConfigurationApi

setConversationDefinitionService

public void setConversationDefinitionService(ConversationDefinitionService conversationDefinitionService)

getMessageService
```
public MessageService getMessageService()
```
Specified by:

getMessageService in interface EngageEngineConfigurationApi

setMessageService

public void setMessageService(MessageService messageService)

getUserSubscriptionService
```
public UserSubscriptionService getUserSubscriptionService()
```
Specified by:

getUserSubscriptionService in interface EngageEngineConfigurationApi

setUserSubscriptionService

public void setUserSubscriptionService(UserSubscriptionService userSubscriptionService)

getConversationNotificationService
```
public ConversationNotificationService getConversationNotificationService()
```
Specified by:

getConversationNotificationService in interface EngageEngineConfigurationApi

getConversationTagProviders

public List<ConversationTagProvider> getConversationTagProviders()

setConversationTagProviders

public void setConversationTagProviders(List<ConversationTagProvider> conversationTagProviders)

setConversationNotificationService

public void setConversationNotificationService(ConversationNotificationService conversationNotificationService)

getExternalConversationService

public ExternalConversationService getExternalConversationService()

setExternalConversationService

public void setExternalConversationService(ExternalConversationService externalConversationService)

getDeskService
```
public DeskService getDeskService()
```

setDeskService

public void setDeskService(DeskService deskService)

getConversationFilterService

public ConversationFilterService getConversationFilterService()

setConversationFilterService

public void setConversationFilterService(ConversationFilterService conversationFilterService)

getConversationFilterDefinitions

public Resource[] getConversationFilterDefinitions()

setConversationFilterDefinitions

public void setConversationFilterDefinitions(Resource[] conversationFilterDefinitions)

getConversationFilterFactory

public ConversationFilterFactory getConversationFilterFactory()

setConversationFilterFactory

public void setConversationFilterFactory(ConversationFilterFactory conversationFilterFactory)

getMessageIndexQueryService

public MessageIndexQueryService getMessageIndexQueryService()

setMessageIndexQueryService

public void setMessageIndexQueryService(MessageIndexQueryService messageIndexQueryService)

getConversationIndexQueryService

public ConversationIndexQueryService getConversationIndexQueryService()

setConversationIndexQueryService

public void setConversationIndexQueryService(ConversationIndexQueryService conversationIndexQueryService)

getConversationResultMapper

public ConversationResultMapper getConversationResultMapper()

setConversationResultMapper

public void setConversationResultMapper(ConversationResultMapper conversationResultMapper)

getMessageResultMapper

public MessageResultMapper getMessageResultMapper()

setMessageResultMapper

public void setMessageResultMapper(MessageResultMapper messageResultMapper)

getConversationQueryTemplateHandler

public ConversationQueryTemplateHandler getConversationQueryTemplateHandler()

setConversationQueryTemplateHandler

public void setConversationQueryTemplateHandler(ConversationQueryTemplateHandler conversationQueryTemplateHandler)

getConversationIndexingService

public ConversationIndexingService getConversationIndexingService()

setConversationIndexingService

public void setConversationIndexingService(ConversationIndexingService conversationIndexingService)

getConversationRegistryEntryService

public ConversationRegistryEntryService getConversationRegistryEntryService()

setConversationRegistryEntryService

public void setConversationRegistryEntryService(ConversationRegistryEntryService conversationRegistryEntryService)

getJobServiceConfiguration

public JobServiceConfiguration getJobServiceConfiguration()

setJobServiceConfiguration

public void setJobServiceConfiguration(JobServiceConfiguration jobServiceConfiguration)

getHistoryJobHandlers

public Map<String,HistoryJobHandler> getHistoryJobHandlers()

setHistoryJobHandlers

public void setHistoryJobHandlers(Map<String,HistoryJobHandler> historyJobHandlers)

getAsyncHistoryExecutor

public AsyncExecutor getAsyncHistoryExecutor()

setAsyncHistoryExecutor

public void setAsyncHistoryExecutor(AsyncExecutor asyncHistoryExecutor)

isAsyncHistoryEnabled

public boolean isAsyncHistoryEnabled()

setAsyncHistoryEnabled

public void setAsyncHistoryEnabled(boolean asyncHistoryEnabled)

isAsyncHistoryExecutorActivate

public boolean isAsyncHistoryExecutorActivate()

setAsyncHistoryExecutorActivate

public void setAsyncHistoryExecutorActivate(boolean asyncHistoryExecutorActivate)

isAsyncHistoryExecutorMessageQueueMode

public boolean isAsyncHistoryExecutorMessageQueueMode()

setAsyncHistoryExecutorMessageQueueMode

public void setAsyncHistoryExecutorMessageQueueMode(boolean asyncHistoryExecutorMessageQueueMode)

getJobExecutionScope
```
public String getJobExecutionScope()
```

setJobExecutionScope

public void setJobExecutionScope(String jobExecutionScope)

isAsyncHistoryJsonGzipCompressionEnabled

public boolean isAsyncHistoryJsonGzipCompressionEnabled()

setAsyncHistoryJsonGzipCompressionEnabled

public void setAsyncHistoryJsonGzipCompressionEnabled(boolean asyncHistoryJsonGzipCompressionEnabled)

isAsyncHistoryJsonGroupingEnabled

public boolean isAsyncHistoryJsonGroupingEnabled()

setAsyncHistoryJsonGroupingEnabled

public void setAsyncHistoryJsonGroupingEnabled(boolean asyncHistoryJsonGroupingEnabled)

getAsyncHistoryJsonGroupingThreshold

public int getAsyncHistoryJsonGroupingThreshold()

setAsyncHistoryJsonGroupingThreshold

public void setAsyncHistoryJsonGroupingThreshold(int asyncHistoryJsonGroupingThreshold)

isAsyncHistoryExecutorAsyncJobAcquisitionEnabled

public boolean isAsyncHistoryExecutorAsyncJobAcquisitionEnabled()

setAsyncHistoryExecutorAsyncJobAcquisitionEnabled

public void setAsyncHistoryExecutorAsyncJobAcquisitionEnabled(boolean asyncHistoryExecutorAsyncJobAcquisitionEnabled)

isAsyncHistoryExecutorResetExpiredJobsEnabled

public boolean isAsyncHistoryExecutorResetExpiredJobsEnabled()

setAsyncHistoryExecutorResetExpiredJobsEnabled

public void setAsyncHistoryExecutorResetExpiredJobsEnabled(boolean asyncHistoryExecutorResetExpiredJobsEnabled)

getAsyncHistoryExecutorDefaultAsyncJobAcquireWaitTime

public int getAsyncHistoryExecutorDefaultAsyncJobAcquireWaitTime()

setAsyncHistoryExecutorDefaultAsyncJobAcquireWaitTime

public void setAsyncHistoryExecutorDefaultAsyncJobAcquireWaitTime(int asyncHistoryExecutorDefaultAsyncJobAcquireWaitTime)

getAsyncHistoryExecutorDefaultQueueSizeFullWaitTime

public int getAsyncHistoryExecutorDefaultQueueSizeFullWaitTime()

setAsyncHistoryExecutorDefaultQueueSizeFullWaitTime

public void setAsyncHistoryExecutorDefaultQueueSizeFullWaitTime(int asyncHistoryExecutorDefaultQueueSizeFullWaitTime)

getAsyncHistoryExecutorLockOwner

public String getAsyncHistoryExecutorLockOwner()

setAsyncHistoryExecutorLockOwner

public void setAsyncHistoryExecutorLockOwner(String asyncHistoryExecutorLockOwner)

getAsyncHistoryExecutorAsyncJobLockTimeInMillis

public int getAsyncHistoryExecutorAsyncJobLockTimeInMillis()

setAsyncHistoryExecutorAsyncJobLockTimeInMillis

public void setAsyncHistoryExecutorAsyncJobLockTimeInMillis(int asyncHistoryExecutorAsyncJobLockTimeInMillis)

getAsyncHistoryExecutorResetExpiredJobsInterval

public int getAsyncHistoryExecutorResetExpiredJobsInterval()

setAsyncHistoryExecutorResetExpiredJobsInterval

public void setAsyncHistoryExecutorResetExpiredJobsInterval(int asyncHistoryExecutorResetExpiredJobsInterval)

getAsyncHistoryExecutorResetExpiredJobsPageSize

public int getAsyncHistoryExecutorResetExpiredJobsPageSize()

setAsyncHistoryExecutorResetExpiredJobsPageSize

public void setAsyncHistoryExecutorResetExpiredJobsPageSize(int asyncHistoryExecutorResetExpiredJobsPageSize)

getAsyncHistoryExecutorSecondsToWaitOnShutdown

public int getAsyncHistoryExecutorSecondsToWaitOnShutdown()

setAsyncHistoryExecutorSecondsToWaitOnShutdown

public void setAsyncHistoryExecutorSecondsToWaitOnShutdown(int asyncHistoryExecutorSecondsToWaitOnShutdown)

getAsyncHistoryExecutorNumberOfRetries

public int getAsyncHistoryExecutorNumberOfRetries()

setAsyncHistoryExecutorNumberOfRetries

public void setAsyncHistoryExecutorNumberOfRetries(int asyncHistoryExecutorNumberOfRetries)

getAsyncHistoryListener

public AsyncHistoryListener getAsyncHistoryListener()

setAsyncHistoryListener

public void setAsyncHistoryListener(AsyncHistoryListener asyncHistoryListener)

getCustomHistoryJobHandlers

public List<HistoryJobHandler> getCustomHistoryJobHandlers()

setCustomHistoryJobHandlers

public void setCustomHistoryJobHandlers(List<HistoryJobHandler> customHistoryJobHandlers)

getCustomHistoryJsonTransformers

public List<HistoryJsonTransformer> getCustomHistoryJsonTransformers()

setCustomHistoryJsonTransformers

public void setCustomHistoryJsonTransformers(List<HistoryJsonTransformer> customHistoryJsonTransformers)

addEventListener

public void addEventListener(String type,
                             FlowableEventListener eventListener)

getExternalConversationSystemAdapters

public Map<String,ExternalConversationSystemAdapter> getExternalConversationSystemAdapters()

addExternalConversationSystemAdapter

public void addExternalConversationSystemAdapter(ExternalConversationSystemAdapter externalConversationSystemAdapter)

getSearchService

public SearchService getSearchService()

setSearchService

public void setSearchService(SearchService searchService)

getConversationDefinitionModelManager

public ConversationDefinitionModelManager getConversationDefinitionModelManager()

setConversationDefinitionModelManager

public void setConversationDefinitionModelManager(ConversationDefinitionModelManager conversationDefinitionModelManager)

getConversationDefinitionModelCacheLimit

public int getConversationDefinitionModelCacheLimit()

setConversationDefinitionModelCacheLimit

public void setConversationDefinitionModelCacheLimit(int conversationDefinitionModelCacheLimit)

getConversationDefinitionModelCache

public DeploymentCache<ConversationDefinitionModel> getConversationDefinitionModelCache()

setConversationDefinitionModelCache

public void setConversationDefinitionModelCache(DeploymentCache<ConversationDefinitionModel> conversationDefinitionModelCache)

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

getTemplateLoader

public TemplateLoader getTemplateLoader()

setTemplateLoader

public void setTemplateLoader(TemplateLoader templateLoader)

getTemplateFilterLocation

public String getTemplateFilterLocation()

setTemplateFilterLocation

public void setTemplateFilterLocation(String templateFilterLocation)

getDecisionKeyDefaultPermissions

public String getDecisionKeyDefaultPermissions()

setDecisionKeyDefaultPermissions

public void setDecisionKeyDefaultPermissions(String decisionKeyDefaultPermissions)

getDecisionKeyCreateConversationPermissions

public String getDecisionKeyCreateConversationPermissions()

setDecisionKeyCreateConversationPermissions

public void setDecisionKeyCreateConversationPermissions(String decisionKeyCreateConversationPermissions)

getDecisionKeyArchiveConversationPermissions

public String getDecisionKeyArchiveConversationPermissions()

setDecisionKeyArchiveConversationPermissions

public void setDecisionKeyArchiveConversationPermissions(String decisionKeyArchiveConversationPermissions)

getDecisionKeyReopenConversationPermissions

public String getDecisionKeyReopenConversationPermissions()

setDecisionKeyReopenConversationPermissions

public void setDecisionKeyReopenConversationPermissions(String decisionKeyReopenConversationPermissions)

getDecisionKeyInviteParticipantPermissions

public String getDecisionKeyInviteParticipantPermissions()

setDecisionKeyInviteParticipantPermissions

public void setDecisionKeyInviteParticipantPermissions(String decisionKeyInviteParticipantPermissions)

getDecisionKeyJoinParticipantPermissions

public String getDecisionKeyJoinParticipantPermissions()

setDecisionKeyJoinParticipantPermissions

public void setDecisionKeyJoinParticipantPermissions(String decisionKeyJoinParticipantPermissions)

getDecisionKeyDropParticipantPermissions

public String getDecisionKeyDropParticipantPermissions()

setDecisionKeyDropParticipantPermissions

public void setDecisionKeyDropParticipantPermissions(String decisionKeyDropParticipantPermissions)

getDecisionKeyPostMessagePermissions

public String getDecisionKeyPostMessagePermissions()

setDecisionKeyPostMessagePermissions

public void setDecisionKeyPostMessagePermissions(String decisionKeyPostMessagePermissions)

getDecisionKeyPostVoiceMessagePermissions

public String getDecisionKeyPostVoiceMessagePermissions()

setDecisionKeyPostVoiceMessagePermissions

public void setDecisionKeyPostVoiceMessagePermissions(String decisionKeyPostVoiceMessagePermissions)

getDecisionKeyPostVideoMessagePermissions

public String getDecisionKeyPostVideoMessagePermissions()

setDecisionKeyPostVideoMessagePermissions

public void setDecisionKeyPostVideoMessagePermissions(String decisionKeyPostVideoMessagePermissions)

getDecisionKeyPostImagePermissions

public String getDecisionKeyPostImagePermissions()

setDecisionKeyPostImagePermissions

public void setDecisionKeyPostImagePermissions(String decisionKeyPostImagePermissions)

getDecisionKeyPostDocumentPermissions

public String getDecisionKeyPostDocumentPermissions()

setDecisionKeyPostDocumentPermissions

public void setDecisionKeyPostDocumentPermissions(String decisionKeyPostDocumentPermissions)

getDecisionKeyEditMessagePermissions

public String getDecisionKeyEditMessagePermissions()

setDecisionKeyEditMessagePermissions

public void setDecisionKeyEditMessagePermissions(String decisionKeyEditMessagePermissions)

getIdentityLinkServiceConfiguration

public IdentityLinkServiceConfiguration getIdentityLinkServiceConfiguration()

setIdentityLinkServiceConfiguration

public void setIdentityLinkServiceConfiguration(IdentityLinkServiceConfiguration identityLinkServiceConfiguration)

getVariableTypes
```
public VariableTypes getVariableTypes()
```
Specified by:

getVariableTypes in interface HasVariableTypes

setVariableTypes

public EngageEngineConfiguration setVariableTypes(VariableTypes variableTypes)

Specified by:: setVariableTypes in interface HasVariableTypes

getCustomPreVariableTypes

public List<VariableType> getCustomPreVariableTypes()

setCustomPreVariableTypes

public void setCustomPreVariableTypes(List<VariableType> customPreVariableTypes)

getCustomPostVariableTypes

public List<VariableType> getCustomPostVariableTypes()

setCustomPostVariableTypes

public void setCustomPostVariableTypes(List<VariableType> customPostVariableTypes)

getVariableServiceConfiguration

public VariableServiceConfiguration getVariableServiceConfiguration()

setVariableServiceConfiguration

public void setVariableServiceConfiguration(VariableServiceConfiguration variableServiceConfiguration)

isSerializableVariableTypeTrackDeserializedObjects

public boolean isSerializableVariableTypeTrackDeserializedObjects()

setSerializableVariableTypeTrackDeserializedObjects

public void setSerializableVariableTypeTrackDeserializedObjects(boolean serializableVariableTypeTrackDeserializedObjects)

isJsonVariableTypeTrackObjects

public boolean isJsonVariableTypeTrackObjects()

setJsonVariableTypeTrackObjects

public void setJsonVariableTypeTrackObjects(boolean jsonVariableTypeTrackObjects)

Class EngageEngineConfiguration

Field Summary

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

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

Fields inherited from interface org.springframework.context.SmartLifecycle

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MYBATIS_MAPPING_FILE

DEFAULT_ENGINE_NAME

KEY_ENGAGE_ENGINE_CONFIG

LIQUIBASE_CHANGELOG_PREFIX

engageEngineName

conversationService

conversationDefinitionService

messageService

userSubscriptionService

conversationNotificationService

externalConversationService

deskService

conversationRegistryEntryService

conversationStarterHelper

messageSendHelper

externalMessageSendHelper

notificationEvaluationProvider

conversationPermissionService

deviceService

temporaryMessageHandler

temporaryMessageProcessors

indexingEnabled

indexingService

reindexManager

indexManager

engageIndexingScheduler

externalConversationSystemAdapters

conversationTagProviders

dataManagers

entityManagers

transactionManager

transactionSynchronizationAdapterOrder

applicationContext

taskExecutor

running

deploymentName

deploymentResources

deploymentMode

deploymentStrategies

enginesBuild

lifeCycleMonitor

conversationDefinitionModelManager

conversationDefinitionModelCacheLimit

conversationDefinitionModelCache

multiTenantEnabled

identityLinkServiceConfiguration

variableTypes

customPreVariableTypes

customPostVariableTypes

variableServiceConfiguration

serializableVariableTypeTrackDeserializedObjects

JOB_EXECUTION_SCOPE

jobServiceConfiguration

historyJobHandlers

customHistoryJobHandlers

customHistoryJsonTransformers

asyncHistoryExecutor

asyncHistoryEnabled

asyncHistoryExecutorActivate

asyncHistoryExecutorMessageQueueMode

jobExecutionScope

isAsyncHistoryJsonGzipCompressionEnabled

isAsyncHistoryJsonGroupingEnabled

asyncHistoryJsonGroupingThreshold

asyncHistoryExecutorAsyncJobAcquisitionEnabled

asyncHistoryExecutorResetExpiredJobsEnabled

asyncHistoryExecutorDefaultAsyncJobAcquireWaitTime

asyncHistoryExecutorDefaultQueueSizeFullWaitTime

asyncHistoryExecutorLockOwner