org.ow2.proactive.scripting

Class SelectionScript

java.lang.Object

org.ow2.proactive.scripting.Script<Boolean>

org.ow2.proactive.scripting.SelectionScript

All Implemented Interfaces:

Serializable

@PublicAPI
public class SelectionScript
extends Script<Boolean>

A selection Script : return true if the resource tested is correct. There are 2 type of selection scripts :
-static scripts, aimed to test test static property of a resource (node), OS type RAM total space, dynamic libraries present.... -dynamic script, aimed to test dynamic properties if a resource, free disk space... A static script is executed once on a node and result of script's execution is memorized for a next script execution request, so that we avoid a second execution of a static script. A dynamic script is always executed, because we suppose that script tests dynamic properties able to change. By default a script is dynamic.

Since:

ProActive Scheduling 0.9

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	id_ Hash digest of the script
static org.apache.log4j.Logger	logger Loggers
static String	RESULT_VARIABLE The variable name which must be set after the evaluation of a verifying script.

Fields inherited from class org.ow2.proactive.scripting.Script

ARGUMENTS_NAME, DEFAULT_OUTPUT_MAX_SIZE, id, MD5, parameters, script, scriptEngineLookupName, url

Constructor Summary

Constructors

Constructor and Description
SelectionScript() ProActive needed constructor
SelectionScript(File file, Serializable[] parameters) Create a selection script from a file.
SelectionScript(File file, Serializable[] parameters, boolean dynamic) Create a selection script from a file.
SelectionScript(Script<?> script, boolean dynamic) Create a selection script from another selection script
SelectionScript(String script, String engineName) Directly create a script with a String.
SelectionScript(String script, String engineName, boolean dynamic) Directly create a script with a string.
SelectionScript(String script, String engineName, Serializable[] parameters, boolean dynamic) Directly create a script with a string.
SelectionScript(URL url) Create a selection script from an URL.
SelectionScript(URL url, boolean dynamic) Create a selection script from an URL.
SelectionScript(URL url, Serializable[] parameters) Create a selection script from an URL.
SelectionScript(URL url, Serializable[] parameters, boolean dynamic) Create a selection script from an URL.
SelectionScript(URL url, String engineName) Create a selection script from an URL.
SelectionScript(URL url, String engineName, boolean dynamic) Create a selection script from an URL.
SelectionScript(URL url, String engineName, Serializable[] parameters) Create a selection script from an URL.
SelectionScript(URL url, String engineName, Serializable[] parameters, boolean dynamic) Create a selection script from an URL.

Method Summary

Modifier and Type	Method and Description
void	buildSelectionScriptId() Build script ID.
boolean	compareByteArray(byte[] array1, byte[] array2) Compare two arrays of bytes
byte[]	digest() Get MD5 hash value
boolean	equals(Object o)
protected String	getDefaultScriptName()
String	getId() String identifying the script.
protected Reader	getReader() The reader used to read the script.
protected ScriptResult<Boolean>	getResult(Object evalResult, Bindings bindings) SelectionScript must give its result in the 'result_script' variable.
int	hashCode()
static int	hashCodeFromList(List<SelectionScript> selScriptsList) Util method to get an hashCode of a list of selection script.
boolean	isDynamic() Say if the script is static or dynamic
protected void	prepareSpecialBindings(Bindings bindings) There is no parameter to give to the selection script.
String	toString() String representation

Methods inherited from class org.ow2.proactive.scripting.Script

createScriptEngine, digest, display, execute, execute, fetchScript, fetchScriptWithExceptionHandling, fetchUrlIfNeeded, getEngineName, getParameters, getScript, getScriptName, getScriptUrl, overrideDefaultScriptName, prepareBindings, readFile, setScript

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

logger

public static final org.apache.log4j.Logger logger

Loggers

RESULT_VARIABLE

public static final String RESULT_VARIABLE

The variable name which must be set after the evaluation of a verifying script.

See Also:

Constant Field Values

id_

protected byte[] id_

Hash digest of the script

Constructor Detail

SelectionScript

public SelectionScript()

ProActive needed constructor

SelectionScript

public SelectionScript(String script,
                       String engineName)
                throws InvalidScriptException

Directly create a script with a String.

Parameters:

script - String representing a script code

engineName - String a script execution engine.

Throws:

InvalidScriptException - if the creation fails.

SelectionScript

public SelectionScript(String script,
                       String engineName,
                       boolean dynamic)
                throws InvalidScriptException

Directly create a script with a string.

Parameters:

script - String representing a script code

engineName - String a script execution engine.

dynamic - tell if the script is dynamic or static

Throws:

InvalidScriptException - if the creation fails.

SelectionScript

public SelectionScript(String script,
                       String engineName,
                       Serializable[] parameters,
                       boolean dynamic)
                throws InvalidScriptException

Directly create a script with a string.

Parameters:

script - String representing a script code

parameters - script execution arguments.

engineName - String a script execution engine.

dynamic - tell if the script is dynamic or static

Throws:

InvalidScriptException - if the creation fails.

SelectionScript

public SelectionScript(File file,
                       Serializable[] parameters)
                throws InvalidScriptException

Create a selection script from a file.

Parameters:

file - a file containing the script

parameters - script execution arguments.

Throws:

InvalidScriptException - if the creation fails.

SelectionScript

public SelectionScript(File file,
                       Serializable[] parameters,
                       boolean dynamic)
                throws InvalidScriptException

Create a selection script from a file.

Parameters:

file - a file containing script code

parameters - script execution arguments.

dynamic - tell if script is dynamic or static

Throws:

InvalidScriptException - if the creation fails.

SelectionScript

public SelectionScript(URL url)
                throws InvalidScriptException

Create a selection script from an URL.

Parameters:

url - an URL representing a script code

Throws:

InvalidScriptException - if the creation fails

SelectionScript

public SelectionScript(URL url,
                       boolean dynamic)
                throws InvalidScriptException

Create a selection script from an URL.

Parameters:

url - an URL representing a script code

Throws:

InvalidScriptException - if the creation fails

SelectionScript

public SelectionScript(URL url,
                       String engineName)
                throws InvalidScriptException

Create a selection script from an URL.

Parameters:

url - an URL representing a script code

engineName - script's engine execution name.

Throws:

InvalidScriptException - if the creation fails

SelectionScript

public SelectionScript(URL url,
                       String engineName,
                       boolean dynamic)
                throws InvalidScriptException

Create a selection script from an URL.

Parameters:

url - an URL representing a script code

engineName - script's engine execution name.

dynamic - true if the script is dynamic

Throws:

InvalidScriptException - if the creation fails

SelectionScript

public SelectionScript(URL url,
                       Serializable[] parameters)
                throws InvalidScriptException

Create a selection script from an URL.

Parameters:

url - an URL representing a script code

parameters - script execution argument.

Throws:

InvalidScriptException - if the creation fails

SelectionScript

public SelectionScript(URL url,
                       Serializable[] parameters,
                       boolean dynamic)
                throws InvalidScriptException

Create a selection script from an URL.

Parameters:

url - an URL representing a script code

parameters - execution arguments

dynamic - true if the script is dynamic

Throws:

InvalidScriptException - if the creation fails.

SelectionScript

public SelectionScript(URL url,
                       String engineName,
                       Serializable[] parameters)
                throws InvalidScriptException

Create a selection script from an URL.

Parameters:

url - an URL representing a script code

engineName - script's engine execution name.

parameters - script execution argument.

Throws:

InvalidScriptException - if the creation fails

SelectionScript

public SelectionScript(URL url,
                       String engineName,
                       Serializable[] parameters,
                       boolean dynamic)
                throws InvalidScriptException

Create a selection script from an URL.

Parameters:

url - an URL representing a script code

engineName - script's engine execution name.

parameters - execution arguments

dynamic - true if the script is dynamic

Throws:

InvalidScriptException - if the creation fails.

SelectionScript

public SelectionScript(Script<?> script,
                       boolean dynamic)
                throws InvalidScriptException

Create a selection script from another selection script

Parameters:

script - selection script source

dynamic - true if the script is dynamic

Throws:

InvalidScriptException - if the creation fails.

Method Detail

getDefaultScriptName

protected String getDefaultScriptName()

Specified by:

getDefaultScriptName in class Script<Boolean>

buildSelectionScriptId

public void buildSelectionScriptId()

Build script ID. ID is a way to compare a script with another. ID is a String made of script_code+script_parameters+type

getId

public String getId()

Description copied from class: Script

String identifying the script.

Overrides:

getId in class Script<Boolean>

Returns:

a String identifying the script.

See Also:

Script.getId()

getReader

protected Reader getReader()

Description copied from class: Script

The reader used to read the script.

Overrides:

getReader in class Script<Boolean>

getResult

protected ScriptResult<Boolean> getResult(Object evalResult,
                                          Bindings bindings)

SelectionScript must give its result in the 'result_script' variable.

Specified by:

getResult in class Script<Boolean>

See Also:

Script.getResult(Object, Bindings)

isDynamic

public boolean isDynamic()

Say if the script is static or dynamic

Returns:

true if the script is dynamic, false otherwise

prepareSpecialBindings

protected void prepareSpecialBindings(Bindings bindings)

There is no parameter to give to the selection script.

Specified by:

prepareSpecialBindings in class Script<Boolean>

equals

public boolean equals(Object o)

Overrides:

equals in class Script<Boolean>

See Also:

Script.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Script<Boolean>

See Also:

Object.hashCode()

digest

public byte[] digest()
              throws NoSuchAlgorithmException

Get MD5 hash value

Returns:

MD5 hash value

Throws:

NoSuchAlgorithmException

compareByteArray

public boolean compareByteArray(byte[] array1,
                                byte[] array2)

Compare two arrays of bytes

Parameters:

array1 - first array to compare

array2 - second array to compare

Returns:

true is the two contains the same bytes values, false otherwise

hashCodeFromList

public static int hashCodeFromList(List<SelectionScript> selScriptsList)

Util method to get an hashCode of a list of selection script. Can be used to compare two lists of selectionScript and see if it is the same. If the list is empty or null, then the return value will be 0, meaning no selection scripts are provided.

Parameters:

selScriptsList - a list of selection scripts

Returns:

0 if the list is null or empty, otherwise, an hashCode of the list content

toString

public String toString()

String representation

Overrides:

toString in class Script<Boolean>