Package org.flowable.job.service
Class JobServiceConfiguration
java.lang.Object
org.flowable.common.engine.impl.AbstractServiceConfiguration
org.flowable.job.service.JobServiceConfiguration
This service configuration contains all settings and instances around job execution and management.
Note that a
JobServiceConfiguration is not shared between engines and instantiated for each engine.- Author:
- Tijs Rademakers
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected AsyncExecutorprotected intprotected intprotected AsyncExecutorprotected booleanprotected intprotected booleanprotected intprotected booleanprotected List<AsyncRunnableExecutionExceptionHandler>protected BusinessCalendarManagerprotected CommandExecutorprotected DeadLetterJobDataManagerprotected DeadLetterJobEntityManagerprotected ExpressionManagerprotected ExternalWorkerJobDataManagerprotected ExternalWorkerJobEntityManagerprotected FailedJobCommandFactoryprotected HistoryJobDataManagerprotected HistoryJobEntityManagerprotected Stringprotected Map<String,HistoryJobHandler> protected List<HistoryJobProcessor>protected HistoryJobServiceprotected InternalJobCompatibilityManagerprotected InternalJobManagerstatic final Stringstatic final Stringprotected JobDataManagerprotected JobEntityManagerprotected Stringprotected Map<String,JobHandler> protected JobManagerprotected InternalJobParentStateResolverprotected List<JobProcessor>protected JobServiceprotected Stringprotected Stringprotected SuspendedJobDataManagerprotected SuspendedJobEntityManagerprotected TimerJobDataManagerprotected TimerJobEntityManagerprotected TimerJobServiceFields inherited from class org.flowable.common.engine.impl.AbstractServiceConfiguration
additionalEventDispatchActions, clock, enableEventDispatcher, engineName, eventDispatcher, eventListeners, historyLevel, idGenerator, logger, NO_TENANT_ID, objectMapper, typedEventListeners -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddEnabledJobCategory(String jobCategory) addHistoryJobHandler(String type, HistoryJobHandler historyJobHandler) addJobHandler(String type, JobHandler jobHandler) protected voidcopyHistoryJsonTransformers(AsyncHistoryJobHandler source, AsyncHistoryJobHandler target) intintintintcom.fasterxml.jackson.databind.ObjectMappervoidinit()voidvoidvoidbooleanbooleanbooleanbooleanbooleanmergeHistoryJobHandler(HistoryJobHandler historyJobHandler) Registers the givenHistoryJobHandlerunder the provided type and checks for existing default and internalHistoryJobHandlerinstances to be of the same class.setAsyncExecutor(AsyncExecutor asyncExecutor) setAsyncExecutorNumberOfRetries(int asyncExecutorNumberOfRetries) setAsyncExecutorResetExpiredJobsMaxTimeout(int asyncExecutorResetExpiredJobsMaxTimeout) setAsyncHistoryExecutor(AsyncExecutor asyncHistoryExecutor) voidsetAsyncHistoryExecutorMessageQueueMode(boolean asyncHistoryExecutorMessageQueueMode) setAsyncHistoryExecutorNumberOfRetries(int asyncHistoryExecutorNumberOfRetries) voidsetAsyncHistoryJsonGroupingEnabled(boolean asyncHistoryJsonGroupingEnabled) voidsetAsyncHistoryJsonGroupingThreshold(int asyncHistoryJsonGroupingThreshold) voidsetAsyncHistoryJsonGzipCompressionEnabled(boolean asyncHistoryJsonGzipCompressionEnabled) setAsyncRunnableExecutionExceptionHandlers(List<AsyncRunnableExecutionExceptionHandler> asyncRunnableExecutionExceptionHandlers) setBusinessCalendarManager(BusinessCalendarManager businessCalendarManager) voidsetCommandExecutor(CommandExecutor commandExecutor) setDeadLetterJobDataManager(DeadLetterJobDataManager deadLetterJobDataManager) setDeadLetterJobEntityManager(DeadLetterJobEntityManager deadLetterJobEntityManager) voidsetEnabledJobCategories(List<String> enabledJobCategories) setExpressionManager(ExpressionManager expressionManager) setExternalWorkerJobDataManager(ExternalWorkerJobDataManager externalWorkerJobDataManager) setExternalWorkerJobEntityManager(ExternalWorkerJobEntityManager externalWorkerJobEntityManager) setFailedJobCommandFactory(FailedJobCommandFactory failedJobCommandFactory) setHistoryJobDataManager(HistoryJobDataManager historyJobDataManager) setHistoryJobEntityManager(HistoryJobEntityManager historyJobEntityManager) setHistoryJobExecutionScope(String historyJobExecutionScope) setHistoryJobHandlers(Map<String, HistoryJobHandler> historyJobHandlers) setHistoryJobProcessors(List<HistoryJobProcessor> historyJobProcessors) setHistoryJobService(HistoryJobService historyJobService) voidsetInternalJobCompatibilityManager(InternalJobCompatibilityManager internalJobCompatibilityManager) voidsetInternalJobManager(InternalJobManager internalJobManager) setJobDataManager(JobDataManager jobDataManager) setJobEntityManager(JobEntityManager jobEntityManager) setJobExecutionScope(String jobExecutionScope) setJobHandlers(Map<String, JobHandler> jobHandlers) voidsetJobManager(JobManager jobManager) voidsetJobParentStateResolver(InternalJobParentStateResolver jobParentStateResolver) setJobProcessors(List<JobProcessor> jobProcessors) setJobService(JobService jobService) voidsetJobTypeAsyncHistory(String jobTypeAsyncHistory) voidsetJobTypeAsyncHistoryZipped(String jobTypeAsyncHistoryZipped) setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) setSuspendedJobDataManager(SuspendedJobDataManager suspendedJobDataManager) setSuspendedJobEntityManager(SuspendedJobEntityManager suspendedJobEntityManager) setTimerJobDataManager(TimerJobDataManager timerJobDataManager) setTimerJobEntityManager(TimerJobEntityManager timerJobEntityManager) setTimerJobService(TimerJobService timerJobService) Methods inherited from class org.flowable.common.engine.impl.AbstractServiceConfiguration
getAdditionalEventDispatchActions, getClock, getEngineName, getEventDispatcher, getEventListeners, getHistoryLevel, getIdGenerator, getTypedEventListeners, isEnableEventDispatcher, isEventDispatcherEnabled, setAdditionalEventDispatchActions, setClock, setEnableEventDispatcher, setEngineName, setEventDispatcher, setEventListeners, setHistoryLevel, setIdGenerator, setTypedEventListeners
-
Field Details
-
JOB_EXECUTION_SCOPE_ALL
- See Also:
-
JOB_EXECUTION_SCOPE_CMMN
- See Also:
-
jobService
-
timerJobService
-
historyJobService
-
jobManager
-
jobDataManager
-
deadLetterJobDataManager
-
suspendedJobDataManager
-
timerJobDataManager
-
historyJobDataManager
-
externalWorkerJobDataManager
-
jobEntityManager
-
deadLetterJobEntityManager
-
suspendedJobEntityManager
-
timerJobEntityManager
-
historyJobEntityManager
-
externalWorkerJobEntityManager
-
commandExecutor
-
expressionManager
-
businessCalendarManager
-
internalJobManager
-
internalJobCompatibilityManager
-
jobParentStateResolver
-
asyncExecutor
-
asyncExecutorNumberOfRetries
protected int asyncExecutorNumberOfRetries -
asyncExecutorResetExpiredJobsMaxTimeout
protected int asyncExecutorResetExpiredJobsMaxTimeout -
jobExecutionScope
-
jobHandlers
-
failedJobCommandFactory
-
asyncRunnableExecutionExceptionHandlers
-
jobProcessors
-
enabledJobCategories
-
asyncHistoryExecutor
-
asyncHistoryExecutorNumberOfRetries
protected int asyncHistoryExecutorNumberOfRetries -
historyJobExecutionScope
-
historyJobHandlers
-
historyJobProcessors
-
jobTypeAsyncHistory
-
jobTypeAsyncHistoryZipped
-
asyncHistoryJsonGzipCompressionEnabled
protected boolean asyncHistoryJsonGzipCompressionEnabled -
asyncHistoryJsonGroupingEnabled
protected boolean asyncHistoryJsonGroupingEnabled -
asyncHistoryExecutorMessageQueueMode
protected boolean asyncHistoryExecutorMessageQueueMode -
asyncHistoryJsonGroupingThreshold
protected int asyncHistoryJsonGroupingThreshold
-
-
Constructor Details
-
JobServiceConfiguration
-
-
Method Details
-
init
public void init() -
isHistoryLevelAtLeast
- Overrides:
isHistoryLevelAtLeastin classAbstractServiceConfiguration
-
isHistoryEnabled
public boolean isHistoryEnabled()- Overrides:
isHistoryEnabledin classAbstractServiceConfiguration
-
initJobManager
public void initJobManager() -
initDataManagers
public void initDataManagers() -
initEntityManagers
public void initEntityManagers() -
getIdentityLinkServiceConfiguration
-
getJobService
-
setJobService
-
getTimerJobService
-
setTimerJobService
-
getHistoryJobService
-
setHistoryJobService
-
getJobManager
-
setJobManager
-
getJobDataManager
-
setJobDataManager
-
getDeadLetterJobDataManager
-
setDeadLetterJobDataManager
public JobServiceConfiguration setDeadLetterJobDataManager(DeadLetterJobDataManager deadLetterJobDataManager) -
getSuspendedJobDataManager
-
setSuspendedJobDataManager
public JobServiceConfiguration setSuspendedJobDataManager(SuspendedJobDataManager suspendedJobDataManager) -
getTimerJobDataManager
-
setTimerJobDataManager
-
getHistoryJobDataManager
-
setHistoryJobDataManager
public JobServiceConfiguration setHistoryJobDataManager(HistoryJobDataManager historyJobDataManager) -
getExternalWorkerJobDataManager
-
setExternalWorkerJobDataManager
public JobServiceConfiguration setExternalWorkerJobDataManager(ExternalWorkerJobDataManager externalWorkerJobDataManager) -
getJobEntityManager
-
setJobEntityManager
-
getDeadLetterJobEntityManager
-
setDeadLetterJobEntityManager
public JobServiceConfiguration setDeadLetterJobEntityManager(DeadLetterJobEntityManager deadLetterJobEntityManager) -
getSuspendedJobEntityManager
-
setSuspendedJobEntityManager
public JobServiceConfiguration setSuspendedJobEntityManager(SuspendedJobEntityManager suspendedJobEntityManager) -
getTimerJobEntityManager
-
setTimerJobEntityManager
public JobServiceConfiguration setTimerJobEntityManager(TimerJobEntityManager timerJobEntityManager) -
getHistoryJobEntityManager
-
setHistoryJobEntityManager
public JobServiceConfiguration setHistoryJobEntityManager(HistoryJobEntityManager historyJobEntityManager) -
getExternalWorkerJobEntityManager
-
setExternalWorkerJobEntityManager
public JobServiceConfiguration setExternalWorkerJobEntityManager(ExternalWorkerJobEntityManager externalWorkerJobEntityManager) -
getCommandExecutor
-
setCommandExecutor
-
getInternalJobManager
-
setInternalJobManager
-
getInternalJobCompatibilityManager
-
setInternalJobCompatibilityManager
public void setInternalJobCompatibilityManager(InternalJobCompatibilityManager internalJobCompatibilityManager) -
getAsyncExecutor
-
setAsyncExecutor
-
getAsyncHistoryExecutor
-
setAsyncHistoryExecutor
-
getAsyncHistoryExecutorNumberOfRetries
public int getAsyncHistoryExecutorNumberOfRetries() -
setAsyncHistoryExecutorNumberOfRetries
public JobServiceConfiguration setAsyncHistoryExecutorNumberOfRetries(int asyncHistoryExecutorNumberOfRetries) -
getJobExecutionScope
-
setJobExecutionScope
-
getHistoryJobExecutionScope
-
setHistoryJobExecutionScope
-
getExpressionManager
-
setExpressionManager
-
getBusinessCalendarManager
-
setBusinessCalendarManager
public JobServiceConfiguration setBusinessCalendarManager(BusinessCalendarManager businessCalendarManager) -
getJobHandlers
-
setJobHandlers
-
addJobHandler
-
getFailedJobCommandFactory
-
setFailedJobCommandFactory
public JobServiceConfiguration setFailedJobCommandFactory(FailedJobCommandFactory failedJobCommandFactory) -
getAsyncRunnableExecutionExceptionHandlers
-
setAsyncRunnableExecutionExceptionHandlers
public JobServiceConfiguration setAsyncRunnableExecutionExceptionHandlers(List<AsyncRunnableExecutionExceptionHandler> asyncRunnableExecutionExceptionHandlers) -
getHistoryJobHandlers
-
setHistoryJobHandlers
public JobServiceConfiguration setHistoryJobHandlers(Map<String, HistoryJobHandler> historyJobHandlers) -
addHistoryJobHandler
public JobServiceConfiguration addHistoryJobHandler(String type, HistoryJobHandler historyJobHandler) -
mergeHistoryJobHandler
Registers the givenHistoryJobHandlerunder the provided type and checks for existing default and internalHistoryJobHandlerinstances to be of the same class. If no such instances are found, aaddHistoryJobHandler(String, HistoryJobHandler)is done. If such instances are found, they are merged, meaning theHistoryJsonTransformerinstances of the providedHistoryJobHandlerare copied into the already registeredHistoryJobHandlerand vice versa. If a type is already registered, the provided history job handler is simply ignored. This is especially useful when multiple engines (e.g. bpmn and cmmn) share an async history executor. In this case, bothAsyncHistoryJobHandlerinstances should be able to handle history jobs from any engine. -
copyHistoryJsonTransformers
protected void copyHistoryJsonTransformers(AsyncHistoryJobHandler source, AsyncHistoryJobHandler target) -
getAsyncExecutorNumberOfRetries
public int getAsyncExecutorNumberOfRetries() -
setAsyncExecutorNumberOfRetries
-
getAsyncExecutorResetExpiredJobsMaxTimeout
public int getAsyncExecutorResetExpiredJobsMaxTimeout() -
setAsyncExecutorResetExpiredJobsMaxTimeout
public JobServiceConfiguration setAsyncExecutorResetExpiredJobsMaxTimeout(int asyncExecutorResetExpiredJobsMaxTimeout) -
getObjectMapper
public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()- Overrides:
getObjectMapperin classAbstractServiceConfiguration
-
setObjectMapper
public JobServiceConfiguration setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) - Overrides:
setObjectMapperin classAbstractServiceConfiguration
-
getJobProcessors
-
setJobProcessors
-
getHistoryJobProcessors
-
setHistoryJobProcessors
public JobServiceConfiguration setHistoryJobProcessors(List<HistoryJobProcessor> historyJobProcessors) -
setJobParentStateResolver
-
getJobParentStateResolver
-
getEnabledJobCategories
-
setEnabledJobCategories
-
addEnabledJobCategory
-
getJobTypeAsyncHistory
-
setJobTypeAsyncHistory
-
getJobTypeAsyncHistoryZipped
-
setJobTypeAsyncHistoryZipped
-
isAsyncHistoryJsonGzipCompressionEnabled
public boolean isAsyncHistoryJsonGzipCompressionEnabled() -
setAsyncHistoryJsonGzipCompressionEnabled
public void setAsyncHistoryJsonGzipCompressionEnabled(boolean asyncHistoryJsonGzipCompressionEnabled) -
isAsyncHistoryJsonGroupingEnabled
public boolean isAsyncHistoryJsonGroupingEnabled() -
setAsyncHistoryJsonGroupingEnabled
public void setAsyncHistoryJsonGroupingEnabled(boolean asyncHistoryJsonGroupingEnabled) -
isAsyncHistoryExecutorMessageQueueMode
public boolean isAsyncHistoryExecutorMessageQueueMode() -
setAsyncHistoryExecutorMessageQueueMode
public void setAsyncHistoryExecutorMessageQueueMode(boolean asyncHistoryExecutorMessageQueueMode) -
getAsyncHistoryJsonGroupingThreshold
public int getAsyncHistoryJsonGroupingThreshold() -
setAsyncHistoryJsonGroupingThreshold
public void setAsyncHistoryJsonGroupingThreshold(int asyncHistoryJsonGroupingThreshold)
-