org.oddjob.jobs.job

Class RunJob

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

org.oddjob.framework.extend.StructuralJob<java.lang.Object>

org.oddjob.jobs.job.RunJob

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, ArooaContextAware, ArooaSessionAware, Forceable, PropertyChangeNotifier, Iconic, LogEnabled, Resettable, Stateful, Stoppable, Structural

public class RunJob
extends StructuralJob<java.lang.Object>
implements Structural, Stoppable

Description

A job which runs another job. The other job can be local or on a server.

This job reflects the state of the job being executed.

Example

Examples elsewhere.

• The JMXClientJob job has an example that uses run to run a job on a remote server.

See Also:

Serialized Form

Author:

Rob Gordon

Field Summary

Fields inherited from class org.oddjob.framework.extend.StructuralJob

childHelper, destroy, stop, structuralState

Constructor Summary

Constructors

Constructor and Description
RunJob()

Method Summary

Modifier and Type	Method and Description
void	addStructuralListener(StructuralListener listener) Add a listener.
protected void	execute() Execute this job.
protected StateOperator	getInitialStateOp() Subclasses must provide the StateOperator that will decide how to evaluate the children's state.
java.lang.Object	getJob() Get the job.
ResetAction	getReset()
StateOperator	getStateOperator() Getter for State Operator.
boolean	hardReset() Perform a hard reset on the job.
boolean	isJoin()
boolean	isShowJob()
protected void	onStop() Allow sub classes to do something on stop.
void	setJob(java.lang.Object node) Set the stop node directly.
void	setJoin(boolean join)
void	setReset(ResetAction reset)
void	setShowJob(boolean showJob)
void	setStateOperator(StateOperator stateOperator)
boolean	softReset() Perform a soft reset on the job.

Methods inherited from class org.oddjob.framework.extend.StructuralJob

fireDestroyedState, force, getStateChanger, iconHelper, isStop, onDestroy, onHardReset, onReset, onSoftReset, postStop, removeStructuralListener, run, startChildStateReflector, stateHandler, stop, stopChildStateReflector, waitForChildrenOnStop

Methods inherited from class org.oddjob.framework.extend.BasePrimary

configure, getName, logger, logger, loggerName, save, setName, toString

Methods inherited from class org.oddjob.framework.extend.BaseComponent

addIconListener, addPropertyChangeListener, addStateListener, configure, destroy, firePropertyChange, getArooaSession, iconForId, initialise, lastStateEvent, onConfigured, onInitialised, removeIconListener, removePropertyChangeListener, removeStateListener, save, setArooaContext, setArooaSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.oddjob.Structural

removeStructuralListener

Methods inherited from interface org.oddjob.Stoppable

stop

Methods inherited from interface org.oddjob.Stateful

addStateListener, lastStateEvent, removeStateListener

Constructor Detail

RunJob

public RunJob()

Method Detail

setJob

public void setJob(java.lang.Object node)

Set the stop node directly.

Parameters:

node - The job.

getJob

public java.lang.Object getJob()

Get the job.

Returns:

The node.

setStateOperator

public void setStateOperator(StateOperator stateOperator)

Property: stateOperator

Description: Set the way the children's state is evaluated and reflected by the parent. Values can be WORST, ACTIVE, or SERVICES.

Required: No, default is ACTIVE.

Parameters:

stateOperator - The state operator to be applied to children's states to derive our state.

getStateOperator

public StateOperator getStateOperator()

Getter for State Operator.

Returns:

getInitialStateOp

protected StateOperator getInitialStateOp()

Description copied from class: StructuralJob

Subclasses must provide the StateOperator that will decide how to evaluate the children's state.

Specified by:

getInitialStateOp in class StructuralJob<java.lang.Object>

Returns:

A State Operator. Must not be null.

execute

protected void execute()
                throws java.lang.Exception

Description copied from class: StructuralJob

Execute this job.

Specified by:

execute in class StructuralJob<java.lang.Object>

Throws:

java.lang.Exception - If the unexpected occurs.

softReset

public boolean softReset()

Perform a soft reset on the job.

Specified by:

softReset in interface Resettable

Overrides:

softReset in class StructuralJob<java.lang.Object>

Returns:

true if successful.

hardReset

public boolean hardReset()

Perform a hard reset on the job.

Specified by:

hardReset in interface Resettable

Overrides:

hardReset in class StructuralJob<java.lang.Object>

Returns:

true if successful.

onStop

protected void onStop()
               throws FailedToStopException

Description copied from class: StructuralJob

Allow sub classes to do something on stop.

Overrides:

onStop in class StructuralJob<java.lang.Object>

Throws:

FailedToStopException

addStructuralListener

public void addStructuralListener(StructuralListener listener)

Description copied from class: StructuralJob

Add a listener. The listener will immediately receive add notifications for all existing children.

Specified by:

addStructuralListener in interface Structural

Overrides:

addStructuralListener in class StructuralJob<java.lang.Object>

Parameters:

listener - The listener.

getReset

public ResetAction getReset()

setReset

public void setReset(ResetAction reset)

setJoin

public void setJoin(boolean join)

isJoin

public boolean isJoin()

setShowJob

public void setShowJob(boolean showJob)

isShowJob

public boolean isShowJob()