org.activiti.engine.impl.jobexecutor

Class JobExecutor

java.lang.Object

org.activiti.engine.impl.jobexecutor.JobExecutor

Direct Known Subclasses:

DefaultJobExecutor

public abstract class JobExecutor
extends Object

Interface to the work management component of activiti.

This component is responsible for performing all background work (Jobs) scheduled by activiti.

You should generally only have one of these per Activiti instance (process engine) in a JVM. In clustered situations, you can have multiple of these running against the same queue + pending job list.

Author:

Daniel Meyer

Field Summary

Fields

Modifier and Type	Field and Description
protected Command<AcquiredJobs>	acquireJobsCmd
protected AcquireJobsRunnable	acquireJobsRunnable
protected ClockReader	clockReader
protected CommandExecutor	commandExecutor
protected boolean	isActive
protected boolean	isAutoActivate
protected Thread	jobAcquisitionThread
protected String	lockOwner
protected int	lockTimeInMillis
protected int	maxJobsPerAcquisition To avoid deadlocks, the default for this is one.
protected String	name
protected RejectedJobsHandler	rejectedJobsHandler
protected int	waitTimeInMillis

Constructor Summary

Constructors

Constructor and Description
JobExecutor()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	ensureCleanup()
protected void	ensureInitialization()
protected abstract void	executeJobs(List<String> jobIds)
Command<AcquiredJobs>	getAcquireJobsCmd()
CommandExecutor	getCommandExecutor()
Date	getCurrentTime()
String	getLockOwner()
int	getLockTimeInMillis()
int	getMaxJobsPerAcquisition()
String	getName()
RejectedJobsHandler	getRejectedJobsHandler()
int	getWaitTimeInMillis()
boolean	isActive()
boolean	isAutoActivate()
void	jobWasAdded()
void	setAcquireJobsCmd(Command<AcquiredJobs> acquireJobsCmd)
void	setAutoActivate(boolean isAutoActivate)
void	setClockReader(ClockReader clockReader)
void	setCommandExecutor(CommandExecutor commandExecutor)
void	setLockOwner(String lockOwner)
void	setLockTimeInMillis(int lockTimeInMillis)
void	setMaxJobsPerAcquisition(int maxJobsPerAcquisition)
void	setRejectedJobsHandler(RejectedJobsHandler rejectedJobsHandler)
void	setWaitTimeInMillis(int waitTimeInMillis)
void	shutdown()
void	start()
protected abstract void	startExecutingJobs()
protected void	startJobAcquisitionThread()
protected abstract void	stopExecutingJobs()
protected void	stopJobAcquisitionThread()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

commandExecutor

protected CommandExecutor commandExecutor

acquireJobsCmd

protected Command<AcquiredJobs> acquireJobsCmd

acquireJobsRunnable

protected AcquireJobsRunnable acquireJobsRunnable

rejectedJobsHandler

protected RejectedJobsHandler rejectedJobsHandler

jobAcquisitionThread

protected Thread jobAcquisitionThread

isAutoActivate

protected boolean isAutoActivate

isActive

protected boolean isActive

maxJobsPerAcquisition

protected int maxJobsPerAcquisition

To avoid deadlocks, the default for this is one. This way, in a clustered setup, multiple job executors can acquire jobs without creating a deadlock due to fetching multiple jobs at once and trying to lock them all at once. In a non-clustered setup, this setting can be changed to any value > 0 without problems. See http://jira.codehaus.org/browse/ACT-1879 for more information.

waitTimeInMillis

protected int waitTimeInMillis

lockOwner

protected String lockOwner

lockTimeInMillis

protected int lockTimeInMillis

clockReader

protected ClockReader clockReader

Constructor Detail

JobExecutor

public JobExecutor()

Method Detail

start

public void start()

shutdown

public void shutdown()

ensureInitialization

protected void ensureInitialization()

ensureCleanup

protected void ensureCleanup()

jobWasAdded

public void jobWasAdded()

startExecutingJobs

protected abstract void startExecutingJobs()

stopExecutingJobs

protected abstract void stopExecutingJobs()

executeJobs

protected abstract void executeJobs(List<String> jobIds)

getCommandExecutor

public CommandExecutor getCommandExecutor()

getWaitTimeInMillis

public int getWaitTimeInMillis()

setWaitTimeInMillis

public void setWaitTimeInMillis(int waitTimeInMillis)

getLockTimeInMillis

public int getLockTimeInMillis()

setLockTimeInMillis

public void setLockTimeInMillis(int lockTimeInMillis)

getLockOwner

public String getLockOwner()

setLockOwner

public void setLockOwner(String lockOwner)

isAutoActivate

public boolean isAutoActivate()

setCommandExecutor

public void setCommandExecutor(CommandExecutor commandExecutor)

setAutoActivate

public void setAutoActivate(boolean isAutoActivate)

getMaxJobsPerAcquisition

public int getMaxJobsPerAcquisition()

setMaxJobsPerAcquisition

public void setMaxJobsPerAcquisition(int maxJobsPerAcquisition)

getName

public String getName()

getAcquireJobsCmd

public Command<AcquiredJobs> getAcquireJobsCmd()

setAcquireJobsCmd

public void setAcquireJobsCmd(Command<AcquiredJobs> acquireJobsCmd)

isActive

public boolean isActive()

getRejectedJobsHandler

public RejectedJobsHandler getRejectedJobsHandler()

setRejectedJobsHandler

public void setRejectedJobsHandler(RejectedJobsHandler rejectedJobsHandler)

startJobAcquisitionThread

protected void startJobAcquisitionThread()

stopJobAcquisitionThread

protected void stopJobAcquisitionThread()

getCurrentTime

public Date getCurrentTime()

setClockReader

public void setClockReader(ClockReader clockReader)