script

The named beans property allow values to be passed to and from the script.

Script output is captured in a console that is visible from Oddjob Explorer in addition to any output properties.

Property Summary

Example Summary

Property Detail

A named bean which is made available to the script.

ClassLoader to load the Script Engine.

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.

Examples

Hello World.

<oddjob>
    <job>
        <script id="s" language="JavaScript">print ("hello world\n");</script>
    </job>
</oddjob>

Variables from and to Oddjob.

<oddjob>
 <job> 
 <sequential>
 <jobs>
  <script id="s" language="JavaScript">
   <input>
    <buffer>
var snack = fruit;
    </buffer>
   </input>
   <beans>
    <value key="fruit" value="apple"/>
   </beans>
  </script>
  <echo id="e">${s.variables(fruit)}</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">
     <input>
      <buffer>
vars.set('today', new java.util.Date());
      </buffer>
     </input>
     <beans>
      <value key="vars" value="${v}"/>
     </beans>
    </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">
                    <input>
                        <buffer>function substr(string, from, to) {
    return string.substring(from, to);
}</buffer>
                    </input>
                </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.

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

Setting the script job to not complete.

<oddjob>
  <job>
    <script language="JavaScript" resultVariable="result" resultForState="true">
      <input>
        <buffer>
var result = 1;
        </buffer>
      </input>
    </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>