com.archibus.jobmanager

Class JobBase

java.lang.Object

com.archibus.jobmanager.JobBase

All Implemented Interfaces:

Job

public abstract class JobBase
extends java.lang.Object
implements Job

Abstract base class for Job implementations.

Job classes can only be accessed from two threads: a) the job thread, and b) the JobManager thread. The JobManager thread only accesses the status and stopRequested properties of the job. Job implementation classes can also access these properties at any time, without the need for additional synchronization.

Job classes can also define additional properties which they use internally. The JobManager thread will never access these properties.

Field Summary

Fields

Modifier and Type	Field and Description
protected JobStatus	status Job status.
protected boolean	stopRequested Set to true when stop is requested.

Constructor Summary

Constructors

Constructor and Description
JobBase()

Method Summary

Modifier and Type	Method and Description
JobStatus	getStatus() Returns the current job status.This method is called by the Job Manager which runs in a different thread.
void	run() Default run() implementation does not do anything.
void	stop() Requests the job to stop.

Methods inherited from class java.lang.Object

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

Field Detail

status

protected final JobStatus status

Job status. Initialized to JOB_CREATED.

stopRequested

protected volatile boolean stopRequested

Set to true when stop is requested.

Constructor Detail

JobBase

public JobBase()

Method Detail

getStatus

public JobStatus getStatus()

Returns the current job status.This method is called by the Job Manager which runs in a different thread.

The status object is owned by the job implementation. The run() method should update the status object in a thread-safe manner.

Specified by:

getStatus in interface Job

Returns:

JobStatus

stop

public void stop()

Requests the job to stop. This method is called by the Job Manager which runs in a different thread.

The implementation is assumed to set the internal flag, in a thread-safe manner. The run() method implementation is assumed to check the flag periodically, between units of work.

If the job does not stop after configurable time interval, the Job Manager may terminate the job thread.

Specified by:

stop in interface Job

run

public void run()

Default run() implementation does not do anything.

Specified by:

run in interface Job