org.xwiki.job

Class AbstractJobStatus<R extends Request>

java.lang.Object

org.xwiki.job.AbstractJobStatus<R>

Type Parameters:

R - the request type associated to the job

All Implemented Interfaces:

CancelableJobStatus, JobStatus

Direct Known Subclasses:

DefaultJobStatus

public abstract class AbstractJobStatus<R extends Request>
extends Object
implements JobStatus, CancelableJobStatus

Base implementation of JobStatus.

Since:

7.4M1

Version:

$Id: 2f98f53dfb3386e6c6dee77e3c3e40c86142e6ce $

Nested Class Summary

Nested classes/interfaces inherited from interface org.xwiki.job.event.status.JobStatus

JobStatus.State

Constructor Summary

Constructors

Constructor and Description
AbstractJobStatus(R request, JobStatus parentJobStatus, org.xwiki.observation.ObservationManager observationManager, org.xwiki.logging.LoggerManager loggerManager) Deprecated. since 9.2RC1, use AbstractJobStatus(String, Request, JobStatus, ObservationManager, LoggerManager) instead
AbstractJobStatus(String jobType, R request, JobStatus parentJobStatus, org.xwiki.observation.ObservationManager observationManager, org.xwiki.logging.LoggerManager loggerManager)

Method Summary

Modifier and Type	Method and Description
void	answered() Indicate that the question has been answered.
void	ask(Object question)
boolean	ask(Object question, long time, TimeUnit unit)
void	cancel() Cancel the job.
Date	getEndDate()
Throwable	getError()
String	getJobType()
org.xwiki.logging.LogQueue	getLog() Deprecated.
List<org.xwiki.logging.event.LogEvent>	getLog(org.xwiki.logging.LogLevel level) Deprecated.
org.xwiki.logging.tail.LoggerTail	getLoggerTail()
org.xwiki.logging.tail.LogTail	getLogTail()
JobStatus	getParentJobStatus()
JobProgress	getProgress()
Object	getQuestion()
long	getQuestionTimeLeft(TimeUnit unit)
R	getRequest()
Date	getStartDate()
JobStatus.State	getState()
void	ignoreLogs(boolean ignore)
boolean	isCancelable()
boolean	isCanceled()
boolean	isIsolated()
boolean	isSerialized()
boolean	isSubJob()
void	setCancelable(boolean cancelable)
void	setEndDate(Date endDate)
void	setError(Throwable error)
void	setIsolated(boolean isolated)
void	setLoggerTail(org.xwiki.logging.tail.LoggerTail loggerTail)
void	setStartDate(Date startDate)
void	setState(JobStatus.State state)
void	startListening() Start listening to events.
void	stopListening() Stop listening to events.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJobStatus

@Deprecated
public AbstractJobStatus(R request,
                                     JobStatus parentJobStatus,
                                     org.xwiki.observation.ObservationManager observationManager,
                                     org.xwiki.logging.LoggerManager loggerManager)

Deprecated. since 9.2RC1, use AbstractJobStatus(String, Request, JobStatus, ObservationManager, LoggerManager) instead

Parameters:

request - the request provided when started the job

parentJobStatus - the status of the parent job (i.e. the status of the job that started this one); pass null if this job hasn't been started by another job (i.e. if this is not a sub-job)

observationManager - the observation manager component

loggerManager - the logger manager component

AbstractJobStatus

public AbstractJobStatus(String jobType,
                         R request,
                         JobStatus parentJobStatus,
                         org.xwiki.observation.ObservationManager observationManager,
                         org.xwiki.logging.LoggerManager loggerManager)

Parameters:

jobType - the type of the job

request - the request provided when started the job

parentJobStatus - the status of the parent job (i.e. the status of the job that started this one); pass null if this job hasn't been started by another job (i.e. if this is not a sub-job)

observationManager - the observation manager component

loggerManager - the logger manager component

Method Detail

startListening

public void startListening()

Start listening to events.

ignoreLogs

@Unstable
public void ignoreLogs(boolean ignore)

Parameters:

ignore - true to ignore logs produced by the job execution

Since:

12.10

stopListening

public void stopListening()

Stop listening to events.

getJobType

public String getJobType()

Specified by:

getJobType in interface JobStatus

Returns:

the type of the job

getState

public JobStatus.State getState()

Specified by:

getState in interface JobStatus

Returns:

the general state of the job

setState

public void setState(JobStatus.State state)

Parameters:

state - the general state of the job

getError

public Throwable getError()

Specified by:

getError in interface JobStatus

Returns:

the Throwable on which the job stopped

setError

public void setError(Throwable error)

Parameters:

error - the Throwable on which the job stopped

Since:

8.1RC1

getRequest

public R getRequest()

Specified by:

getRequest in interface JobStatus

Returns:

the job request provided when starting it

getLogTail

public org.xwiki.logging.tail.LogTail getLogTail()

Specified by:

getLogTail in interface JobStatus

Returns:

the log tail

getLoggerTail

public org.xwiki.logging.tail.LoggerTail getLoggerTail()

Returns:

the LoggerTail instance

Since:

11.9RC1

setLoggerTail

public void setLoggerTail(org.xwiki.logging.tail.LoggerTail loggerTail)

Parameters:

loggerTail - the logger tail

Since:

11.9RC1

getProgress

public JobProgress getProgress()

Specified by:

getProgress in interface JobStatus

Returns:

progress information about the job (percent, etc.)

ask

public void ask(Object question)
         throws InterruptedException

Specified by:

ask in interface JobStatus

Parameters:

question - the question to ask as a Java bean

Throws:

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

ask

public boolean ask(Object question,
                   long time,
                   TimeUnit unit)
            throws InterruptedException

Specified by:

ask in interface JobStatus

Parameters:

question - the question to ask as a Java bean

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)

getQuestionTimeLeft

public long getQuestionTimeLeft(TimeUnit unit)

Specified by:

getQuestionTimeLeft in interface JobStatus

Parameters:

unit - the time unit of the returned value

Returns:

the time left before the question timeout

getQuestion

public Object getQuestion()

Specified by:

getQuestion in interface JobStatus

Returns:

the question

answered

public void answered()

Description copied from interface: JobStatus

Indicate that the question has been answered.

Specified by:

answered in interface JobStatus

getStartDate

public Date getStartDate()

Specified by:

getStartDate in interface JobStatus

Returns:

the date and time when the job has been started

setStartDate

public void setStartDate(Date startDate)

Parameters:

startDate - the date and time when the job has been started

getEndDate

public Date getEndDate()

Specified by:

getEndDate in interface JobStatus

Returns:

the date and time when the job finished

setEndDate

public void setEndDate(Date endDate)

Parameters:

endDate - the date and time when the job finished

isSubJob

public boolean isSubJob()

Returns:

true if the job is part of another job execution

isIsolated

public boolean isIsolated()

Specified by:

isIsolated in interface JobStatus

Returns:

true if the log should be isolated from standard output

setIsolated

public void setIsolated(boolean isolated)

Parameters:

isolated - true if the job log should be grabbed

getParentJobStatus

public JobStatus getParentJobStatus()

Returns:

the status of the parent job, i.e. the status of the job that started this one; returns null if the job has no parent, i.e. if the job hasn't been started by another job

isCancelable

public boolean isCancelable()

Specified by:

isCancelable in interface CancelableJobStatus

Returns:

true if the job support being canceled

setCancelable

public void setCancelable(boolean cancelable)

Parameters:

cancelable - true if the job can be canceled

cancel

public void cancel()

Cancel the job.

Specified by:

cancel in interface CancelableJobStatus

Since:

9.4RC1

See Also:

CancelableJobStatus.cancel()

isCanceled

public boolean isCanceled()

Specified by:

isCanceled in interface CancelableJobStatus

Returns:

true if the job was canceled, false otherwise

Since:

9.4RC1

See Also:

CancelableJobStatus.isCanceled()

isSerialized

public boolean isSerialized()

Specified by:

isSerialized in interface JobStatus

Returns:

true if the job status should be serialized

getLog

@Deprecated
public org.xwiki.logging.LogQueue getLog()

Deprecated.

Specified by:

getLog in interface JobStatus

Returns:

the log sent during job execution

getLog

@Deprecated
public List<org.xwiki.logging.event.LogEvent> getLog(org.xwiki.logging.LogLevel level)

Deprecated.

Specified by:

getLog in interface JobStatus

Parameters:

level - the level of the log

Returns:

the log sent with the provided level