org.forgerock.openam.scripting

Class ThreadPoolScriptEvaluator

java.lang.Object

org.forgerock.openam.scripting.ThreadPoolScriptEvaluator

All Implemented Interfaces:

ScriptEvaluator

@Singleton
public final class ThreadPoolScriptEvaluator
extends Object
implements ScriptEvaluator

Evaluates scripts in a configured thread pool so that they can be interrupted after a timeout has occurred.

Constructor Summary

Constructors

Constructor and Description
ThreadPoolScriptEvaluator(StandardScriptEngineManager scriptEngineManager, ExecutorService threadPool, ScriptEvaluator delegate) Constructs a script evaluator that uses a configurable thread pool to execute scripts, delegating actual script execution to another script evaluator.

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) This implementation of evaluateScript runs any provided script in its own thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadPoolScriptEvaluator

@Inject
public ThreadPoolScriptEvaluator(StandardScriptEngineManager scriptEngineManager,
                                         ExecutorService threadPool,
                                         ScriptEvaluator delegate)

Constructs a script evaluator that uses a configurable thread pool to execute scripts, delegating actual script execution to another script evaluator. Registers a configuration listener to adjust the thread pool according to current application settings.

Parameters:

scriptEngineManager - the manager object to listen for configuration changes. Not null.

threadPool - the thread pool to use for evaluating scripts. Not null.

delegate - the script evaluator to use to evaluate scripts from the thread pool. Not null.

Method Detail

evaluateScript

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

This implementation of evaluateScript runs any provided script in its own thread. If timeouts have been configured in the script engine manager which this evaluator uses then the threads will be interrupted (or otherwise stop themselves depending on the engine's implementation) after the timeout period has expired if they have not already returned.

Specified by:

evaluateScript in interface ScriptEvaluator

Type Parameters:

T - the type of result expected 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, or null if no result produced.

Throws:

ScriptException - if anything went wrong during the script's execution

ScriptException

See Also:

GroovyEngineFactory

bindVariableInGlobalScope

public void bindVariableInGlobalScope(String name,
                                      Object object)

Description copied from interface: ScriptEvaluator

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.