com.atlassian.scheduler.core.impl

Class RunningJobImpl

java.lang.Object

com.atlassian.scheduler.core.impl.RunningJobImpl

All Implemented Interfaces:

RunningJob, JobRunnerRequest

@ThreadSafe
public final class RunningJobImpl
extends Object
implements RunningJob

Since:

v1.0

Constructor Summary

Constructors

Constructor and Description
RunningJobImpl(Date startTime, JobId jobId, JobConfig jobConfig)

Method Summary

Modifier and Type	Method and Description
void	cancel() Requests that the job be cancelled.
boolean	equals(Object o)
JobConfig	getJobConfig() Returns the job's configuration, such as its schedule and parameters.
JobId	getJobId() Returns the job ID that was used to schedule this job.
Date	getStartTime() Returns the time at which the job was started.
int	hashCode()
boolean	isCancellationRequested() Returns true if the job runner should terminate its activities as gracefully as possible and exit; false to continue running normally.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RunningJobImpl

public RunningJobImpl(Date startTime,
                      JobId jobId,
                      JobConfig jobConfig)

Method Detail

getStartTime

@Nonnull
public Date getStartTime()

Description copied from interface: JobRunnerRequest

Returns the time at which the job was started. When this job completes, the RunDetails that stores the result will use this exact time for RunDetails.getStartTime().

Specified by:

getStartTime in interface JobRunnerRequest

Returns:

the time at which the job was started.

getJobId

@Nonnull
public JobId getJobId()

Description copied from interface: JobRunnerRequest

Returns the job ID that was used to schedule this job.

Specified by:

getJobId in interface JobRunnerRequest

Returns:

the job ID that was used to schedule this job.

getJobConfig

@Nonnull
public JobConfig getJobConfig()

Description copied from interface: JobRunnerRequest

Returns the job's configuration, such as its schedule and parameters.

Specified by:

getJobConfig in interface JobRunnerRequest

Returns:

the job's configuration

isCancellationRequested

public boolean isCancellationRequested()

Description copied from interface: JobRunnerRequest

Returns true if the job runner should terminate its activities as gracefully as possible and exit; false to continue running normally.

Job cancellation is entirely cooperative. If a job is likely to take longer than a few seconds to complete its work, then it should periodically check this value and react to it. Normally, cancellation is requested because the application is trying to shut down, and continuing to run after this flag has been set increases the chance that the system administrator will grow impatient and forcibly kill the application.

Specified by:

isCancellationRequested in interface JobRunnerRequest

Returns:

true if cancellation is requested; false otherwise

cancel

public void cancel()

Description copied from interface: RunningJob

Requests that the job be cancelled.

Calling this method changes the return value of JobRunnerRequest.isCancellationRequested() permanently to true. It has no other effect; in particular, it does not interrupt the thread that is running the job. It is the responsibility of the job runner implementation to cooperatively check for an respond to the JobRunnerRequest.isCancellationRequested() flag.

Specified by:

cancel in interface RunningJob

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object