org.oddjob.script

Class InvokeJob

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

org.oddjob.framework.extend.SimpleJob

org.oddjob.framework.extend.SerializableJob

org.oddjob.script.InvokeJob

All Implemented Interfaces:

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

public class InvokeJob
extends SerializableJob
implements Stoppable

Description

Invoke a java method or script snippet.

This is a wrapper for InvokeType. The result of the invocation is placed in the result property.

Note that stopping this job will simply attempt to interrupt the thread invoking the method. The outcome of this will obviously vary.

Oddjob will do it's best to convert arguments to the signature of the method or operation. An exception will result if it can't achieve this.

Example

Invoking a method on a bean.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <invoke id="invoke-job" function="echo">
                    <source>
                        <bean class="org.oddjob.script.EchoService"/>
                    </source>
                    <parameters>
                        <value value="Hello"/>
                    </parameters>
                </invoke>
                <echo id="echo">${invoke-job.result}</echo>
            </jobs>
        </sequential>
    </job>
</oddjob>

Where EchoService is: org/oddjob/script/EchoService.java

Example

Invoking a static method. Note that this uses args instead of parameters for convenience.

<oddjob>
    <job>
        <invoke function="static totalPrice" id="invoke-totalPrice">
            <args>
                <tokenizer text="Red Apples, 24, 47.3"/>
            </args>
            <source>
                <class name="org.oddjob.script.InvokeJobTest"/>
            </source>
        </invoke>
    </job>
</oddjob>

Example

Examples elsewhere.

See InvokeType for several more examples. Property configuration is the same for the type and the job.

The JMXServiceJob job has an example of invoking a JMX operation.

See Also:

Serialized Form

Author:

rob

Field Summary

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

stop

Constructor Summary

Constructors

Constructor and Description
InvokeJob() Constructor.

Method Summary

Modifier and Type	Method and Description
protected int	execute() Execute this job.
java.lang.Object[]	getArgs()
java.lang.String	getFunction()
ArooaValue	getParameters(int index)
java.lang.Object	getResult()
Invoker	getSource()
protected void	onReset() Allow sub classes to do something on reset.
protected void	onStop() Allow sub classes to do something on stop.
void	setArgs(java.lang.Object[] args)
void	setFunction(java.lang.String function)
void	setParameters(int index, ArooaValue parameter)
void	setSource(Invoker source)

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

fireDestroyedState, force, getStateChanger, hardReset, iconHelper, isStop, onDestroy, run, sleep, 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.Stoppable

stop

Methods inherited from interface org.oddjob.Stateful

addStateListener, lastStateEvent, removeStateListener

Constructor Detail

InvokeJob

public InvokeJob()

Constructor.

Method Detail

execute

protected int execute()
               throws java.lang.Throwable

Description copied from class: SimpleJob

Execute this job.

Specified by:

execute in class SimpleJob

Returns:

0 if the job is complete, anything else otherwise.

Throws:

java.lang.Exception - If the unexpected occurs.

java.lang.Throwable

onReset

protected void onReset()

Description copied from class: SimpleJob

Allow sub classes to do something on reset.

Overrides:

onReset in class SimpleJob

onStop

protected void onStop()
               throws FailedToStopException

Description copied from class: SimpleJob

Allow sub classes to do something on stop.

Overrides:

onStop in class SimpleJob

Throws:

FailedToStopException

getSource

public Invoker getSource()

setSource

public void setSource(Invoker source)

getFunction

public java.lang.String getFunction()

setFunction

public void setFunction(java.lang.String function)

getParameters

public ArooaValue getParameters(int index)

setParameters

public void setParameters(int index,
                          ArooaValue parameter)

getArgs

public java.lang.Object[] getArgs()

setArgs

public void setArgs(java.lang.Object[] args)

getResult

public java.lang.Object getResult()