Package org.oddjob.scheduling

Class Retry

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

org.oddjob.scheduling.ScheduleBase

org.oddjob.scheduling.TimerBase

org.oddjob.scheduling.Retry

All Implemented Interfaces:

Serializable, Runnable, ArooaContextAware, ArooaSessionAware, Forceable, PropertyChangeNotifier, Iconic, LogEnabled, Resettable, Stateful, Stoppable, Structural

public class Retry
extends TimerBase

Author:

Rob Gordon.

See Also:

• Serialized Form

Description

This is a timer that runs it's job according to the schedule until the schedule expires or the job completes successfully.

Example

File Polling. Check every 5 seconds for a file.

<oddjob id="this">

    <job>

        <scheduling:retry name="File Polling Example" xmlns:scheduling="http://rgordon.co.uk/oddjob/scheduling" xmlns:schedules="http://rgordon.co.uk/oddjob/schedules">

            <schedule>

                <schedules:interval interval="00:00:05"/>

            </schedule>

            <job>

                <sequential id="look" name="Look for files">

                    <jobs>

                        <exists file="${this.dir}/work/*.foo" id="check" name="Check File Exists"/>

                        <echo name="Echo to Console">Found ${check.exists[0]}</echo>

                    </jobs>

                </sequential>

            </job>

        </scheduling:retry>

    </job>

</oddjob>

Using Retry with a Timer. A daily job retries twice.

<oddjob xmlns:schedules="http://rgordon.co.uk/oddjob/schedules" xmlns:scheduling="http://rgordon.co.uk/oddjob/scheduling" xmlns:state="http://rgordon.co.uk/oddjob/state">

    <job>

        <scheduling:timer id="timer">

            <schedule>

                <schedules:daily from="08:00"/>

            </schedule>

            <job>

                <scheduling:retry id="retry">

                    <schedule>

                        <schedules:count count="2"/>

                    </schedule>

                    <job>

                        <state:flag id="flag-job" state="EXCEPTION"/>

                    </job>

                </scheduling:retry>

            </job>

        </scheduling:timer>

    </job>

</oddjob>

Field Summary

Fields inherited from class org.oddjob.scheduling.TimerBase

contextData

Fields inherited from class org.oddjob.scheduling.ScheduleBase

begun, childHelper, childStateReflector, stateHandler, stop

Constructor Summary

Constructors

Constructor	Description
Retry()

Method Summary

Modifier and Type	Method	Description
protected void	begin()	Sub classes must override this to submit the first execution.
protected StateCondition	getDefaultHaltOn()
protected ResetAction	getDefaultReset()
Interval	getLimits()	Implementation provided by sub classes so limits are available in TimerBase.scheduleFrom(Date).
protected StateOperator	getStateOp()	Sub classes provide the state operator that is used to calculate the subclasses completion state.
protected boolean	isSkipMissedRuns()
void	setLimits(Interval limits)

Methods inherited from class org.oddjob.scheduling.TimerBase

CancelAndStopChild, changeStateLocked, getClock, getCurrent, getHaltOn, getLastDue, getNextDue, getReset, getSchedule, getTimeZone, handleChildState, internalSetNextDue, onReset, onStop, postStop, reschedule, reset, scheduleFrom, setClock, setHaltOn, setJob, setNextDue, setReschedule, setReset, setSchedule, setScheduleExecutorService, setTimeZone

Methods inherited from class org.oddjob.scheduling.ScheduleBase

addStructuralListener, fireDestroyedState, force, getStateChanger, hardReset, iconHelper, onDestroy, removeStructuralListener, run, softReset, stateHandler, stop

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 Details

Retry

public Retry()

Method Details

getStateOp

protected StateOperator getStateOp()

Description copied from class: ScheduleBase

Sub classes provide the state operator that is used to calculate the subclasses completion state.

Specified by:

getStateOp in class ScheduleBase

Returns:

The operator. Must not be null.

begin

protected void begin()
              throws ComponentPersistException

Description copied from class: ScheduleBase

Sub classes must override this to submit the first execution.

Overrides:

begin in class TimerBase

Throws:

ComponentPersistException - If the scheduled time can't be saved.

setLimits

public void setLimits(Interval limits)

getLimits

public Interval getLimits()

Description copied from class: TimerBase

Implementation provided by sub classes so limits are available in TimerBase.scheduleFrom(Date).

Specified by:

getLimits in class TimerBase

Returns:

The limits, or null. Retry has limits, timer doesn't.

isSkipMissedRuns

protected boolean isSkipMissedRuns()

Specified by:

isSkipMissedRuns in class TimerBase

getDefaultHaltOn

protected StateCondition getDefaultHaltOn()

Specified by:

getDefaultHaltOn in class TimerBase

getDefaultReset

protected ResetAction getDefaultReset()

Specified by:

getDefaultReset in class TimerBase