org.xwiki.job.event

Class JobFinishingEvent

java.lang.Object

org.xwiki.job.event.JobFinishingEvent

All Implemented Interfaces:

Serializable, JobEvent, org.xwiki.observation.event.Event

public class JobFinishingEvent
extends Object

Job finishing event triggered just after a job is done and we start to save status etc. Give a chance to listeners to do action as part of the job execution before it's "closed". Additional data may contains an exception if the job has not been finished with success.

The event also send the following parameters:

• source: the related Job instance
• data: an Throwable if the job execution failed or null otherwise

Since:

8.1RC1

Version:

$Id: 503e02d16304191ec613752a9958baf2ab0fac3b $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobFinishingEvent() Default constructor.
JobFinishingEvent(List<String> jobId, String jobType, Request request)
JobFinishingEvent(String jobId)
JobFinishingEvent(String jobId, String jobType, Request request)

Method Summary

Modifier and Type	Method and Description
List<String>	getJobId()
String	getJobType()
Request	getRequest()
boolean	matches(Object event)

Methods inherited from class java.lang.Object

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

Constructor Detail

JobFinishingEvent

public JobFinishingEvent()

Default constructor.

JobFinishingEvent

public JobFinishingEvent(String jobId)

Parameters:

jobId - the event related job id

JobFinishingEvent

public JobFinishingEvent(String jobId,
                         String jobType,
                         Request request)

Parameters:

jobId - the event related job id

jobType - the event related job type

request - the event related job request

JobFinishingEvent

public JobFinishingEvent(List<String> jobId,
                         String jobType,
                         Request request)

Parameters:

jobId - the event related job id

jobType - the event related job type

request - the event related job request

Since:

4.1M2

Method Detail

getJobId

public List<String> getJobId()

Specified by:

getJobId in interface JobEvent

Returns:

the job id of the source job of this event

getJobType

public String getJobType()

Specified by:

getJobType in interface JobEvent

Returns:

the job type of the source job of this event

getRequest

public Request getRequest()

Specified by:

getRequest in interface JobEvent

Returns:

the request related to the source job of this event

matches

public boolean matches(Object event)

Specified by:

matches in interface org.xwiki.observation.event.Event