script

Configuring a Script

Script Results

Input and Output

Property Summary

Example Summary

Property Detail

Deprecated. Use bind instead.

A named bean which is made available to the script.

Make all Oddjob's components available to the script as bindings.

ClassLoader to load the Script Engine.

Export bindings from the engine into the session using the given name. The first entry is the name of the binding, the second is the name. Repeating the name is tedious so the '.' character can be used to specify the same name as the binding.

Export all bindings from the engine into Oddjob's session.

Adapts a script function type to a Java Function. This isn't really necessary with Nashorn as there is a built in Conversion to do this. May be useful for other script engines.

The script provided as input from file or buffer etc.

Allow a scripted function to be evaluated from elsewhere in Oddjob.

The name of the language the script is in.

A name, can be any text.

Combine stdin and stderr.

The result of executing the script or the script variable chosen as the result variable with the resultVariable property.

If true then use the result to determine the completion state of the job. If the result is not a number this property will have no affect. If the result is a number and 0 the job will COMPLETE, any other value and the job will be INCOMPLETE.

The variable in the script that will be used to provide the result. The property is designed for use with scripting languages who's execution does not produce a result. If, however the script does produce a result and this property is set, the variable will override the scripts return value.

The script provided as text.

An output to where stderr of the script will be written.

An input stream which will act as stdin for the script.

An output to where stdout for the script will be written.

This flag is set by the stop method and should be examined by any Stoppable jobs in their processing loops.

Provide access to variables declared within the script.

Deprecated. Use variable instead.

Examples

Hello World.

<oddjob>
    <job>
        <script id="script" language="JavaScript">print ("Hello, World!");</script>
    </job>
</oddjob>

Variables from and to Oddjob.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <variables id="vars">
                    <fruit>
                        <value value="Apple"/>
                    </fruit>
                </variables>
                <script id="script" language="JavaScript">
                    <bind>
                        <value key="fruit" value="${vars.fruit}"/>
                    </bind>var snack = fruit;
</script>
                <echo id="echo">snack=${script.variable(snack)}
fruit=${script.variable(fruit)}</echo>
            </jobs>
        </sequential>
    </job>
</oddjob>

Binding and exporting to Oddjob's session. The Variables job uses Identify to insert the 'Apple' into Oddjob's session with the name fruit. bindSession causes this to be available to script, where it is assigned to the 'snack' variable. The script also defines an add function. The exportAll property causes both these to be exported to Oddjob. The two echo jobs show how these variables are now available in Oddjob's session. When the script job is reset, the variables are removed from the session.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <variables id="vars">
                    <fruitVar>
                        <identify id="fruit">
                            <value>
                                <value value="#{'Apple'}"/>
                            </value>
                        </identify>
                    </fruitVar>
                </variables>
                <script bindSession="true" exportAll="true" id="script" language="JavaScript">function add(x, y) {
    return x + y
}

snack = fruit;
</script>
                <echo id="echoSnack" name="Snack Is">$${snack} is '${snack}' and ##{snack} is '#{typeof snack == 'undefined' ? 'undefined' : snack}'</echo>
                <echo id="echoSum" name="Add Numbers">##add(2, 3) is #{add(2, 3)}</echo>
            </jobs>
        </sequential>
    </job>
</oddjob>

Using a script to set a property on a Job elsewhere in Oddjob.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <script id="s" language="JavaScript">
                    <bind>
                        <value key="vars" value="${v}"/>
                    </bind>vars.set('today', new java.util.Date());
</script>
                <variables id="v">
                    <formattedToday>
                        <format date="${v.today}" format="yyyyMMdd"/>
                    </formattedToday>
                </variables>
            </jobs>
        </sequential>
    </job>
</oddjob>

Invoking a script to provide a substring function.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <script id="substr" language="JavaScript">function substr(string, from, to) {
    return string.substring(from, to);
}</script>
                <properties id="properties">
                    <values>
                        <value key="text.before" value="Apples and Oranges"/>
                        <invoke function="substr" key="text.after">
                            <parameters>
                                <value value="${text.before}"/>
                                <value value="0"/>
                                <value value="6"/>
                            </parameters>
                            <source>
                                <value value="${substr.invocable}"/>
                            </source>
                        </invoke>
                    </values>
                </properties>
            </jobs>
        </sequential>
    </job>
</oddjob>

Setting the script job to not complete. The result of the script is used to set the state. 0 for Success, anything else for Incomplete.

<oddjob>
    <job>
        <script language="JavaScript" resultForState="true" resultVariable="result">var result = 1;</script>
    </job>
</oddjob>

Defining Java Functions in JavaScript.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <script id="funcs">function addTwo(x) { return new java.lang.Integer(x + 2)}
function multiplyByTwo(x) { return new java.lang.Integer(x * 2)}
</script>
                <echo id="add">#{funcs.getFunction('addTwo').apply(5)}</echo>
                <echo id="multiply">#{funcs.getFunction('multiplyByTwo').apply(3)}</echo>
            </jobs>
        </sequential>
    </job>
</oddjob>