org.xwiki.job

Class AbstractJob<R extends Request,S extends JobStatus>

java.lang.Object

org.xwiki.job.AbstractJob<R,S>

Type Parameters:

R - the request type associated to the job

All Implemented Interfaces:

Runnable, Job

@InstantiationStrategy(value=PER_LOOKUP)
public abstract class AbstractJob<R extends Request,S extends JobStatus>
extends Object
implements Job

Base class for Job implementations.

Since:

7.4M1

Version:

$Id: d2b7535c807fd32af6ca1d88738f93c5a83fd6a9 $

Field Summary

Fields

Modifier and Type	Field and Description
protected ComponentManager	componentManager Component manager.
protected ContextStoreManager	contextStore
protected Condition	finishedCondition Condition to wait for finished state.
protected boolean	initExecutionContext
protected JobContext	jobContext Used to set the current context.
protected ReentrantLock	lock Main lock guarding all access.
protected org.slf4j.Logger	logger The logger to log.
protected org.xwiki.logging.LoggerManager	loggerManager Used to isolate job related log.
protected org.xwiki.observation.ObservationManager	observationManager Used to send extensions installation and upgrade related events.
protected JobProgressManager	progressManager
protected R	request The job request.
protected S	status
protected JobStatusStore	store Used to store the results of the jobs execution.

Constructor Summary

Constructors

Constructor and Description
AbstractJob()

Method Summary

Modifier and Type	Method and Description
protected R	castRequest(Request request) Should be overridden if R is not Request.
protected S	createNewStatus(R request) Create a new standard JobStatus.
R	getRequest()
S	getStatus()
void	initialize(Request request)
protected void	jobFinished(Throwable error) Called when the job is done.
protected void	jobStarting() Called when the job is starting.
void	join() Causes the current thread to wait until this job has FINSHED state.
boolean	join(long time, TimeUnit unit) Causes the current thread to wait until this job has FINSHED state.
void	run()
protected void	runInContext()
protected abstract void	runInternal() Should be implemented by Job implementations.
void	start(Request request) Deprecated.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.job.Job

getType

Field Detail

componentManager

@Inject
protected ComponentManager componentManager

Component manager.

observationManager

@Inject
protected org.xwiki.observation.ObservationManager observationManager

Used to send extensions installation and upgrade related events.

loggerManager

@Inject
protected org.xwiki.logging.LoggerManager loggerManager

Used to isolate job related log.

contextStore

@Inject
protected ContextStoreManager contextStore

store

@Inject
protected JobStatusStore store

Used to store the results of the jobs execution.

logger

@Inject
protected org.slf4j.Logger logger

The logger to log.

jobContext

@Inject
protected JobContext jobContext

Used to set the current context.

progressManager

@Inject
protected JobProgressManager progressManager

request

protected R extends Request request

The job request.

status

protected S extends JobStatus status

See Also:

getStatus()

lock

protected final ReentrantLock lock

Main lock guarding all access.

finishedCondition

protected final Condition finishedCondition

Condition to wait for finished state.

initExecutionContext

protected boolean initExecutionContext

Constructor Detail

AbstractJob

public AbstractJob()

Method Detail

getRequest

public R getRequest()

Specified by:

getRequest in interface Job

Returns:

the job request

getStatus

public S getStatus()

Specified by:

getStatus in interface Job

Returns:

the status of the job

initialize

public void initialize(Request request)

Specified by:

initialize in interface Job

Parameters:

request - configure the job

run

public void run()

Specified by:

run in interface Runnable

runInContext

protected void runInContext()

jobStarting

protected void jobStarting()

Called when the job is starting.

jobFinished

protected void jobFinished(Throwable error)

Called when the job is done.

Parameters:

error - the exception throw during execution of the job

castRequest

protected R castRequest(Request request)

Should be overridden if R is not Request.

Parameters:

request - the request

Returns:

the request in the proper extended type

createNewStatus

protected S createNewStatus(R request)

Create a new standard JobStatus. Jobs requiring a custom JobStatus should overwrite this method.

Parameters:

request - contains information related to the job to execute

Returns:

the status of the job

runInternal

protected abstract void runInternal()
                             throws Exception

Should be implemented by Job implementations.

Throws:

Exception - errors during job execution

join

public void join()
          throws InterruptedException

Description copied from interface: Job

Causes the current thread to wait until this job has FINSHED state.

Specified by:

join in interface Job

Throws:

InterruptedException - if any thread has interrupted the current thread. The interrupted status of the current thread is cleared when this exception is thrown.

join

public boolean join(long time,
                    TimeUnit unit)
             throws InterruptedException

Description copied from interface: Job

Causes the current thread to wait until this job has FINSHED state.

Specified by:

join in interface Job

Parameters:

time - the maximum time to wait

unit - the time unit of the time argument

Returns:

false if the waiting time detectably elapsed before return from the method, else true

Throws:

InterruptedException - if the current thread is interrupted (and interruption of thread suspension is supported)

start

@Deprecated
public void start(Request request)

Deprecated.

Specified by:

start in interface Job

Parameters:

request - start the job with provided request

toString

public String toString()

Overrides:

toString in class Object