Script (scheduling 8.4.0 API)

java.lang.Object
- org.ow2.proactive.scripting.Script<E>

Type Parameters:

E - Template class's type of the result.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FlowScript, ForkEnvironmentScript, SelectionScript, SimpleScript, TaskScript
```
@PublicAPI
public abstract class Script<E>
extends Object
implements Serializable
```
A simple script to evaluate using java 6 scripting API.

Since:

ProActive Scheduling 0.9

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ARGUMENTS_NAME` Variable name for script arguments
`static int`	`DEFAULT_OUTPUT_MAX_SIZE`
`protected String`	`id` Id of this script
`static org.apache.log4j.Logger`	`logger` Loggers
`static String`	`MD5`
`protected Serializable[]`	`parameters` The parameters of the script
`protected String`	`script` The script to evaluate
`protected String`	`scriptEngineLookupName` Name of the script engine or file path to script file (extension will be used to lookup)
`protected URL`	`url` url used to define this script, if aaplicable

Constructor Summary

Constructors
Constructor and Description
`Script()` ProActive needed constructor
`Script(File file)` Create a script from a file.
`Script(File file, Serializable[] parameters)` Create a script from a file.
`Script(Script<?> script2)` Create a script from another script object
`Script(Script<?> script2, String scriptName)` Create a script from another script object
`Script(String script, String engineName)` Directly create a script with a string.
`Script(String script, String engineName, Serializable[] parameters)` Directly create a script with a string.
`Script(String script, String engineName, Serializable[] parameters, String scriptName)` Directly create a script with a string.
`Script(String script, String engineName, String scriptName)` Directly create a script with a string.
`Script(URL url, boolean fetchImmediately)` Create a script from an URL.
`Script(URL url, Serializable[] parameters, boolean fetchImmediately)` Create a script from an URL.
`Script(URL url, String engineName, boolean fetchImmediately)` Create a script from an URL.
`Script(URL url, String engineName, Serializable[] parameters, boolean fetchImmediately)` Create a script from an URL.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected ScriptEngine`	`createScriptEngine()` The Script Engine used to evaluate the script.
`static String`	`digest(String script)` Get MD5 hash value of the script without parameters
`String`	`display()`
`boolean`	`equals(Object obj)`
`ScriptResult<E>`	`execute()` Execute the script and return the ScriptResult corresponding.
`ScriptResult<E>`	`execute(Map<String,Object> aBindings, PrintStream outputSink, PrintStream errorSink)` Execute the script and return the ScriptResult corresponding.
`String`	`fetchScript()` If the script is defined by an url, in fetchImmediately=false mode, retrieve and return the script content from the url.
`String`	`fetchScriptWithExceptionHandling()` If the script is defined by an url, in fetchImmediately=false mode, retrieve and return the script content from the url.
`protected void`	`fetchUrlIfNeeded()`
`protected abstract String`	`getDefaultScriptName()`
`String`	`getEngineName()`
`String`	`getId()` String identifying the script.
`Serializable[]`	`getParameters()` Get the parameters.
`protected Reader`	`getReader()` The reader used to read the script.
`protected abstract ScriptResult<E>`	`getResult(Object evalResult, Bindings bindings)` Return the variable awaited from the script execution
`String`	`getScript()` Get the script.
`String`	`getScriptName()` Get the script name.
`URL`	`getScriptUrl()` Get the script url, if applicable
`int`	`hashCode()`
`void`	`overrideDefaultScriptName(String defaultScriptName)`
`protected void`	`prepareBindings(Bindings bindings)` Set parameters in bindings if any
`protected abstract void`	`prepareSpecialBindings(Bindings bindings)` Specify the variable awaited from the script execution
`static String`	`readFile(File file)` Create string script from file
`void`	`setScript(String script)` Set the script content, ie the executed code
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_OUTPUT_MAX_SIZE
```
public static final int DEFAULT_OUTPUT_MAX_SIZE
```
    See Also:
    
    Constant Field Values
  - logger
```
public static final org.apache.log4j.Logger logger
```
    Loggers
  - ARGUMENTS_NAME
```
public static final String ARGUMENTS_NAME
```
    Variable name for script arguments
    
    See Also:
    
    Constant Field Values
  - MD5
```
public static final String MD5
```
    See Also:
    
    Constant Field Values
  - scriptEngineLookupName
```
protected String scriptEngineLookupName
```
    Name of the script engine or file path to script file (extension will be used to lookup)
  - script
```
protected String script
```
    The script to evaluate
  - url
```
protected URL url
```
    url used to define this script, if aaplicable
  - id
```
protected String id
```
    Id of this script
  - parameters
```
protected Serializable[] parameters
```
    The parameters of the script
- Constructor Detail
  - Script
```
public Script()
```
    ProActive needed constructor
  - Script
```
public Script(String script,
              String engineName,
              Serializable[] parameters)
       throws InvalidScriptException
```
    Directly create a script with a string.
    
    Parameters:
    
    script - String representing the script's source code
    
    engineName - String representing the execution engine
    
    parameters - script's execution arguments.
    
    Throws:
    
    InvalidScriptException - if the creation fails.
  - Script
```
public Script(String script,
              String engineName,
              Serializable[] parameters,
              String scriptName)
       throws InvalidScriptException
```
    Directly create a script with a string.
    
    Parameters:
    
    script - String representing the script's source code
    
    engineName - String representing the execution engine
    
    parameters - script's execution arguments.
    
    scriptName - name of the script
    
    Throws:
    
    InvalidScriptException - if the creation fails.
  - Script
```
public Script(String script,
              String engineName)
       throws InvalidScriptException
```
    Directly create a script with a string.
    
    Parameters:
    
    script - String representing the script's source code
    
    engineName - String representing the execution engine
    
    Throws:
    
    InvalidScriptException - if the creation fails.
  - Script
```
public Script(String script,
              String engineName,
              String scriptName)
       throws InvalidScriptException
```
    Directly create a script with a string.
    
    Parameters:
    
    script - String representing the script's source code
    
    engineName - String representing the execution engine
    
    scriptName - name of the script
    
    Throws:
    
    InvalidScriptException - if the creation fails.
  - Script
```
public Script(File file,
              Serializable[] parameters)
       throws InvalidScriptException
```
    Create a script from a file.
    
    Parameters:
    
    file - a file containing the script's source code.
    
    parameters - script's execution arguments.
    
    Throws:
    
    InvalidScriptException - if the creation fails.
  - Script
```
public Script(File file)
       throws InvalidScriptException
```
    Create a script from a file.
    
    Parameters:
    
    file - a file containing a script's source code.
    
    Throws:
    
    InvalidScriptException - if Constructor fails.
  - Script
```
public Script(URL url,
              Serializable[] parameters,
              boolean fetchImmediately)
       throws InvalidScriptException
```
    Create a script from an URL.
    
    Parameters:
    
    url - representing a script source code.
    
    parameters - execution arguments.
    
    fetchImmediately - true if the script at the given url must be fetched when the job is parsed by the server, false if the script must be fetch only at execution time.
    
    Throws:
    
    InvalidScriptException - if the creation fails.
  - Script
```
public Script(URL url,
              String engineName,
              Serializable[] parameters,
              boolean fetchImmediately)
       throws InvalidScriptException
```
    Create a script from an URL.
    
    Parameters:
    
    url - representing a script source code.
    
    engineName - String representing the execution engine
    
    parameters - execution arguments.
    
    fetchImmediately - true if the script at the given url must be fetched when the job is parsed by the server, false if the script must be fetch only at execution time.
    
    Throws:
    
    InvalidScriptException - if the creation fails.
  - Script
```
public Script(URL url,
              boolean fetchImmediately)
       throws InvalidScriptException
```
    Create a script from an URL.
    
    Parameters:
    
    url - representing a script source code.
    
    fetchImmediately - true if the script at the given url must be fetched when the job is parsed by the server, false if the script must be fetch only at execution time.
    
    Throws:
    
    InvalidScriptException - if the creation fails.
  - Script
```
public Script(URL url,
              String engineName,
              boolean fetchImmediately)
       throws InvalidScriptException
```
    Create a script from an URL.
    
    Parameters:
    
    url - representing a script source code.
    
    engineName - String representing the execution engine
    
    fetchImmediately - true if the script at the given url must be fetched when the job is parsed by the server, false if the script must be fetch only at execution time.
    
    Throws:
    
    InvalidScriptException - if the creation fails.
  - Script
```
public Script(Script<?> script2)
       throws InvalidScriptException
```
    Create a script from another script object
    
    Parameters:
    
    script2 - script object source
    
    Throws:
    
    InvalidScriptException - if the creation fails.
  - Script
```
public Script(Script<?> script2,
              String scriptName)
       throws InvalidScriptException
```
    Create a script from another script object
    
    Parameters:
    
    script2 - script object source
    
    Throws:
    
    InvalidScriptException - if the creation fails.
- Method Detail
  - getDefaultScriptName
```
protected abstract String getDefaultScriptName()
```
  - getScript
```
public String getScript()
```
    Get the script.
    
    Returns:
    
    the script.
  - fetchScript
```
public String fetchScript()
```
    If the script is defined by an url, in fetchImmediately=false mode, retrieve and return the script content from the url. The script internal definition will not be modified, thus allowing fetching again the url prior to execution. Otherwise, return the inline script definition
    
    Returns:
    
    the script, or null if the script could not be downloaded from the provided url.
  - fetchScriptWithExceptionHandling
```
public String fetchScriptWithExceptionHandling()
                                        throws IOException
```
    If the script is defined by an url, in fetchImmediately=false mode, retrieve and return the script content from the url. The script internal definition will not be modified, thus allowing fetching again the url prior to execution. Otherwise, return the inline script definition
    
    Returns:
    
    the script.
    
    Throws:
    
    IOException - when the script cannot be accessed
  - getScriptName
```
public String getScriptName()
```
    Get the script name.
    
    Returns:
    
    the script name.
  - getScriptUrl
```
public URL getScriptUrl()
```
    Get the script url, if applicable
    
    Returns:
    
    the script url
  - setScript
```
public void setScript(String script)
```
    Set the script content, ie the executed code
    
    Parameters:
    
    script - the new script content
  - getParameters
```
public Serializable[] getParameters()
```
    Get the parameters.
    
    Returns:
    
    the parameters.
  - execute
```
public ScriptResult<E> execute()
```
    Execute the script and return the ScriptResult corresponding. Will use System.out for output.
    
    Returns:
    
    a ScriptResult object.
  - execute
```
public ScriptResult<E> execute(Map<String,Object> aBindings,
                               PrintStream outputSink,
                               PrintStream errorSink)
```
    Execute the script and return the ScriptResult corresponding. This method can add an additional user bindings if needed.
    
    Parameters:
    
    aBindings - the additional user bindings to add if needed. Can be null or empty.
    
    outputSink - where the script output is printed to.
    
    errorSink - where the script error stream is printed to.
    
    Returns:
    
    a ScriptResult object.
  - fetchUrlIfNeeded
```
protected void fetchUrlIfNeeded()
                         throws IOException
```
    Throws:
    
    IOException
  - getId
```
public String getId()
```
    String identifying the script.
    
    Returns:
    
    a String identifying the script.
  - getReader
```
protected Reader getReader()
```
    The reader used to read the script.
  - createScriptEngine
```
protected ScriptEngine createScriptEngine()
```
    The Script Engine used to evaluate the script.
  - prepareSpecialBindings
```
protected abstract void prepareSpecialBindings(Bindings bindings)
```
    Specify the variable awaited from the script execution
    
    Parameters:
    
    bindings -
  - getResult
```
protected abstract ScriptResult<E> getResult(Object evalResult,
                                             Bindings bindings)
```
    Return the variable awaited from the script execution
  - prepareBindings
```
protected final void prepareBindings(Bindings bindings)
```
    Set parameters in bindings if any
  - readFile
```
public static String readFile(File file)
                       throws IOException
```
    Create string script from file
    
    Throws:
    
    IOException
  - getEngineName
```
public String getEngineName()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - digest
```
public static String digest(String script)
```
    Get MD5 hash value of the script without parameters
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - display
```
public String display()
```
  - overrideDefaultScriptName
```
public void overrideDefaultScriptName(String defaultScriptName)
```

Class Script<E>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_OUTPUT_MAX_SIZE

logger

ARGUMENTS_NAME

MD5

scriptEngineLookupName

script

url

id

parameters

Constructor Detail

Script

Script

Script

Script

Script

Script

Script

Script

Script

Script

Script

Script

Script

Method Detail

getDefaultScriptName

getScript

fetchScript

fetchScriptWithExceptionHandling

getScriptName

getScriptUrl

setScript

getParameters

execute

execute

fetchUrlIfNeeded

getId

getReader

createScriptEngine

prepareSpecialBindings

getResult

prepareBindings

readFile

getEngineName

hashCode

equals

digest

toString

display

overrideDefaultScriptName