org.oddjob.framework.adapt.job

Class JobWrapper

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.adapt.BaseWrapper

org.oddjob.framework.adapt.job.JobWrapper

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, org.apache.commons.beanutils.DynaBean, ArooaContextAware, ArooaSessionAware, Describable, Forceable, ComponentWrapper, PropertyChangeNotifier, Iconic, LogEnabled, Resettable, Stateful, Stoppable

public class JobWrapper
extends BaseWrapper
implements ComponentWrapper, java.io.Serializable, Forceable

Creates a proxy for any Runnable to allow it to be controlled and monitored within Oddjob.

See Also:

Serialized Form

Author:

Rob Gordon.

Constructor Summary

Constructors

Constructor and Description
JobWrapper(JobAdaptor adaptor, java.lang.Object proxy) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	fireDestroyedState() Internal method to fire state.
void	force() Force the job to COMPLETE.
protected org.apache.commons.beanutils.DynaBean	getDynaBean() Sub classes must provide a dyna bean for properties.
protected java.lang.Object	getProxy() Subclass must provide the proxy.
protected JobStateChanger	getStateChanger()
protected java.lang.Object	getWrapped() Return the object that is being proxied.
boolean	hardReset() Perform a hard reset on the job.
protected IconHelper	iconHelper() Subclasses must provide a IconHelper.
void	onStop()
void	run()
void	setArooaSession(ArooaSession session) Here for the tests...
boolean	softReset() Perform a soft reset on the job.
protected JobStateHandler	stateHandler() Subclasses must provide a StateHandler.

Methods inherited from class org.oddjob.framework.adapt.BaseWrapper

configure, contains, describe, equals, get, get, get, getDynaClass, getResult, interfacesFor, logger, loggerName, onDestroy, remove, save, set, set, set, stop, 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.oddjob.logging.LogEnabled

loggerName

Methods inherited from interface org.oddjob.Stateful

addStateListener, lastStateEvent, removeStateListener

Constructor Detail

JobWrapper

public JobWrapper(JobAdaptor adaptor,
                  java.lang.Object proxy)

Constructor.

Method Detail

setArooaSession

public void setArooaSession(ArooaSession session)

Description copied from class: BaseComponent

Here for the tests...

Specified by:

setArooaSession in interface ArooaSessionAware

Overrides:

setArooaSession in class BaseComponent

Parameters:

session - The Arooa Session. Never null.

iconHelper

protected IconHelper iconHelper()

Description copied from class: BaseComponent

Subclasses must provide a IconHelper.

Specified by:

iconHelper in class BaseComponent

Returns:

An Icon Helper. Never null.

stateHandler

protected JobStateHandler stateHandler()

Description copied from class: BaseComponent

Subclasses must provide a StateHandler.

Specified by:

stateHandler in class BaseComponent

Returns:

A State Handler. Never null.

getStateChanger

protected JobStateChanger getStateChanger()

getWrapped

protected java.lang.Object getWrapped()

Description copied from class: BaseWrapper

Return the object that is being proxied.

Specified by:

getWrapped in class BaseWrapper

Returns:

The component being proxied.

getDynaBean

protected org.apache.commons.beanutils.DynaBean getDynaBean()

Description copied from class: BaseWrapper

Sub classes must provide a dyna bean for properties.

Specified by:

getDynaBean in class BaseWrapper

Returns:

getProxy

protected java.lang.Object getProxy()

Description copied from class: BaseWrapper

Subclass must provide the proxy.

Specified by:

getProxy in class BaseWrapper

Returns:

run

public void run()

Specified by:

run in interface java.lang.Runnable

onStop

public void onStop()
            throws FailedToStopException

Overrides:

onStop in class BaseWrapper

Throws:

FailedToStopException

softReset

public boolean softReset()

Perform a soft reset on the job.

Specified by:

softReset in interface Resettable

Returns:

true if successful.

hardReset

public boolean hardReset()

Perform a hard reset on the job.

Specified by:

hardReset in interface Resettable

Returns:

true if successful.

force

public void force()

Force the job to COMPLETE.

Specified by:

force in interface Forceable

fireDestroyedState

protected void fireDestroyedState()

Internal method to fire state.

Specified by:

fireDestroyedState in class BaseComponent