com.almworks.jira.structure.api.job

Class AbstractStructureJob

java.lang.Object

com.almworks.jira.structure.api.job.AbstractStructureJob

All Implemented Interfaces:

StructureJob

Direct Known Subclasses:

SystemStructureJob

public abstract class AbstractStructureJob
extends Object
implements StructureJob

This is the basic implementation of a structure job, that should be extended by the actual job code. This class implements most of the housekeeping methods.

Author:

Igor Sereda todo actually move most of the StructureJob methods to under the implementation (implement lifecycle in a peer class)

Nested Class Summary

Nested classes/interfaces inherited from interface com.almworks.jira.structure.api.job.StructureJob

StructureJob.State

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	myLock

Constructor Summary

Constructors

Constructor and Description
AbstractStructureJob()

Method Summary

Modifier and Type	Method and Description
protected abstract void	doJob()
StructureJob.State	getState()
void	job() Runs the job in background.
void	reset() Reset the state of the job so that it becomes StructureJob.State.PENDING.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.almworks.jira.structure.api.job.StructureJob

getUser

Field Detail

myLock

protected final Object myLock

Constructor Detail

AbstractStructureJob

public AbstractStructureJob()

Method Detail

getState

public final StructureJob.State getState()

Specified by:

getState in interface StructureJob

Returns:

the current state of the job

See Also:

StructureJob.State

toString

public String toString()

Overrides:

toString in class Object

reset

public void reset()

Description copied from interface: StructureJob

Reset the state of the job so that it becomes StructureJob.State.PENDING. Should not be called when the job is running.

Specified by:

reset in interface StructureJob

job

public final void job()
               throws Exception

Description copied from interface: StructureJob

Runs the job in background. Before this method is called, all JIRA thread maintenance is done and the current user is set up to be what StructureJob.getUser() returns.

Specified by:

job in interface StructureJob

Throws:

Exception - any exception thrown by the job will be logged but won't stop job manager

doJob

protected abstract void doJob()
                       throws Exception

Throws:

Exception