Package org.flowable.job.service

Class JobServiceConfiguration

java.lang.Object

org.flowable.common.engine.impl.AbstractServiceConfiguration<JobServiceConfiguration>

org.flowable.job.service.JobServiceConfiguration

public class JobServiceConfiguration
extends AbstractServiceConfiguration<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

Fields

Modifier and Type	Field	Description
protected AsyncExecutor	asyncExecutor
protected int	asyncExecutorNumberOfRetries
protected int	asyncExecutorResetExpiredJobsMaxTimeout
protected AsyncExecutor	asyncHistoryExecutor
protected int	asyncHistoryExecutorNumberOfRetries
protected List<AsyncRunnableExecutionExceptionHandler>	asyncRunnableExecutionExceptionHandlers
protected BusinessCalendarManager	businessCalendarManager
protected CommandExecutor	commandExecutor
protected DeadLetterJobDataManager	deadLetterJobDataManager
protected DeadLetterJobEntityManager	deadLetterJobEntityManager
protected List<String>	enabledJobCategories
protected ExpressionManager	expressionManager
protected ExternalWorkerJobDataManager	externalWorkerJobDataManager
protected ExternalWorkerJobEntityManager	externalWorkerJobEntityManager
protected FailedJobCommandFactory	failedJobCommandFactory
protected HistoryJobDataManager	historyJobDataManager
protected HistoryJobEntityManager	historyJobEntityManager
protected String	historyJobExecutionScope
protected Map<String,HistoryJobHandler>	historyJobHandlers
protected List<HistoryJobProcessor>	historyJobProcessors
protected HistoryJobService	historyJobService
protected InternalJobCompatibilityManager	internalJobCompatibilityManager
protected InternalJobManager	internalJobManager
static final String	JOB_EXECUTION_SCOPE_ALL
static final String	JOB_EXECUTION_SCOPE_CMMN
protected JobDataManager	jobDataManager
protected JobEntityManager	jobEntityManager
protected String	jobExecutionScope
protected Map<String,JobHandler>	jobHandlers
protected JobManager	jobManager
protected InternalJobParentStateResolver	jobParentStateResolver
protected List<JobProcessor>	jobProcessors
protected JobService	jobService
protected SuspendedJobDataManager	suspendedJobDataManager
protected SuspendedJobEntityManager	suspendedJobEntityManager
protected TimerJobDataManager	timerJobDataManager
protected TimerJobEntityManager	timerJobEntityManager
protected TimerJobScheduler	timerJobScheduler
protected TimerJobService	timerJobService

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

additionalEventDispatchActions, clock, configurators, enableEventDispatcher, engineName, eventDispatcher, eventListeners, idGenerator, logger, NO_TENANT_ID, objectMapper, typedEventListeners

Constructor Summary

Constructors

Constructor	Description
JobServiceConfiguration(String engineName)

Method Summary

Modifier and Type	Method	Description
void	addEnabledJobCategory(String jobCategory)
JobServiceConfiguration	addHistoryJobHandler(String type, HistoryJobHandler historyJobHandler)
JobServiceConfiguration	addJobHandler(String type, JobHandler jobHandler)
AsyncExecutor	getAsyncExecutor()
int	getAsyncExecutorNumberOfRetries()
int	getAsyncExecutorResetExpiredJobsMaxTimeout()
AsyncExecutor	getAsyncHistoryExecutor()
int	getAsyncHistoryExecutorNumberOfRetries()
List<AsyncRunnableExecutionExceptionHandler>	getAsyncRunnableExecutionExceptionHandlers()
BusinessCalendarManager	getBusinessCalendarManager()
CommandExecutor	getCommandExecutor()
DeadLetterJobDataManager	getDeadLetterJobDataManager()
DeadLetterJobEntityManager	getDeadLetterJobEntityManager()
List<String>	getEnabledJobCategories()
ExpressionManager	getExpressionManager()
ExternalWorkerJobDataManager	getExternalWorkerJobDataManager()
ExternalWorkerJobEntityManager	getExternalWorkerJobEntityManager()
FailedJobCommandFactory	getFailedJobCommandFactory()
HistoryJobDataManager	getHistoryJobDataManager()
HistoryJobEntityManager	getHistoryJobEntityManager()
String	getHistoryJobExecutionScope()
Map<String,HistoryJobHandler>	getHistoryJobHandlers()
List<HistoryJobProcessor>	getHistoryJobProcessors()
HistoryJobService	getHistoryJobService()
JobServiceConfiguration	getIdentityLinkServiceConfiguration()
InternalJobCompatibilityManager	getInternalJobCompatibilityManager()
InternalJobManager	getInternalJobManager()
JobDataManager	getJobDataManager()
JobEntityManager	getJobEntityManager()
String	getJobExecutionScope()
Map<String,JobHandler>	getJobHandlers()
JobManager	getJobManager()
InternalJobParentStateResolver	getJobParentStateResolver()
List<JobProcessor>	getJobProcessors()
JobService	getJobService()
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
protected JobServiceConfiguration	getService()
SuspendedJobDataManager	getSuspendedJobDataManager()
SuspendedJobEntityManager	getSuspendedJobEntityManager()
TimerJobDataManager	getTimerJobDataManager()
TimerJobEntityManager	getTimerJobEntityManager()
TimerJobScheduler	getTimerJobScheduler()
TimerJobService	getTimerJobService()
void	init()
void	initDataManagers()
void	initEntityManagers()
void	initJobManager()
protected void	initTimerJobScheduler()
JobServiceConfiguration	setAsyncExecutor(AsyncExecutor asyncExecutor)
JobServiceConfiguration	setAsyncExecutorNumberOfRetries(int asyncExecutorNumberOfRetries)
JobServiceConfiguration	setAsyncExecutorResetExpiredJobsMaxTimeout(int asyncExecutorResetExpiredJobsMaxTimeout)
JobServiceConfiguration	setAsyncHistoryExecutor(AsyncExecutor asyncHistoryExecutor)
JobServiceConfiguration	setAsyncHistoryExecutorNumberOfRetries(int asyncHistoryExecutorNumberOfRetries)
JobServiceConfiguration	setAsyncRunnableExecutionExceptionHandlers(List<AsyncRunnableExecutionExceptionHandler> asyncRunnableExecutionExceptionHandlers)
JobServiceConfiguration	setBusinessCalendarManager(BusinessCalendarManager businessCalendarManager)
void	setCommandExecutor(CommandExecutor commandExecutor)
JobServiceConfiguration	setDeadLetterJobDataManager(DeadLetterJobDataManager deadLetterJobDataManager)
JobServiceConfiguration	setDeadLetterJobEntityManager(DeadLetterJobEntityManager deadLetterJobEntityManager)
void	setEnabledJobCategories(List<String> enabledJobCategories)
JobServiceConfiguration	setExpressionManager(ExpressionManager expressionManager)
JobServiceConfiguration	setExternalWorkerJobDataManager(ExternalWorkerJobDataManager externalWorkerJobDataManager)
JobServiceConfiguration	setExternalWorkerJobEntityManager(ExternalWorkerJobEntityManager externalWorkerJobEntityManager)
JobServiceConfiguration	setFailedJobCommandFactory(FailedJobCommandFactory failedJobCommandFactory)
JobServiceConfiguration	setHistoryJobDataManager(HistoryJobDataManager historyJobDataManager)
JobServiceConfiguration	setHistoryJobEntityManager(HistoryJobEntityManager historyJobEntityManager)
JobServiceConfiguration	setHistoryJobExecutionScope(String historyJobExecutionScope)
JobServiceConfiguration	setHistoryJobHandlers(Map<String,HistoryJobHandler> historyJobHandlers)
JobServiceConfiguration	setHistoryJobProcessors(List<HistoryJobProcessor> historyJobProcessors)
JobServiceConfiguration	setHistoryJobService(HistoryJobService historyJobService)
void	setInternalJobCompatibilityManager(InternalJobCompatibilityManager internalJobCompatibilityManager)
void	setInternalJobManager(InternalJobManager internalJobManager)
JobServiceConfiguration	setJobDataManager(JobDataManager jobDataManager)
JobServiceConfiguration	setJobEntityManager(JobEntityManager jobEntityManager)
JobServiceConfiguration	setJobExecutionScope(String jobExecutionScope)
JobServiceConfiguration	setJobHandlers(Map<String,JobHandler> jobHandlers)
void	setJobManager(JobManager jobManager)
void	setJobParentStateResolver(InternalJobParentStateResolver jobParentStateResolver)
JobServiceConfiguration	setJobProcessors(List<JobProcessor> jobProcessors)
JobServiceConfiguration	setJobService(JobService jobService)
JobServiceConfiguration	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
JobServiceConfiguration	setSuspendedJobDataManager(SuspendedJobDataManager suspendedJobDataManager)
JobServiceConfiguration	setSuspendedJobEntityManager(SuspendedJobEntityManager suspendedJobEntityManager)
JobServiceConfiguration	setTimerJobDataManager(TimerJobDataManager timerJobDataManager)
JobServiceConfiguration	setTimerJobEntityManager(TimerJobEntityManager timerJobEntityManager)
void	setTimerJobScheduler(TimerJobScheduler timerJobScheduler)
JobServiceConfiguration	setTimerJobService(TimerJobService timerJobService)

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

addConfigurator, configuratorsAfterInit, configuratorsBeforeInit, getAdditionalEventDispatchActions, getClock, getConfigurators, getEngineName, getEventDispatcher, getEventListeners, getIdGenerator, getTypedEventListeners, initConfigurators, isEnableEventDispatcher, isEventDispatcherEnabled, setAdditionalEventDispatchActions, setClock, setConfigurators, setEnableEventDispatcher, setEngineName, setEventDispatcher, setEventListeners, setIdGenerator, setTypedEventListeners

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

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

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

enabledJobCategories

protected List<String> enabledJobCategories

asyncHistoryExecutor

protected AsyncExecutor asyncHistoryExecutor

asyncHistoryExecutorNumberOfRetries

protected int asyncHistoryExecutorNumberOfRetries

historyJobExecutionScope

protected String historyJobExecutionScope

historyJobHandlers

protected Map<String,HistoryJobHandler> historyJobHandlers

historyJobProcessors

protected List<HistoryJobProcessor> historyJobProcessors

Constructor Details

JobServiceConfiguration

public JobServiceConfiguration(String engineName)

Method Details

getService

protected JobServiceConfiguration getService()

Specified by:

getService in class AbstractServiceConfiguration<JobServiceConfiguration>

init

public void init()

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)

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)

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:

getObjectMapper in class AbstractServiceConfiguration<JobServiceConfiguration>

setObjectMapper

public JobServiceConfiguration setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Overrides:

setObjectMapper in class AbstractServiceConfiguration<JobServiceConfiguration>

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

getEnabledJobCategories

public List<String> getEnabledJobCategories()

setEnabledJobCategories

public void setEnabledJobCategories(List<String> enabledJobCategories)

addEnabledJobCategory

public void addEnabledJobCategory(String jobCategory)