Package org.flowable.job.service.impl.asyncexecutor

Class DefaultJobManager

java.lang.Object

org.flowable.job.service.impl.asyncexecutor.DefaultJobManager

All Implemented Interfaces:

JobManager

Direct Known Subclasses:

AbstractMessageBasedJobManager

public class DefaultJobManager
extends Object
implements JobManager

Field Summary

Fields

Modifier and Type	Field	Description
static String	CYCLE_TYPE
protected JobServiceConfiguration	jobServiceConfiguration

Constructor Summary

Constructors

Constructor	Description
DefaultJobManager(JobServiceConfiguration jobServiceConfiguration)

Method Summary

Modifier and Type	Method	Description
AbstractRuntimeJobEntity	activateSuspendedJob(SuspendedJobEntity job)	Transforms a SuspendedJobEntity back to an AbstractRuntimeJobEntity (i.e.
void	bulkMoveTimerJobsToExecutableJobs(List<TimerJobEntity> timerJobEntities)	Moves a collection of TimerJobEntity instances to become async JobEntity instances (the timer is deleted and a new async job is inserted).
protected void	callHistoryJobProcessors(HistoryJobProcessorContext.Phase processorType, HistoryJobEntity historyJobEntity)
protected void	callJobProcessors(JobProcessorContext.Phase processorType, AbstractJobEntity abstractJobEntity)
protected HistoryJobEntity	copyHistoryJobInfo(HistoryJobEntity copyToJob, HistoryJobEntity copyFromJob)
protected AbstractJobEntity	copyHistoryJobProperties(AbstractJobEntity copyToJob, AbstractJobEntity copyFromJob)
AbstractRuntimeJobEntity	copyJobInfo(AbstractRuntimeJobEntity copyToJob, AbstractRuntimeJobEntity copyFromJob)	Copy job info from one job to the other
protected void	createAsyncHistoryHintListeners(HistoryJobEntity historyJobEntity)
void	createAsyncJob(JobEntity jobEntity, boolean exclusive)	Creates an async job so that it can be continued later in a background thread.
DeadLetterJobEntity	createDeadLetterJobFromHistoryJob(HistoryJobEntity historyJobEntity)	Create a dead letter job from a history job.
DeadLetterJobEntity	createDeadLetterJobFromOtherJob(AbstractRuntimeJobEntity otherJob)	Create a dead letter job from another job
JobEntity	createExecutableJobFromOtherJob(AbstractRuntimeJobEntity job)	Create an executable job from another job
protected JobEntity	createExecutableJobFromOtherJob(AbstractRuntimeJobEntity job, boolean lockJob)
ExternalWorkerJobEntity	createExternalWorkerJobFromOtherJob(AbstractRuntimeJobEntity otherJob)	Create an external worker job from another job
protected void	createHintListeners(AsyncExecutor asyncExecutor, JobInfoEntity job)
SuspendedJobEntity	createSuspendedJobFromOtherJob(AbstractRuntimeJobEntity otherJob)	Create a suspended job from another job
TimerJobEntity	createTimerJobFromOtherJob(AbstractRuntimeJobEntity otherJob)	Create a timer job from another job
void	execute(JobInfo job)	Execute a job, which means that the logic (async logic, timer that fires, etc) is executed, typically by a background thread of an executor.
protected void	executeHistoryJob(HistoryJobEntity historyJobEntity)
protected void	executeHistoryJobHandler(HistoryJobEntity historyJobEntity)
protected void	executeJobHandler(JobEntity jobEntity)
protected void	executeMessageJob(JobEntity jobEntity)
protected void	executeTimerJob(JobEntity timerEntity)
protected void	fillDefaultAsyncJobInfo(JobEntity jobEntity, boolean exclusive)
protected AsyncExecutor	getAsyncExecutor()
protected AsyncExecutor	getAsyncHistoryExecutor()
protected String	getBusinessCalendarName(String calendarName, org.flowable.variable.api.delegate.VariableScope variableScope)
String	getBusinessCalendarName(JobEntity timerEntity, org.flowable.variable.api.delegate.VariableScope variableScope)	Get the business calendar name of the job configuration
protected CommandContext	getCommandContext()
protected String	getExceptionStacktrace(Throwable exception)
JobServiceConfiguration	getJobServiceConfiguration()
protected void	hintAsyncExecutor(JobEntity job)
protected void	hintAsyncHistoryExecutor(HistoryJobEntity historyJobEntity)
protected void	internalCreateAsyncJob(JobEntity jobEntity, boolean exclusive)
protected void	internalCreateLockedAsyncJob(JobEntity jobEntity, boolean exclusive)
protected boolean	isAsyncExecutorActive()
protected boolean	isAsyncExecutorRemainingCapacitySufficient(int neededCapacity)
protected boolean	isAsyncHistoryExecutorActive()
protected boolean	isExecutorActive(AsyncExecutor asyncExecutor)
protected boolean	isValidTime(JobEntity timerEntity, Date newTimerDate, org.flowable.variable.api.delegate.VariableScope variableScope)
Job	moveDeadLetterJobToExecutableJob(DeadLetterJobEntity deadLetterJobEntity, int retries)	Transforms a DeadLetterJobEntity to a Job, thus making it executable again.
HistoryJobEntity	moveDeadLetterJobToHistoryJob(DeadLetterJobEntity deadLetterJobEntity, int retries)	Transforms a DeadLetterJobEntity to a HistoryJob, thus making it executable again (by the async history executor).
JobEntity	moveExternalWorkerJobToExecutableJob(ExternalWorkerJobEntity externalWorkerJob)	Moves an ExternalWorkerJobEntity to become an async JobEntity.
DeadLetterJobEntity	moveJobToDeadLetterJob(AbstractRuntimeJobEntity job)	Transforms an AbstractRuntimeJobEntity to a DeadLetterJobEntity.
SuspendedJobEntity	moveJobToSuspendedJob(AbstractRuntimeJobEntity job)	Moves an AbstractRuntimeJobEntity to become a SuspendedJobEntity, such that the AsyncExecutor won't pick it up anymore for execution.
TimerJobEntity	moveJobToTimerJob(AbstractRuntimeJobEntity job)	Moves an AbstractRuntimeJobEntity to become a TimerJobEntity.
JobEntity	moveTimerJobToExecutableJob(TimerJobEntity timerJob)	Moves a TimerJobEntity to become an async JobEntity.
void	scheduleAsyncJob(JobEntity jobEntity)	Schedules and async job.
HistoryJobEntity	scheduleHistoryJob(HistoryJobEntity historyJobEntity)	schedules a HistoryJobEntity, meaning it will be scheduled (inserted in the database/put on a queue/...) to be executed at a later point in time.
void	scheduleTimerJob(TimerJobEntity timerJob)	Schedules a timer, meaning it will be inserted in the datastore.
protected void	sendMoveToDeadletterEvent(JobInfo job)
void	setJobServiceConfiguration(JobServiceConfiguration jobServiceConfiguration)	The ProcessEngineConfiguration instance will be passed when the ProcessEngine is built.
protected void	setLockTimeAndOwner(AsyncExecutor asyncExecutor, JobInfoEntity jobInfoEntity)
protected void	triggerAsyncHistoryExecutorIfNeeded(HistoryJobEntity historyJobEntity)
protected void	triggerExecutorIfNeeded(JobEntity jobEntity)
void	unacquire(JobInfo job)	Unacquires a job, meaning that this job was previously locked, and it is now freed to be acquired by other executor nodes.
void	unacquireWithDecrementRetries(JobInfo job, Throwable exception)	Unacquires a job, meaning that this job was previously locked, and it is now freed to be acquired by other executor nodes.

Methods inherited from class java.lang.Object

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

Field Detail

CYCLE_TYPE

public static final String CYCLE_TYPE

See Also:

Constant Field Values

jobServiceConfiguration

protected JobServiceConfiguration jobServiceConfiguration

Constructor Detail

DefaultJobManager

public DefaultJobManager(JobServiceConfiguration jobServiceConfiguration)

Method Detail

createAsyncJob

public void createAsyncJob(JobEntity jobEntity,
                           boolean exclusive)

Description copied from interface: JobManager

Creates an async job so that it can be continued later in a background thread.

Specified by:

createAsyncJob in interface JobManager

scheduleAsyncJob

public void scheduleAsyncJob(JobEntity jobEntity)

Description copied from interface: JobManager

Schedules and async job. If the AsyncExecutor is running, it can be executed immediately after the transaction. Otherwise it can be picked up by other executors.

Specified by:

scheduleAsyncJob in interface JobManager

triggerExecutorIfNeeded

protected void triggerExecutorIfNeeded(JobEntity jobEntity)

scheduleTimerJob

public void scheduleTimerJob(TimerJobEntity timerJob)

Description copied from interface: JobManager

Schedules a timer, meaning it will be inserted in the datastore.

Specified by:

scheduleTimerJob in interface JobManager

moveTimerJobToExecutableJob

public JobEntity moveTimerJobToExecutableJob(TimerJobEntity timerJob)

Description copied from interface: JobManager

Moves a TimerJobEntity to become an async JobEntity. This happens for example when the due date of a timer is reached, the timer entity then becomes a 'regular' async job that can be picked up by the AsyncExecutor.

Specified by:

moveTimerJobToExecutableJob in interface JobManager

bulkMoveTimerJobsToExecutableJobs

public void bulkMoveTimerJobsToExecutableJobs(List<TimerJobEntity> timerJobEntities)

Description copied from interface: JobManager

Moves a collection of TimerJobEntity instances to become async JobEntity instances (the timer is deleted and a new async job is inserted). Note that there are no revision checks happening on the TimerJobEntity instances, this means this method should only be used when running with a global acquire lock.

Specified by:

bulkMoveTimerJobsToExecutableJobs in interface JobManager

moveExternalWorkerJobToExecutableJob

public JobEntity moveExternalWorkerJobToExecutableJob(ExternalWorkerJobEntity externalWorkerJob)

Description copied from interface: JobManager

Moves an ExternalWorkerJobEntity to become an async JobEntity. This happens when the external worker has completed the work and the external work job then becomes a 'regular' async job that can be picked up by the AsyncExecutor.

Specified by:

moveExternalWorkerJobToExecutableJob in interface JobManager

moveJobToTimerJob

public TimerJobEntity moveJobToTimerJob(AbstractRuntimeJobEntity job)

Description copied from interface: JobManager

Moves an AbstractRuntimeJobEntity to become a TimerJobEntity. This happens for example when an async job is executed and fails. It then becomes a timer, as it needs to be retried later.

Specified by:

moveJobToTimerJob in interface JobManager

moveJobToSuspendedJob

public SuspendedJobEntity moveJobToSuspendedJob(AbstractRuntimeJobEntity job)

Description copied from interface: JobManager

Moves an AbstractRuntimeJobEntity to become a SuspendedJobEntity, such that the AsyncExecutor won't pick it up anymore for execution.

Specified by:

moveJobToSuspendedJob in interface JobManager

activateSuspendedJob

public AbstractRuntimeJobEntity activateSuspendedJob(SuspendedJobEntity job)

Description copied from interface: JobManager

Transforms a SuspendedJobEntity back to an AbstractRuntimeJobEntity (i.e. to what it was originally). The job will now again be able to picked up by the AsyncExecutor.

Specified by:

activateSuspendedJob in interface JobManager

moveJobToDeadLetterJob

public DeadLetterJobEntity moveJobToDeadLetterJob(AbstractRuntimeJobEntity job)

Description copied from interface: JobManager

Transforms an AbstractRuntimeJobEntity to a DeadLetterJobEntity. This means that the job has been tried a configurable amount of times, but kept failing.

Specified by:

moveJobToDeadLetterJob in interface JobManager

sendMoveToDeadletterEvent

protected void sendMoveToDeadletterEvent(JobInfo job)

moveDeadLetterJobToExecutableJob

public Job moveDeadLetterJobToExecutableJob(DeadLetterJobEntity deadLetterJobEntity,
                                            int retries)

Description copied from interface: JobManager

Transforms a DeadLetterJobEntity to a Job, thus making it executable again. Note that a 'retries' parameter needs to be passed, as the job got into the deadletter table because of it failed and retries became 0.

Specified by:

moveDeadLetterJobToExecutableJob in interface JobManager

moveDeadLetterJobToHistoryJob

public HistoryJobEntity moveDeadLetterJobToHistoryJob(DeadLetterJobEntity deadLetterJobEntity,
                                                      int retries)

Description copied from interface: JobManager

Transforms a DeadLetterJobEntity to a HistoryJob, thus making it executable again (by the async history executor). Note that a 'retries' parameter needs to be passed, as the job got into the deadletter table because of it failed and retries became 0.

Specified by:

moveDeadLetterJobToHistoryJob in interface JobManager

execute

public void execute(JobInfo job)

Description copied from interface: JobManager

Execute a job, which means that the logic (async logic, timer that fires, etc) is executed, typically by a background thread of an executor.

Specified by:

execute in interface JobManager

unacquire

public void unacquire(JobInfo job)

Description copied from interface: JobManager

Unacquires a job, meaning that this job was previously locked, and it is now freed to be acquired by other executor nodes.

Specified by:

unacquire in interface JobManager

unacquireWithDecrementRetries

public void unacquireWithDecrementRetries(JobInfo job,
                                          Throwable exception)

Description copied from interface: JobManager

Unacquires a job, meaning that this job was previously locked, and it is now freed to be acquired by other executor nodes.

Specified by:

unacquireWithDecrementRetries in interface JobManager

getExceptionStacktrace

protected String getExceptionStacktrace(Throwable exception)

executeMessageJob

protected void executeMessageJob(JobEntity jobEntity)

executeHistoryJob

protected void executeHistoryJob(HistoryJobEntity historyJobEntity)

executeTimerJob

protected void executeTimerJob(JobEntity timerEntity)

executeJobHandler

protected void executeJobHandler(JobEntity jobEntity)

executeHistoryJobHandler

protected void executeHistoryJobHandler(HistoryJobEntity historyJobEntity)

isValidTime

protected boolean isValidTime(JobEntity timerEntity,
                              Date newTimerDate,
                              org.flowable.variable.api.delegate.VariableScope variableScope)

hintAsyncExecutor

protected void hintAsyncExecutor(JobEntity job)

createHintListeners

protected void createHintListeners(AsyncExecutor asyncExecutor,
                                   JobInfoEntity job)

getBusinessCalendarName

public String getBusinessCalendarName(JobEntity timerEntity,
                                      org.flowable.variable.api.delegate.VariableScope variableScope)

Description copied from interface: JobManager

Get the business calendar name of the job configuration

Specified by:

getBusinessCalendarName in interface JobManager

getBusinessCalendarName

protected String getBusinessCalendarName(String calendarName,
                                         org.flowable.variable.api.delegate.VariableScope variableScope)

scheduleHistoryJob

public HistoryJobEntity scheduleHistoryJob(HistoryJobEntity historyJobEntity)

Description copied from interface: JobManager

schedules a HistoryJobEntity, meaning it will be scheduled (inserted in the database/put on a queue/...) to be executed at a later point in time.

Specified by:

scheduleHistoryJob in interface JobManager

triggerAsyncHistoryExecutorIfNeeded

protected void triggerAsyncHistoryExecutorIfNeeded(HistoryJobEntity historyJobEntity)

hintAsyncHistoryExecutor

protected void hintAsyncHistoryExecutor(HistoryJobEntity historyJobEntity)

createAsyncHistoryHintListeners

protected void createAsyncHistoryHintListeners(HistoryJobEntity historyJobEntity)

internalCreateAsyncJob

protected void internalCreateAsyncJob(JobEntity jobEntity,
                                      boolean exclusive)

internalCreateLockedAsyncJob

protected void internalCreateLockedAsyncJob(JobEntity jobEntity,
                                            boolean exclusive)

setLockTimeAndOwner

protected void setLockTimeAndOwner(AsyncExecutor asyncExecutor,
                                   JobInfoEntity jobInfoEntity)

fillDefaultAsyncJobInfo

protected void fillDefaultAsyncJobInfo(JobEntity jobEntity,
                                       boolean exclusive)

createExecutableJobFromOtherJob

public JobEntity createExecutableJobFromOtherJob(AbstractRuntimeJobEntity job)

Description copied from interface: JobManager

Create an executable job from another job

Specified by:

createExecutableJobFromOtherJob in interface JobManager

createExecutableJobFromOtherJob

protected JobEntity createExecutableJobFromOtherJob(AbstractRuntimeJobEntity job,
                                                    boolean lockJob)

createTimerJobFromOtherJob

public TimerJobEntity createTimerJobFromOtherJob(AbstractRuntimeJobEntity otherJob)

Description copied from interface: JobManager

Create a timer job from another job

Specified by:

createTimerJobFromOtherJob in interface JobManager

createSuspendedJobFromOtherJob

public SuspendedJobEntity createSuspendedJobFromOtherJob(AbstractRuntimeJobEntity otherJob)

Description copied from interface: JobManager

Create a suspended job from another job

Specified by:

createSuspendedJobFromOtherJob in interface JobManager

createDeadLetterJobFromOtherJob

public DeadLetterJobEntity createDeadLetterJobFromOtherJob(AbstractRuntimeJobEntity otherJob)

Description copied from interface: JobManager

Create a dead letter job from another job

Specified by:

createDeadLetterJobFromOtherJob in interface JobManager

createDeadLetterJobFromHistoryJob

public DeadLetterJobEntity createDeadLetterJobFromHistoryJob(HistoryJobEntity historyJobEntity)

Description copied from interface: JobManager

Create a dead letter job from a history job. This is different from JobManager.createDeadLetterJobFromOtherJob(AbstractRuntimeJobEntity), because history jobs have different data and cannot become timer/suspended/executable jobs.

Specified by:

createDeadLetterJobFromHistoryJob in interface JobManager

createExternalWorkerJobFromOtherJob

public ExternalWorkerJobEntity createExternalWorkerJobFromOtherJob(AbstractRuntimeJobEntity otherJob)

Description copied from interface: JobManager

Create an external worker job from another job

Specified by:

createExternalWorkerJobFromOtherJob in interface JobManager

copyJobInfo

public AbstractRuntimeJobEntity copyJobInfo(AbstractRuntimeJobEntity copyToJob,
                                            AbstractRuntimeJobEntity copyFromJob)

Description copied from interface: JobManager

Copy job info from one job to the other

Specified by:

copyJobInfo in interface JobManager

copyHistoryJobInfo

protected HistoryJobEntity copyHistoryJobInfo(HistoryJobEntity copyToJob,
                                              HistoryJobEntity copyFromJob)

copyHistoryJobProperties

protected AbstractJobEntity copyHistoryJobProperties(AbstractJobEntity copyToJob,
                                                     AbstractJobEntity copyFromJob)

getJobServiceConfiguration

public JobServiceConfiguration getJobServiceConfiguration()

setJobServiceConfiguration

public void setJobServiceConfiguration(JobServiceConfiguration jobServiceConfiguration)

Description copied from interface: JobManager

The ProcessEngineConfiguration instance will be passed when the ProcessEngine is built.

Specified by:

setJobServiceConfiguration in interface JobManager

isAsyncExecutorActive

protected boolean isAsyncExecutorActive()

isAsyncExecutorRemainingCapacitySufficient

protected boolean isAsyncExecutorRemainingCapacitySufficient(int neededCapacity)

isAsyncHistoryExecutorActive

protected boolean isAsyncHistoryExecutorActive()

isExecutorActive

protected boolean isExecutorActive(AsyncExecutor asyncExecutor)

getCommandContext

protected CommandContext getCommandContext()

getAsyncExecutor

protected AsyncExecutor getAsyncExecutor()

getAsyncHistoryExecutor

protected AsyncExecutor getAsyncHistoryExecutor()

callJobProcessors

protected void callJobProcessors(JobProcessorContext.Phase processorType,
                                 AbstractJobEntity abstractJobEntity)

callHistoryJobProcessors

protected void callHistoryJobProcessors(HistoryJobProcessorContext.Phase processorType,
                                        HistoryJobEntity historyJobEntity)