org.forgerock.script

Interface Script

All Superinterfaces:

Scope

public interface Script
extends Scope

Interface for all executable script.

See Also:

CompiledScript

Method Summary

Modifier and Type	Method and Description
Object	eval() Executes the program stored in the Script object.
Object	eval(Bindings bindings) Executes the program stored in the Script object using the supplied Bindings of attributes as the ENGINE_SCOPE of the associated ScriptEngine during script execution.
void	putSafe(String key, Object value) Sets a key/value pair in the state of the Request that may either create a Thread-Safe Java Language Binding to be used in the execution of scripts or be used in some other way, depending on whether the key is reserved.

Methods inherited from interface org.forgerock.script.Scope

createBindings, flush, get, getBindings, put, setBindings

Method Detail

putSafe

void putSafe(String key,
             Object value)

Sets a key/value pair in the state of the Request that may either create a Thread-Safe Java Language Binding to be used in the execution of scripts or be used in some other way, depending on whether the key is reserved.

The Scope.put(String, Object) suppress the value with the same key.

Parameters:

key - The name of named value to add

value - The value of named value to add.

Throws:

NullPointerException - if key is null.

IllegalArgumentException - if key is empty.

eval

Object eval(Bindings bindings)
     throws ScriptException

Executes the program stored in the Script object using the supplied Bindings of attributes as the ENGINE_SCOPE of the associated ScriptEngine during script execution.

Parameters:

bindings - The bindings of attributes used for the ENGINE_SCOPE.

Returns:

The return value from the script execution.

Throws:

ScriptException - if an exception occurred during execution of the script.

eval

Object eval()
     throws ScriptException

Executes the program stored in the Script object.

Returns:

The return value from the script execution.

Throws:

ScriptException - if an exception occurred during execution of the script.