org.oddjob.state

Class CascadeJob

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

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

org.oddjob.state.CascadeJob

All Implemented Interfaces:

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

Direct Known Subclasses:

CascadeJobDepricated, SshSequenceJob

public class CascadeJob
extends StructuralJob<java.lang.Object>

Description

A job which triggers the next job after the previous one completes. This job differs from a SequentialJob task in that the latter follows the thread of execution, and only checks state to ensure it can continue. This job's thread of execution passes onwards after the cascade has been set up. This job will complete asynchronously once all it's children have completed.

State Operator

This job doesn't currently expose a State Operator property as SequentialJob does. The state behaviour is equivalent to the WORST state operator, which is what is desired in most situations. A stateOperator property may be added in future versions if needed.

Example

A cascade of two jobs.

<oddjob>
    <job>
        <cascade>
            <jobs>
                <echo>This runs first.</echo>
                <echo>Then this.</echo>
            </jobs>
        </cascade>
    </job>
</oddjob>

Example

Showing cascade being used with ParallelJob. The cascade will wait for the parallel job to finish before running the third job.

<oddjob>
    <job>
        <cascade>
            <jobs>
                <parallel>
                    <jobs>
                        <echo>Oranges could be first or second.</echo>
                        <echo>Pears could be first or second.</echo>
                    </jobs>
                </parallel>
                <echo>Apples are guaranteed to be third.</echo>
            </jobs>
        </cascade>
    </job>
</oddjob>

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
CascadeJob()

Method Summary

Modifier and Type	Method and Description
protected void	execute() Execute this job.
StateCondition	getCascadeOn()
StateCondition	getHaltOn()
protected StateOperator	getInitialStateOp() Subclasses must provide the StateOperator that will decide how to evaluate the children's state.
protected void	onStop() Allow sub classes to do something on stop.
void	setCascadeOn(StateCondition cascadeOn)
void	setExecutorService(java.util.concurrent.ExecutorService executor)
void	setHaltOn(StateCondition haltOn)
void	setJobs(int index, java.lang.Object child) Add a child job.
protected void	startChildStateReflector() Start the child state reflector.

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

addStructuralListener, fireDestroyedState, force, getStateChanger, hardReset, iconHelper, isStop, onDestroy, onHardReset, onReset, onSoftReset, postStop, removeStructuralListener, run, softReset, stateHandler, stop, stopChildStateReflector

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.Stateful

addStateListener, lastStateEvent, removeStateListener

Constructor Detail

CascadeJob

public CascadeJob()

Method Detail

setExecutorService

@Inject
public void setExecutorService(java.util.concurrent.ExecutorService executor)

setJobs

public void setJobs(int index,
                    java.lang.Object child)

Add a child job.

Property: jobs

Description: The child jobs.

Required: No, but pointless if missing.

Parameters:

child - A child

execute

protected void execute()
                throws java.lang.InterruptedException

Description copied from class: StructuralJob

Execute this job.

Specified by:

execute in class StructuralJob<java.lang.Object>

Throws:

java.lang.InterruptedException

onStop

protected void onStop()

Description copied from class: StructuralJob

Allow sub classes to do something on stop.

Overrides:

onStop in class StructuralJob<java.lang.Object>

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.

startChildStateReflector

protected void startChildStateReflector()

Description copied from class: StructuralJob

Start the child state reflector. Sub classes override this if they need to start the child state reflector at a different time.

Overrides:

startChildStateReflector in class StructuralJob<java.lang.Object>

getCascadeOn

public StateCondition getCascadeOn()

setCascadeOn

public void setCascadeOn(StateCondition cascadeOn)

getHaltOn

public StateCondition getHaltOn()

setHaltOn

public void setHaltOn(StateCondition haltOn)