org.oddjob.script

Class InvokeType

java.lang.Object

org.oddjob.script.InvokeType

All Implemented Interfaces:

ArooaValue, ArooaSessionAware

public class InvokeType
extends java.lang.Object
implements ArooaValue, ArooaSessionAware

Description

Invoke a java method or script snippet, or JMX operation.

For a script, the source must be a javax.script.Invocable object.

Example

Invoke a method on a bean. The method takes a single date parameter which is uses to generate a time of day dependent greeting.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <variables id="vars">
                    <message>
                        <invoke function="greeting">
                            <source>
                                <bean class="org.oddjob.script.GreetingService"/>
                            </source>
                            <parameters>
                                <schedule>
                                    <date>
                                        <value value="${date}"/>
                                    </date>
                                    <schedule>
                                        <schedules:now xmlns:schedules="http://rgordon.co.uk/oddjob/schedules"/>
                                    </schedule>
                                </schedule>
                            </parameters>
                        </invoke>
                    </message>
                </variables>
                <echo id="echo-greeting">${vars.message}</echo>
            </jobs>
        </sequential>
    </job>
</oddjob>

The ${date} reference is there so that it can be injected during a test, to get a guaranteed result. When this is example is run as is, this is null so the system clock to be used there by giving a real time based greeting.

One subtle point to note about Oddjob configuration that this example highlights is to do with when types are resolved. The invoke type will be resolved when the echo job is run. The schedule type will be resolved when the variables job is run. If the echo job were scheduled to run several hours after the variables job had run it would not give the correct greeting!

Example

Invoke a static method of a class.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <variables id="vars">
                    <message>
                        <invoke function="static greetPerson">
                            <source>
                                <class name="org.oddjob.script.GreetingService"/>
                            </source>
                            <parameters>
                                <value value="John"/>
                            </parameters>
                        </invoke>
                    </message>
                </variables>
                <echo id="echo-greeting">${vars.message}</echo>
            </jobs>
        </sequential>
    </job>
</oddjob>

Example

Invoking a function of a script. See the ScriptJob examples.

Author:

Rob.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvokeType.Conversions Conversions.

Constructor Summary

Constructors

Constructor and Description
InvokeType()

Method Summary

Modifier and Type	Method and Description
java.lang.Object[]	getArgs()
java.lang.String	getFunction()
ArooaValue	getParameters(int index)
Invoker	getSource()
void	setArgs(java.lang.Object[] args)
void	setArooaSession(ArooaSession session) Accept the current Arooa Session.
void	setFunction(java.lang.String function)
void	setParameters(int index, ArooaValue parameter)
void	setSource(Invoker source)
java.lang.String	toString()
java.lang.Object	toValue()

Methods inherited from class java.lang.Object

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

Constructor Detail

InvokeType

public InvokeType()

Method Detail

setArooaSession

public void setArooaSession(ArooaSession session)

Description copied from interface: ArooaSessionAware

Accept the current Arooa Session.

Specified by:

setArooaSession in interface ArooaSessionAware

Parameters:

session - The Arooa Session. Never null.

toValue

public java.lang.Object toValue()
                         throws java.lang.Throwable

Throws:

java.lang.Throwable

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)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object