org.oddjob.script

Class ScriptJob

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.ScriptJob

All Implemented Interfaces:

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

public class ScriptJob
extends SerializableJob
implements ConsoleOwner

Description

Execute a script. The script can be in any language that supports the Java Scripting Framework.

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.

Example

Hello World.

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

Example

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>

Example

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>

Example

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>

Example

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>

Example

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>

Example

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>

See Also:

Serialized Form

Author:

Rob Gordon - Based on the original from Ant.

Field Summary

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

stop

Constructor Summary

Constructors

Constructor and Description
ScriptJob()

Method Summary

Modifier and Type	Method and Description
protected int	_execute()
LogArchive	consoleLog() Provide the console archive.
protected int	execute() Execute this job.
java.lang.Object	getBeans(java.lang.String name) Get the named bean.
java.lang.ClassLoader	getClassLoader()
java.util.function.Function<java.lang.Object,java.lang.Object>	getFunction(java.lang.String name)
java.io.InputStream	getInput() Get the input.
javax.script.Invocable	getInvocable()
java.lang.String	getLanguage() Get the language.
java.lang.Object	getResult()
java.lang.String	getResultVariable()
java.lang.String	getScript()
java.io.OutputStream	getStderr()
java.io.InputStream	getStdin()
java.io.OutputStream	getStdout()
java.lang.Object	getVariables(java.lang.String key)
boolean	isRedirectStderr()
boolean	isResultForState()
void	setBeans(java.lang.String name, java.lang.Object value) Add a named bean.
void	setClassLoader(java.lang.ClassLoader classLoader)
void	setInput(java.io.InputStream input) Set the input.
void	setLanguage(java.lang.String language) Defines the language (required).
void	setRedirectStderr(boolean redirectStderr)
void	setResultForState(boolean resultForState)
void	setResultVariable(java.lang.String resultVariable)
void	setScript(java.lang.String script)
void	setStderr(java.io.OutputStream stderr)
void	setStdin(java.io.InputStream stdin)
void	setStdout(java.io.OutputStream stdout)

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

fireDestroyedState, force, getStateChanger, hardReset, iconHelper, isStop, onDestroy, onReset, onStop, 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.Stateful

addStateListener, lastStateEvent, removeStateListener

Constructor Detail

ScriptJob

public ScriptJob()

Method Detail

execute

protected int execute()
               throws java.io.IOException

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.io.IOException

_execute

protected int _execute()
                throws java.io.IOException

Throws:

java.io.IOException

consoleLog

public LogArchive consoleLog()

Description copied from interface: ConsoleOwner

Provide the console archive.

Specified by:

consoleLog in interface ConsoleOwner

Returns:

The archive. Must not be null.

setLanguage

public void setLanguage(java.lang.String language)

Defines the language (required).

Parameters:

language - the scripting language name for the script.

getLanguage

public java.lang.String getLanguage()

Get the language.

Returns:

The language.

getBeans

public java.lang.Object getBeans(java.lang.String name)

Get the named bean.

Parameters:

name - The name of the bean

Returns:

The bean or null if it doesn't exist.

setBeans

public void setBeans(java.lang.String name,
                     java.lang.Object value)

Add a named bean.

Parameters:

name - The name of the bean.

value - The bean.

getInput

public java.io.InputStream getInput()

Get the input.

Returns:

The input.

setInput

public void setInput(java.io.InputStream input)

Set the input.

Parameters:

input - The input.

getScript

public java.lang.String getScript()

setScript

public void setScript(java.lang.String script)

getInvocable

public javax.script.Invocable getInvocable()

getFunction

public java.util.function.Function<java.lang.Object,java.lang.Object> getFunction(java.lang.String name)

isRedirectStderr

public boolean isRedirectStderr()

setRedirectStderr

public void setRedirectStderr(boolean redirectStderr)

getStdin

public java.io.InputStream getStdin()

setStdin

public void setStdin(java.io.InputStream stdin)

getStdout

public java.io.OutputStream getStdout()

setStdout

public void setStdout(java.io.OutputStream stdout)

getStderr

public java.io.OutputStream getStderr()

setStderr

public void setStderr(java.io.OutputStream stderr)

getVariables

public java.lang.Object getVariables(java.lang.String key)

Property: variables

Description: Provide access to variables declared within the script.

getResultVariable

public java.lang.String getResultVariable()

setResultVariable

public void setResultVariable(java.lang.String resultVariable)

isResultForState

public boolean isResultForState()

setResultForState

public void setResultForState(boolean resultForState)

getResult

public java.lang.Object getResult()

getClassLoader

public java.lang.ClassLoader getClassLoader()

setClassLoader

@Inject
public void setClassLoader(java.lang.ClassLoader classLoader)