Package org.cristalise.kernel.scripting

Class Script

java.lang.Object

org.cristalise.kernel.scripting.Script

All Implemented Interfaces:

DescriptionObject

public class Script
extends Object
implements DescriptionObject

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAMETER_AGENT
static final String	PARAMETER_DB
static final String	PARAMETER_ITEM
static final String	PARAMETER_JOB
static final String	PARAMETER_LOCKER
static final String	PARAMETER_LOOKUP
static final String	PARAMETER_OUTPUT
static final String	PARAMETER_STORAGE
static final String	PARAMETER_VERTX
static final String	SYSTEM_USER

Constructor Summary

Constructors

Constructor	Description
Script()	Constructor for castor unmarshall
Script(String name, Integer version, ItemPath path, String xml)	Parses a given script xml, instead of loading it from Items.
Script(String name, Integer version, ItemPath path, String xml, boolean lateBind)	Parses a given script xml, instead of loading it from Items.
Script(String lang, String expr)	Creates a script executor for the supplied expression, bypassing the xml parsing bit Output class is forced to an object.
Script(String lang, String expr, Class<?> returnType)	Creates a script executor for the supplied expression, bypassing the xml parsing bit
Script(String lang, String name, String expr, AgentProxy agent)	Creates a script executor requiring an agent to be set.
Script(String lang, String name, String expr, AgentProxy agent, Class<?> returnType)	Creates a script executor requiring an agent to be set.
Script(String lang, AgentProxy agent, PrintStream out)	For consoles

Method Summary

Modifier and Type	Method	Description
protected void	addIncludedInputParam(String name, Class<?> type)
void	addInputParam(String name, Class<?> type)
void	addInputParam(String name, String type)
void	addOutput(String name, Class<?> type)
void	addOutput(String name, String type)
Object	evaluate(ItemPath itemPath, CastorHashMap inputProps, String actContext, boolean actExecEnv, TransactionKey transactionKey)	Reads and evaluates input properties, set input parameters from those properties and executes the Script
Object	evaluate(ItemPath itemPath, CastorHashMap inputProps, String actContext, TransactionKey transactionKey)
Object	evaluate(CastorHashMap inputProps)	Use this when a Script is executed without an Item or Transaction context
Object	execute()	Executes the script with the submitted parameters.
ScriptContext	getContext()
ArrayList<Include>	getIncludes()	Method for castor marshall
String	getItemID()
BuiltInResources	getResourceType()
static Script	getScript(String name, Integer version)	Resolves the Script object using its name and version.
static Script	getScript(String name, Integer version, TransactionKey transactionKey)	Resolves the Script object using its name and version.
String	getScriptData()
String	getXml(boolean prettyPrint)
static void	main(String[] args)
CollectionArrayList	makeDescCollections(TransactionKey transactionKey)
void	setContext(ScriptContext context)
void	setIncludes(ArrayList<Include> includes)	Method for castor unmarshall
boolean	setInputParamValue(String name, Object value)	Submits an input parameter to the script.
boolean	setInputParamValue(String name, Object value, boolean overwrite)	Submits an input parameter to the script.
void	setScriptData(String script)
void	setScriptEngine(String requestedLang)	Sets the language
String	toString()
String	toXml()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cristalise.kernel.utils.DescriptionObject

exists, export, getItemPath, getName, getNamespace, getVersion, getXml, makeDescCollection, setItemPath, setName, setNamespace, setVersion, toOutcome

Field Details

PARAMETER_AGENT

public static final String PARAMETER_AGENT

See Also:

• Constant Field Values

PARAMETER_DB

public static final String PARAMETER_DB

See Also:

• Constant Field Values

PARAMETER_ITEM

public static final String PARAMETER_ITEM

See Also:

• Constant Field Values

PARAMETER_JOB

public static final String PARAMETER_JOB

See Also:

• Constant Field Values

PARAMETER_LOCKER

public static final String PARAMETER_LOCKER

See Also:

• Constant Field Values

PARAMETER_LOOKUP

public static final String PARAMETER_LOOKUP

See Also:

• Constant Field Values

PARAMETER_OUTPUT

public static final String PARAMETER_OUTPUT

See Also:

• Constant Field Values

PARAMETER_VERTX

public static final String PARAMETER_VERTX

See Also:

• Constant Field Values

PARAMETER_STORAGE

public static final String PARAMETER_STORAGE

See Also:

• Constant Field Values

SYSTEM_USER

public static final String SYSTEM_USER

See Also:

• Constant Field Values

Constructor Details

Script

public Script()

Constructor for castor unmarshall

Script

public Script(String name,
 Integer version,
 ItemPath path,
 String xml)
       throws ScriptParsingException,
ParameterException

Parses a given script xml, instead of loading it from Items.

Parameters:

name - the name of the Script

version - the version of the Script

path - the Itempath if the Script (can be null)

xml - the marshalled Script

Throws:

ScriptParsingException - there was an error parsing the xml

ParameterException - there was an error parsing the parameters

Script

public Script(String name,
 Integer version,
 ItemPath path,
 String xml,
 boolean lateBind)
       throws ScriptParsingException,
ParameterException

Parses a given script xml, instead of loading it from Items.

Parameters:

name - the name of the Script

version - the version of the Script

path - the Itempath if the Script (can be null)

xml - the marshalled Script

lateBind - do not try to resolve the Items of the included scripts during the XML parse

Throws:

ScriptParsingException - there was an error parsing the xml

ParameterException - there was an error parsing the parameters

Script

public Script(String lang,
 String expr,
 Class<?> returnType)
       throws ScriptingEngineException

Creates a script executor for the supplied expression, bypassing the xml parsing bit

Parameters:

lang - - script language

expr - - the script to run

returnType - Class of the return of the Script

Throws:

ScriptingEngineException

Script

public Script(String lang,
 String name,
 String expr,
 AgentProxy agent)
       throws ScriptingEngineException

Creates a script executor requiring an agent to be set. Used by module event scripts.

Parameters:

lang - - script language

name - - script name for debugging

expr - - the script to run

agent - - the agentproxy to pass into the script as 'agent'

Throws:

ScriptingEngineException

Script

public Script(String lang,
 String name,
 String expr,
 AgentProxy agent,
 Class<?> returnType)
       throws ScriptingEngineException

Creates a script executor requiring an agent to be set. Used by module event scripts.

Parameters:

lang - - script language

name - - script name for debugging

expr - - the script to run

agent - - the agentproxy to pass into the script as 'agent'

Throws:

ScriptingEngineException

Script

public Script(String lang,
 String expr)
       throws ScriptingEngineException

Creates a script executor for the supplied expression, bypassing the xml parsing bit Output class is forced to an object.

Parameters:

lang - - script language

expr - - the script to run

Throws:

ScriptingEngineException

Script

public Script(String lang,
 AgentProxy agent,
 PrintStream out)
       throws Exception

For consoles

Parameters:

lang - - script language

agent - - Proxy of the console Agent(user)

out - - the output PrintStream for reporting results that don't go to the log

Throws:

Exception

Method Details

setScriptEngine

public void setScriptEngine(String requestedLang)
                     throws ScriptingEngineException

Sets the language

Parameters:

requestedLang - the language

Throws:

ScriptingEngineException

setContext

public void setContext(ScriptContext context)

Parameters:

context - ScriptContext

getContext

public ScriptContext getContext()

Returns:

ScriptContext

addInputParam

public void addInputParam(String name,
 String type)
                   throws ParameterException

Parameters:

name -

type -

Throws:

ParameterException

addInputParam

public void addInputParam(String name,
 Class<?> type)
                   throws ParameterException

Throws:

ParameterException

addIncludedInputParam

protected void addIncludedInputParam(String name,
 Class<?> type)
                              throws ParameterException

Parameters:

name -

type -

Throws:

ParameterException

addOutput

public void addOutput(String name,
 String type)
               throws ParameterException

Parameters:

name -

type -

Throws:

ParameterException

addOutput

public void addOutput(String name,
 Class<?> type)
               throws ParameterException

Parameters:

name -

type -

Throws:

ParameterException

setInputParamValue

public boolean setInputParamValue(String name,
 Object value)
                           throws ParameterException

Submits an input parameter to the script. Must be declared by name and type in the script XML. The value will be overwritten even if it was set before.

Parameters:

name - - input parameter name from the script xml

value - - object to use for this parameter

Returns:

if the input parameter was used or not

Throws:

ParameterException - - name not found or wrong type

setInputParamValue

public boolean setInputParamValue(String name,
 Object value,
 boolean overwrite)
                           throws ParameterException

Submits an input parameter to the script. Must be declared by name and type in the script XML.

Parameters:

name - - input parameter name from the script xml

value - - object to use for this parameter

overwrite - - if the value should be overwritten even if it was set before

Returns:

if the input parameter was used or not

Throws:

ParameterException - - name not found or wrong type

evaluate

public Object evaluate(CastorHashMap inputProps)
                throws ScriptingEngineException

Use this when a Script is executed without an Item or Transaction context

Parameters:

inputProps - the inputs of the script

Returns:

the result of the execution

Throws:

ScriptingEngineException - something went wrong during the execution

evaluate

public Object evaluate(ItemPath itemPath,
 CastorHashMap inputProps,
 String actContext,
 TransactionKey transactionKey)
                throws ScriptingEngineException

Parameters:

itemPath -

inputProps -

actContext -

transactionKey -

Returns:

Throws:

ScriptingEngineException

evaluate

public Object evaluate(ItemPath itemPath,
 CastorHashMap inputProps,
 String actContext,
 boolean actExecEnv,
 TransactionKey transactionKey)
                throws ScriptingEngineException

Reads and evaluates input properties, set input parameters from those properties and executes the Script

Parameters:

itemPath - the Item context

inputProps - input properties

actContext - activity path

transactionKey - transaction transactionKey

Returns:

the values returned by the Script

Throws:

ScriptingEngineException

execute

public Object execute()
               throws ScriptingEngineException

Executes the script with the submitted parameters. All declared input parameters should have been set first. It executes the included scripts first because they might set input parameters, for the actual Script. NOT thread-safe!!!!

Returns:

The return value depends on the way the output type was declared in the script xml.

• If there was no output class declared then null is returned
• If a class was declared, but not named, then the object returned by the script is checked to be of that type, then returned.
• If the output value was named and typed, then an object of that class is created and passed to the script as an input parameter. The script should set this before it returns.

Throws:

ScriptingEngineException - - input parameters weren't set, there was an error executing the script, or the output was invalid

setScriptData

public void setScriptData(String script)
                   throws ScriptParsingException

Throws:

ScriptParsingException

getScriptData

public String getScriptData()

getItemID

public String getItemID()

Specified by:

getItemID in interface DescriptionObject

getScript

public static Script getScript(String name,
 Integer version)
                        throws ScriptingEngineException,
ObjectNotFoundException,
InvalidDataException

Resolves the Script object using its name and version. If Version is null tries to interpret the name as an expression

Parameters:

name - the name of the Script Item or an expression

version - the version of the Script. If set to null

Returns:

Script

Throws:

ScriptingEngineException

ObjectNotFoundException

InvalidDataException

See Also:

• BuiltInVertexProperties.ROUTING_EXPR

getScript

public static Script getScript(String name,
 Integer version,
 TransactionKey transactionKey)
                        throws ScriptingEngineException,
ObjectNotFoundException,
InvalidDataException

Resolves the Script object using its name and version. If Version is null tries to interpret the name as an expression

Parameters:

name - the name of the Script Item or an expression

version - the version of the Script. If set to null

transactionKey - key of the transaction

Returns:

Script

Throws:

ScriptingEngineException

ObjectNotFoundException

InvalidDataException

See Also:

• BuiltInVertexProperties.ROUTING_EXPR

getIncludes

public ArrayList<Include> getIncludes()

Method for castor marshall

Returns:

list of Include objects

setIncludes

public void setIncludes(ArrayList<Include> includes)
                 throws ObjectNotFoundException,
InvalidDataException,
ParameterException,
ScriptParsingException

Method for castor unmarshall

Parameters:

includes - included Scripts

Throws:

ObjectNotFoundException

InvalidDataException

ParameterException

ScriptParsingException

makeDescCollections

public CollectionArrayList makeDescCollections(TransactionKey transactionKey)
                                        throws InvalidDataException,
ObjectNotFoundException

Specified by:

makeDescCollections in interface DescriptionObject

Throws:

InvalidDataException

ObjectNotFoundException

getXml

public String getXml(boolean prettyPrint)
              throws InvalidDataException

Specified by:

getXml in interface DescriptionObject

Throws:

InvalidDataException

getResourceType

public BuiltInResources getResourceType()

Specified by:

getResourceType in interface DescriptionObject

main

public static void main(String[] args)

toXml

public String toXml()
             throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object