Package org.flowable.job.service
Class JobServiceConfiguration
- java.lang.Object
-
- org.flowable.common.engine.impl.AbstractServiceConfiguration
-
- org.flowable.job.service.JobServiceConfiguration
-
public class JobServiceConfiguration extends AbstractServiceConfiguration
This service configuration contains all settings and instances around job execution and management. Note that aJobServiceConfigurationis not shared between engines and instantiated for each engine.- Author:
- Tijs Rademakers
-
-
Field Summary
-
Fields 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 Constructor Description JobServiceConfiguration(String engineName)
-
Method Summary
-
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 Detail
-
JOB_EXECUTION_SCOPE_ALL
public static final String JOB_EXECUTION_SCOPE_ALL
- See Also:
- Constant Field Values
-
JOB_EXECUTION_SCOPE_CMMN
public static final String JOB_EXECUTION_SCOPE_CMMN
- See Also:
- Constant Field Values
-
jobService
protected JobService jobService
-
timerJobService
protected TimerJobService timerJobService
-
historyJobService
protected HistoryJobService historyJobService
-
jobManager
protected JobManager jobManager
-
timerJobScheduler
protected TimerJobScheduler timerJobScheduler
-
configurators
protected Collection<ServiceConfigurator<JobServiceConfiguration>> configurators
-
jobDataManager
protected JobDataManager jobDataManager
-
deadLetterJobDataManager
protected DeadLetterJobDataManager deadLetterJobDataManager
-
suspendedJobDataManager
protected SuspendedJobDataManager suspendedJobDataManager
-
timerJobDataManager
protected TimerJobDataManager timerJobDataManager
-
historyJobDataManager
protected HistoryJobDataManager historyJobDataManager
-
externalWorkerJobDataManager
protected ExternalWorkerJobDataManager externalWorkerJobDataManager
-
jobEntityManager
protected JobEntityManager jobEntityManager
-
deadLetterJobEntityManager
protected DeadLetterJobEntityManager deadLetterJobEntityManager
-
suspendedJobEntityManager
protected SuspendedJobEntityManager suspendedJobEntityManager
-
timerJobEntityManager
protected TimerJobEntityManager timerJobEntityManager
-
historyJobEntityManager
protected HistoryJobEntityManager historyJobEntityManager
-
externalWorkerJobEntityManager
protected ExternalWorkerJobEntityManager externalWorkerJobEntityManager
-
commandExecutor
protected CommandExecutor commandExecutor
-
expressionManager
protected ExpressionManager expressionManager
-
businessCalendarManager
protected BusinessCalendarManager businessCalendarManager
-
internalJobManager
protected InternalJobManager internalJobManager
-
internalJobCompatibilityManager
protected InternalJobCompatibilityManager internalJobCompatibilityManager
-
jobParentStateResolver
protected InternalJobParentStateResolver jobParentStateResolver
-
asyncExecutor
protected AsyncExecutor asyncExecutor
-
asyncExecutorNumberOfRetries
protected int asyncExecutorNumberOfRetries
-
asyncExecutorResetExpiredJobsMaxTimeout
protected int asyncExecutorResetExpiredJobsMaxTimeout
-
jobExecutionScope
protected String jobExecutionScope
-
jobHandlers
protected Map<String,JobHandler> jobHandlers
-
failedJobCommandFactory
protected FailedJobCommandFactory failedJobCommandFactory
-
asyncRunnableExecutionExceptionHandlers
protected List<AsyncRunnableExecutionExceptionHandler> asyncRunnableExecutionExceptionHandlers
-
jobProcessors
protected List<JobProcessor> jobProcessors
-
asyncHistoryExecutor
protected AsyncExecutor asyncHistoryExecutor
-
asyncHistoryExecutorNumberOfRetries
protected int asyncHistoryExecutorNumberOfRetries
-
historyJobExecutionScope
protected String historyJobExecutionScope
-
historyJobHandlers
protected Map<String,HistoryJobHandler> historyJobHandlers
-
historyJobProcessors
protected List<HistoryJobProcessor> historyJobProcessors
-
jobTypeAsyncHistory
protected String jobTypeAsyncHistory
-
jobTypeAsyncHistoryZipped
protected String jobTypeAsyncHistoryZipped
-
asyncHistoryJsonGzipCompressionEnabled
protected boolean asyncHistoryJsonGzipCompressionEnabled
-
asyncHistoryJsonGroupingEnabled
protected boolean asyncHistoryJsonGroupingEnabled
-
asyncHistoryExecutorMessageQueueMode
protected boolean asyncHistoryExecutorMessageQueueMode
-
asyncHistoryJsonGroupingThreshold
protected int asyncHistoryJsonGroupingThreshold
-
-
Constructor Detail
-
JobServiceConfiguration
public JobServiceConfiguration(String engineName)
-
-
Method Detail
-
init
public void init()
-
isHistoryLevelAtLeast
public boolean isHistoryLevelAtLeast(HistoryLevel level)
- Overrides:
isHistoryLevelAtLeastin classAbstractServiceConfiguration
-
isHistoryEnabled
public boolean isHistoryEnabled()
- Overrides:
isHistoryEnabledin classAbstractServiceConfiguration
-
initTimerJobScheduler
protected void initTimerJobScheduler()
-
initJobManager
public void initJobManager()
-
initDataManagers
public void initDataManagers()
-
initEntityManagers
public void initEntityManagers()
-
getIdentityLinkServiceConfiguration
public JobServiceConfiguration getIdentityLinkServiceConfiguration()
-
getJobService
public JobService getJobService()
-
setJobService
public JobServiceConfiguration setJobService(JobService jobService)
-
getTimerJobService
public TimerJobService getTimerJobService()
-
setTimerJobService
public JobServiceConfiguration setTimerJobService(TimerJobService timerJobService)
-
getHistoryJobService
public HistoryJobService getHistoryJobService()
-
setHistoryJobService
public JobServiceConfiguration setHistoryJobService(HistoryJobService historyJobService)
-
getJobManager
public JobManager getJobManager()
-
setJobManager
public void setJobManager(JobManager jobManager)
-
getTimerJobScheduler
public TimerJobScheduler getTimerJobScheduler()
-
setTimerJobScheduler
public void setTimerJobScheduler(TimerJobScheduler timerJobScheduler)
-
getConfigurators
public Collection<ServiceConfigurator<JobServiceConfiguration>> getConfigurators()
-
setConfigurators
public void setConfigurators(Collection<ServiceConfigurator<JobServiceConfiguration>> configurators)
-
getJobDataManager
public JobDataManager getJobDataManager()
-
setJobDataManager
public JobServiceConfiguration setJobDataManager(JobDataManager jobDataManager)
-
getDeadLetterJobDataManager
public DeadLetterJobDataManager getDeadLetterJobDataManager()
-
setDeadLetterJobDataManager
public JobServiceConfiguration setDeadLetterJobDataManager(DeadLetterJobDataManager deadLetterJobDataManager)
-
getSuspendedJobDataManager
public SuspendedJobDataManager getSuspendedJobDataManager()
-
setSuspendedJobDataManager
public JobServiceConfiguration setSuspendedJobDataManager(SuspendedJobDataManager suspendedJobDataManager)
-
getTimerJobDataManager
public TimerJobDataManager getTimerJobDataManager()
-
setTimerJobDataManager
public JobServiceConfiguration setTimerJobDataManager(TimerJobDataManager timerJobDataManager)
-
getHistoryJobDataManager
public HistoryJobDataManager getHistoryJobDataManager()
-
setHistoryJobDataManager
public JobServiceConfiguration setHistoryJobDataManager(HistoryJobDataManager historyJobDataManager)
-
getExternalWorkerJobDataManager
public ExternalWorkerJobDataManager getExternalWorkerJobDataManager()
-
setExternalWorkerJobDataManager
public JobServiceConfiguration setExternalWorkerJobDataManager(ExternalWorkerJobDataManager externalWorkerJobDataManager)
-
getJobEntityManager
public JobEntityManager getJobEntityManager()
-
setJobEntityManager
public JobServiceConfiguration setJobEntityManager(JobEntityManager jobEntityManager)
-
getDeadLetterJobEntityManager
public DeadLetterJobEntityManager getDeadLetterJobEntityManager()
-
setDeadLetterJobEntityManager
public JobServiceConfiguration setDeadLetterJobEntityManager(DeadLetterJobEntityManager deadLetterJobEntityManager)
-
getSuspendedJobEntityManager
public SuspendedJobEntityManager getSuspendedJobEntityManager()
-
setSuspendedJobEntityManager
public JobServiceConfiguration setSuspendedJobEntityManager(SuspendedJobEntityManager suspendedJobEntityManager)
-
getTimerJobEntityManager
public TimerJobEntityManager getTimerJobEntityManager()
-
setTimerJobEntityManager
public JobServiceConfiguration setTimerJobEntityManager(TimerJobEntityManager timerJobEntityManager)
-
getHistoryJobEntityManager
public HistoryJobEntityManager getHistoryJobEntityManager()
-
setHistoryJobEntityManager
public JobServiceConfiguration setHistoryJobEntityManager(HistoryJobEntityManager historyJobEntityManager)
-
getExternalWorkerJobEntityManager
public ExternalWorkerJobEntityManager getExternalWorkerJobEntityManager()
-
setExternalWorkerJobEntityManager
public JobServiceConfiguration setExternalWorkerJobEntityManager(ExternalWorkerJobEntityManager externalWorkerJobEntityManager)
-
getCommandExecutor
public CommandExecutor getCommandExecutor()
-
setCommandExecutor
public void setCommandExecutor(CommandExecutor commandExecutor)
-
getInternalJobManager
public InternalJobManager getInternalJobManager()
-
setInternalJobManager
public void setInternalJobManager(InternalJobManager internalJobManager)
-
getInternalJobCompatibilityManager
public InternalJobCompatibilityManager getInternalJobCompatibilityManager()
-
setInternalJobCompatibilityManager
public void setInternalJobCompatibilityManager(InternalJobCompatibilityManager internalJobCompatibilityManager)
-
getAsyncExecutor
public AsyncExecutor getAsyncExecutor()
-
setAsyncExecutor
public JobServiceConfiguration setAsyncExecutor(AsyncExecutor asyncExecutor)
-
getAsyncHistoryExecutor
public AsyncExecutor getAsyncHistoryExecutor()
-
setAsyncHistoryExecutor
public JobServiceConfiguration setAsyncHistoryExecutor(AsyncExecutor asyncHistoryExecutor)
-
getAsyncHistoryExecutorNumberOfRetries
public int getAsyncHistoryExecutorNumberOfRetries()
-
setAsyncHistoryExecutorNumberOfRetries
public JobServiceConfiguration setAsyncHistoryExecutorNumberOfRetries(int asyncHistoryExecutorNumberOfRetries)
-
getJobExecutionScope
public String getJobExecutionScope()
-
setJobExecutionScope
public JobServiceConfiguration setJobExecutionScope(String jobExecutionScope)
-
getHistoryJobExecutionScope
public String getHistoryJobExecutionScope()
-
setHistoryJobExecutionScope
public JobServiceConfiguration setHistoryJobExecutionScope(String historyJobExecutionScope)
-
getExpressionManager
public ExpressionManager getExpressionManager()
-
setExpressionManager
public JobServiceConfiguration setExpressionManager(ExpressionManager expressionManager)
-
getBusinessCalendarManager
public BusinessCalendarManager getBusinessCalendarManager()
-
setBusinessCalendarManager
public JobServiceConfiguration setBusinessCalendarManager(BusinessCalendarManager businessCalendarManager)
-
getJobHandlers
public Map<String,JobHandler> getJobHandlers()
-
setJobHandlers
public JobServiceConfiguration setJobHandlers(Map<String,JobHandler> jobHandlers)
-
addJobHandler
public JobServiceConfiguration addJobHandler(String type, JobHandler jobHandler)
-
getFailedJobCommandFactory
public FailedJobCommandFactory getFailedJobCommandFactory()
-
setFailedJobCommandFactory
public JobServiceConfiguration setFailedJobCommandFactory(FailedJobCommandFactory failedJobCommandFactory)
-
getAsyncRunnableExecutionExceptionHandlers
public List<AsyncRunnableExecutionExceptionHandler> getAsyncRunnableExecutionExceptionHandlers()
-
setAsyncRunnableExecutionExceptionHandlers
public JobServiceConfiguration setAsyncRunnableExecutionExceptionHandlers(List<AsyncRunnableExecutionExceptionHandler> asyncRunnableExecutionExceptionHandlers)
-
getHistoryJobHandlers
public Map<String,HistoryJobHandler> getHistoryJobHandlers()
-
setHistoryJobHandlers
public JobServiceConfiguration setHistoryJobHandlers(Map<String,HistoryJobHandler> historyJobHandlers)
-
addHistoryJobHandler
public JobServiceConfiguration addHistoryJobHandler(String type, HistoryJobHandler historyJobHandler)
-
mergeHistoryJobHandler
public JobServiceConfiguration mergeHistoryJobHandler(HistoryJobHandler historyJobHandler)
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
public JobServiceConfiguration setAsyncExecutorNumberOfRetries(int asyncExecutorNumberOfRetries)
-
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
public List<JobProcessor> getJobProcessors()
-
setJobProcessors
public JobServiceConfiguration setJobProcessors(List<JobProcessor> jobProcessors)
-
getHistoryJobProcessors
public List<HistoryJobProcessor> getHistoryJobProcessors()
-
setHistoryJobProcessors
public JobServiceConfiguration setHistoryJobProcessors(List<HistoryJobProcessor> historyJobProcessors)
-
setJobParentStateResolver
public void setJobParentStateResolver(InternalJobParentStateResolver jobParentStateResolver)
-
getJobParentStateResolver
public InternalJobParentStateResolver getJobParentStateResolver()
-
addEnabledJobCategory
public void addEnabledJobCategory(String jobCategory)
-
getJobTypeAsyncHistory
public String getJobTypeAsyncHistory()
-
setJobTypeAsyncHistory
public void setJobTypeAsyncHistory(String jobTypeAsyncHistory)
-
getJobTypeAsyncHistoryZipped
public String getJobTypeAsyncHistoryZipped()
-
setJobTypeAsyncHistoryZipped
public void setJobTypeAsyncHistoryZipped(String jobTypeAsyncHistoryZipped)
-
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)
-
-