Package pro.taskana.common.internal.jobs

Class AbstractTaskanaJob

java.lang.Object

pro.taskana.common.internal.jobs.AbstractTaskanaJob

All Implemented Interfaces:

TaskanaJob

Direct Known Subclasses:

ClassificationChangedJob, TaskCleanupJob, TaskRefreshJob, TaskUpdatePriorityJob, WorkbasketCleanupJob

public abstract class AbstractTaskanaJob
extends Object
implements TaskanaJob

Abstract base for all background jobs of TASKANA.

Field Summary

Fields

Modifier and Type	Field	Description
protected Instant	firstRun
protected Duration	runEvery
protected final ScheduledJob	scheduledJob
protected final TaskanaEngineImpl	taskanaEngineImpl
protected final TaskanaTransactionProvider	txProvider

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTaskanaJob(TaskanaEngine taskanaEngine, TaskanaTransactionProvider txProvider, ScheduledJob job, boolean async)

Method Summary

Modifier and Type	Method	Description
static TaskanaJob	createFromScheduledJob(TaskanaEngine engine, TaskanaTransactionProvider txProvider, ScheduledJob job)
protected abstract void	execute()
Instant	getFirstRun()
static Duration	getLockExpirationPeriod(TaskanaConfiguration taskanaConfiguration)
protected Instant	getNextDueForJob()
Duration	getRunEvery()
protected abstract String	getType()
static void	initializeSchedule(TaskanaEngine taskanaEngine, Class<?> jobClass)	Initializes the TaskCleanupJob schedule.
boolean	isAsync()
final void	run()	Execute the TaskanaJob.
protected void	scheduleNextJob()

Methods inherited from class java.lang.Object

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

Field Details

taskanaEngineImpl

protected final TaskanaEngineImpl taskanaEngineImpl

txProvider

protected final TaskanaTransactionProvider txProvider

scheduledJob

protected final ScheduledJob scheduledJob

firstRun

protected Instant firstRun

runEvery

protected Duration runEvery

Constructor Details

AbstractTaskanaJob

protected AbstractTaskanaJob(TaskanaEngine taskanaEngine,
 TaskanaTransactionProvider txProvider,
 ScheduledJob job,
 boolean async)

Method Details

createFromScheduledJob

public static TaskanaJob createFromScheduledJob(TaskanaEngine engine,
 TaskanaTransactionProvider txProvider,
 ScheduledJob job)

run

public final void run()
               throws TaskanaException

Description copied from interface: TaskanaJob

Execute the TaskanaJob.

Specified by:

run in interface TaskanaJob

Throws:

TaskanaException - if any exception occurs during the execution.

initializeSchedule

public static void initializeSchedule(TaskanaEngine taskanaEngine,
 Class<?> jobClass)

Initializes the TaskCleanupJob schedule.
All scheduled cleanup jobs are cancelled/deleted and a new one is scheduled.

Parameters:

taskanaEngine - the TASKANA engine.

jobClass - the class of the job which should be scheduled

Throws:

SystemException - if the jobClass could not be scheduled.

isAsync

public boolean isAsync()

getFirstRun

public Instant getFirstRun()

getRunEvery

public Duration getRunEvery()

getLockExpirationPeriod

public static Duration getLockExpirationPeriod(TaskanaConfiguration taskanaConfiguration)

getType

protected abstract String getType()

execute

protected abstract void execute()
                         throws TaskanaException

Throws:

TaskanaException

getNextDueForJob

protected Instant getNextDueForJob()

scheduleNextJob

protected void scheduleNextJob()