org.forgerock.openam.scripting

Class StandardScriptEvaluator

java.lang.Object

org.forgerock.openam.scripting.StandardScriptEvaluator

All Implemented Interfaces:

ScriptEvaluator

public class StandardScriptEvaluator
extends Object
implements ScriptEvaluator

Evaluates scripts using the standard JSR 223 script engine framework. Each script is run in its own thread, watched by the spawning thread. If the script-thread takes longer to run than the global timeout set for scripts in this class's script engine manager, that thread's execution must stop. Different ScriptEngines handle the stopping/interruption differently: Groovy relies on us sending its thread an interrupt signal, while JavaScript has its own timer which is checked on each processed instruction.

Since:

12.0.0

Constructor Summary

Constructors

Constructor and Description
StandardScriptEvaluator(StandardScriptEngineManager scriptEngineManager) Constructs the script evaluator using the given JSR 223 script engine manager instance.

Method Summary

Modifier and Type	Method and Description
void	bindVariableInGlobalScope(String name, Object object) Binds the given object to the given variable name in the global scope of all scripts evaluated via this script evaluator.
<T> T	evaluateScript(ScriptObject script, Bindings bindings) Evaluates scripts immediately using the configured JSR-223 script engine manager.

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardScriptEvaluator

public StandardScriptEvaluator(StandardScriptEngineManager scriptEngineManager)

Constructs the script evaluator using the given JSR 223 script engine manager instance.

Parameters:

scriptEngineManager - the script engine manager to use for creating script engines. May not be null.

Method Detail

bindVariableInGlobalScope

public void bindVariableInGlobalScope(String name,
                                      Object object)

Binds the given object to the given variable name in the global scope of all scripts evaluated via this script evaluator. This is intended to be used to bind common API components such as HTTP clients etc that should be available to all scripts. For per-script state to initialise, use the bindings element on the script object itself.

Specified by:

bindVariableInGlobalScope in interface ScriptEvaluator

Parameters:

name - the name of the variable to bind the object to.

object - the object to bind into the global scope of all scripts.

evaluateScript

public <T> T evaluateScript(ScriptObject script,
                            Bindings bindings)
                     throws ScriptException

Evaluates scripts immediately using the configured JSR-223 script engine manager. This implementation should be wrapped with a ThreadPoolScriptEvaluator if script interruption or timeouts are required.

Specified by:

evaluateScript in interface ScriptEvaluator

Type Parameters:

T - the type of result returned from the script.

Parameters:

script - the script to evaluate.

bindings - any additional variable bindings to set before running the script.

Returns:

the result of evaluating the script.

Throws:

ScriptException - if an error occurs in script execution.

ScriptException