org.forgerock.openam.scripting

Class ScriptObject

java.lang.Object

org.forgerock.openam.scripting.ScriptObject

public final class ScriptObject
extends Object

Representation of a script in some scripting language. NB: We use 'ScriptObject' to avoid clashes with the JSR 223 'Script' class.

Since:

12.0.0

Constructor Summary

Constructors

Constructor and Description
ScriptObject(String name, String script, ScriptingLanguage language) Constructs a script object with the given name, script body and language.
ScriptObject(String name, String script, ScriptingLanguage language, Bindings bindings) Constructs a script object with the given name, script body, language and variable bindings.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Bindings	getBindings() Variable bindings that should be set when executing this script.
ScriptingLanguage	getLanguage() The language that the script is written in.
String	getName() The name of the script.
String	getScript() The contents of the script in the given scripting language.
int	hashCode()
String	toString()
List<ScriptError>	validate() Validate this script for the particular language rules and produces a list of ScriptError instances if any validation errors occurred.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptObject

public ScriptObject(String name,
                    String script,
                    ScriptingLanguage language,
                    Bindings bindings)

Constructs a script object with the given name, script body, language and variable bindings.

Parameters:

name - the name of the script.

script - the script itself.

language - the language that the script is written in.

bindings - the bindings used for the script.

ScriptObject

public ScriptObject(String name,
                    String script,
                    ScriptingLanguage language)

Constructs a script object with the given name, script body and language.

Parameters:

name - the name of the script.

script - the script itself.

language - the language that the script is written in.

Method Detail

getName

public String getName()

The name of the script.

getScript

public String getScript()

The contents of the script in the given scripting language.

getLanguage

public ScriptingLanguage getLanguage()

The language that the script is written in.

getBindings

public Bindings getBindings()

Variable bindings that should be set when executing this script.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validate

public List<ScriptError> validate()

Validate this script for the particular language rules and produces a list of ScriptError instances if any validation errors occurred.

Returns:

a list of validation errors if validation failed and an empty list if validation passed.

Throws:

NullPointerException - if script is empty.