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

Interface JobManager

All Known Implementing Classes:

DefaultJobManager

public interface JobManager

Contains methods that are not tied to any specific job type (async, timer, suspended or deadletter), but which are generally applicable or are about going from one type to another.

Author:

Tijs Rademakers, Joram Barrez

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).
AbstractRuntimeJobEntity	copyJobInfo(AbstractRuntimeJobEntity copyToJob, AbstractRuntimeJobEntity copyFromJob)	Copy job info from one job to the other
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
ExternalWorkerJobEntity	createExternalWorkerJobFromOtherJob(AbstractRuntimeJobEntity otherJob)	Create an external worker job from another job
SuspendedJobEntity	createSuspendedJobFromOtherJob(AbstractRuntimeJobEntity otherJob)	Create a suspended job from another job
TimerJobEntity	createTimerJobFromOtherJob(AbstractRuntimeJobEntity otherJob)	Create a timer job from another job
void	deleteExecutableJob(JobInfo 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.
String	getBusinessCalendarName(JobEntity timerEntity, VariableScope variableScope)	Get the business calendar name of the job configuration
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 job)	Schedules and async job.
HistoryJobEntity	scheduleHistoryJob(HistoryJobEntity historyJobEntity, TransactionContext transactionContext)	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.
void	setJobServiceConfiguration(JobServiceConfiguration jobServiceConfiguration)	The ProcessEngineConfiguration instance will be passed when the ProcessEngine is built.
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.

Method Details

execute

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.

unacquire

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.

unacquireWithDecrementRetries

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.

createAsyncJob

void createAsyncJob(JobEntity jobEntity,
 boolean exclusive)

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

scheduleAsyncJob

void scheduleAsyncJob(JobEntity job)

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.

scheduleTimerJob

void scheduleTimerJob(TimerJobEntity timerJob)

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

getBusinessCalendarName

String getBusinessCalendarName(JobEntity timerEntity,
 VariableScope variableScope)

Get the business calendar name of the job configuration

moveTimerJobToExecutableJob

JobEntity moveTimerJobToExecutableJob(TimerJobEntity timerJob)

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.

bulkMoveTimerJobsToExecutableJobs

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

moveExternalWorkerJobToExecutableJob

JobEntity moveExternalWorkerJobToExecutableJob(ExternalWorkerJobEntity externalWorkerJob)

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.

moveJobToTimerJob

TimerJobEntity moveJobToTimerJob(AbstractRuntimeJobEntity job)

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.

moveJobToSuspendedJob

SuspendedJobEntity moveJobToSuspendedJob(AbstractRuntimeJobEntity job)

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

activateSuspendedJob

AbstractRuntimeJobEntity activateSuspendedJob(SuspendedJobEntity job)

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.

moveJobToDeadLetterJob

DeadLetterJobEntity moveJobToDeadLetterJob(AbstractRuntimeJobEntity job)

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

moveDeadLetterJobToExecutableJob

Job moveDeadLetterJobToExecutableJob(DeadLetterJobEntity deadLetterJobEntity,
 int retries)

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.

moveDeadLetterJobToHistoryJob

HistoryJobEntity moveDeadLetterJobToHistoryJob(DeadLetterJobEntity deadLetterJobEntity,
 int retries)

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.

deleteExecutableJob

void deleteExecutableJob(JobInfo job)

scheduleHistoryJob

HistoryJobEntity scheduleHistoryJob(HistoryJobEntity historyJobEntity,
 TransactionContext transactionContext)

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.

setJobServiceConfiguration

void setJobServiceConfiguration(JobServiceConfiguration jobServiceConfiguration)

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

createExecutableJobFromOtherJob

JobEntity createExecutableJobFromOtherJob(AbstractRuntimeJobEntity job)

Create an executable job from another job

createTimerJobFromOtherJob

TimerJobEntity createTimerJobFromOtherJob(AbstractRuntimeJobEntity otherJob)

Create a timer job from another job

createSuspendedJobFromOtherJob

SuspendedJobEntity createSuspendedJobFromOtherJob(AbstractRuntimeJobEntity otherJob)

Create a suspended job from another job

createDeadLetterJobFromOtherJob

DeadLetterJobEntity createDeadLetterJobFromOtherJob(AbstractRuntimeJobEntity otherJob)

Create a dead letter job from another job

createDeadLetterJobFromHistoryJob

DeadLetterJobEntity createDeadLetterJobFromHistoryJob(HistoryJobEntity historyJobEntity)

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

createExternalWorkerJobFromOtherJob

ExternalWorkerJobEntity createExternalWorkerJobFromOtherJob(AbstractRuntimeJobEntity otherJob)

Create an external worker job from another job

copyJobInfo

AbstractRuntimeJobEntity copyJobInfo(AbstractRuntimeJobEntity copyToJob,
 AbstractRuntimeJobEntity copyFromJob)

Copy job info from one job to the other