Class EngageEngineConfiguration

    • Field Detail

      • engageEngineName

        protected String engageEngineName
      • indexingEnabled

        protected boolean indexingEnabled
      • transactionSynchronizationAdapterOrder

        protected Integer transactionSynchronizationAdapterOrder
      • running

        protected volatile boolean running
      • deploymentName

        protected String deploymentName
      • deploymentResources

        protected Resource[] deploymentResources
      • deploymentMode

        protected String deploymentMode
      • enginesBuild

        protected List<String> enginesBuild
      • lifeCycleMonitor

        protected final Object lifeCycleMonitor
      • conversationDefinitionModelCacheLimit

        protected int conversationDefinitionModelCacheLimit
      • multiTenantEnabled

        protected boolean multiTenantEnabled
      • serializableVariableTypeTrackDeserializedObjects

        protected boolean serializableVariableTypeTrackDeserializedObjects
      • 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
      • conversationFilterDefinitions

        protected Resource[] conversationFilterDefinitions
      • templateFilterLocation

        protected String templateFilterLocation
      • 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

      • setTransactionSynchronizationAdapterOrder

        public void setTransactionSynchronizationAdapterOrder​(Integer transactionSynchronizationAdapterOrder)
      • isMultiTenantEnabled

        public boolean isMultiTenantEnabled()
      • setMultiTenantEnabled

        public void setMultiTenantEnabled​(boolean multiTenantEnabled)
      • buildEngageEngine

        public EngageEngine buildEngageEngine()
      • init

        protected void init()
      • initProviders

        protected void initProviders()
      • initTemplateLoader

        public void initTemplateLoader()
      • initConversationQueryTemplateHandler

        protected void initConversationQueryTemplateHandler()
      • initConversationFilterFactory

        protected void initConversationFilterFactory()
      • initServices

        protected void initServices()
      • initConversationService

        protected void initConversationService()
      • initChangeTenantIdManager

        public void initChangeTenantIdManager()
      • initTaskExecutor

        protected void initTaskExecutor()
      • 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()
      • initConversationDefinitionModelCache

        public void initConversationDefinitionModelCache()
      • initConversationDefinitionModelManager

        public void initConversationDefinitionModelManager()
      • initHistoryJobHandlers

        protected void initHistoryJobHandlers()
      • 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
      • start

        public void start()
        Specified by:
        start in interface Lifecycle
      • stop

        public void stop()
        Specified by:
        stop in interface Lifecycle
      • setTaskExecutor

        public void setTaskExecutor​(TaskExecutor taskExecutor)
      • setConversationStarterHelper

        public void setConversationStarterHelper​(ConversationStarterHelper conversationStarterHelper)
      • setMessageSendHelper

        public void setMessageSendHelper​(MessageSendHelper messageSendHelper)
      • setExternalMessageSendHelper

        public void setExternalMessageSendHelper​(ExternalMessageSendHelper externalMessageSendHelper)
      • setNotificationEvaluationProvider

        public void setNotificationEvaluationProvider​(NotificationEvaluationProvider notificationEvaluationProvider)
      • setConversationPermissionService

        public void setConversationPermissionService​(ConversationPermissionService conversationPermissionService)
      • setDeviceService

        public void setDeviceService​(DeviceService deviceService)
      • setTemporaryMessageHandler

        public void setTemporaryMessageHandler​(TemporaryMessageHandler temporaryMessageHandler)
      • addTemporaryMessageProcessor

        public void addTemporaryMessageProcessor​(TemporaryMessageProcessor temporaryMessageProcessor)
      • setChangeTenantIdManager

        public void setChangeTenantIdManager​(ChangeTenantIdManager changeTenantIdManager)
      • isIndexingEnabled

        public boolean isIndexingEnabled()
      • setIndexingEnabled

        public void setIndexingEnabled​(boolean indexingEnabled)
      • setIndexingService

        public void setIndexingService​(IndexingService indexingService)
      • setIndexManager

        public void setIndexManager​(IndexManager indexManager)
      • setReindexManager

        public void setReindexManager​(ReindexManager reindexManager)
      • setEngageIndexingScheduler

        public void setEngageIndexingScheduler​(EngageIndexingScheduler engageIndexingScheduler)
      • setConversationService

        public void setConversationService​(ConversationService conversationService)
      • setConversationDefinitionService

        public void setConversationDefinitionService​(ConversationDefinitionService conversationDefinitionService)
      • setMessageService

        public void setMessageService​(MessageService messageService)
      • setEngageManagementService

        public void setEngageManagementService​(EngageManagementService engageManagementService)
      • setUserSubscriptionService

        public void setUserSubscriptionService​(UserSubscriptionService userSubscriptionService)
      • setExternalConversationService

        public void setExternalConversationService​(ExternalConversationService externalConversationService)
      • setDeskService

        public void setDeskService​(DeskService deskService)
      • setConversationFilterService

        public void setConversationFilterService​(ConversationFilterService conversationFilterService)
      • getConversationFilterDefinitions

        public Resource[] getConversationFilterDefinitions()
      • setConversationFilterDefinitions

        public void setConversationFilterDefinitions​(Resource[] conversationFilterDefinitions)
      • setConversationFilterFactory

        public void setConversationFilterFactory​(ConversationFilterFactory conversationFilterFactory)
      • setMessageIndexQueryService

        public void setMessageIndexQueryService​(MessageIndexQueryService messageIndexQueryService)
      • setConversationIndexQueryService

        public void setConversationIndexQueryService​(ConversationIndexQueryService conversationIndexQueryService)
      • setConversationResultMapper

        public void setConversationResultMapper​(ConversationResultMapper conversationResultMapper)
      • setMessageResultMapper

        public void setMessageResultMapper​(MessageResultMapper messageResultMapper)
      • setConversationIndexingService

        public void setConversationIndexingService​(ConversationIndexingService conversationIndexingService)
      • setJobServiceConfiguration

        public void setJobServiceConfiguration​(JobServiceConfiguration jobServiceConfiguration)
      • 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)
      • setAsyncHistoryListener

        public void setAsyncHistoryListener​(AsyncHistoryListener asyncHistoryListener)
      • setCustomHistoryJobHandlers

        public void setCustomHistoryJobHandlers​(List<HistoryJobHandler> customHistoryJobHandlers)
      • setCustomHistoryJsonTransformers

        public void setCustomHistoryJsonTransformers​(List<HistoryJsonTransformer> customHistoryJsonTransformers)
      • setSearchService

        public void setSearchService​(SearchService searchService)
      • getConversationDefinitionModelCacheLimit

        public int getConversationDefinitionModelCacheLimit()
      • setConversationDefinitionModelCacheLimit

        public void setConversationDefinitionModelCacheLimit​(int conversationDefinitionModelCacheLimit)
      • 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)
      • getCustomPreVariableTypes

        public List<VariableType> getCustomPreVariableTypes()
      • setCustomPreVariableTypes

        public void setCustomPreVariableTypes​(List<VariableType> customPreVariableTypes)
      • getCustomPostVariableTypes

        public List<VariableType> getCustomPostVariableTypes()
      • setCustomPostVariableTypes

        public void setCustomPostVariableTypes​(List<VariableType> customPostVariableTypes)
      • 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)