org.forgerock.script.groovy

Class GroovyScript

java.lang.Object

org.forgerock.script.groovy.GroovyScript

All Implemented Interfaces:

CompiledScript

public class GroovyScript
extends Object
implements CompiledScript

A JavaScript script.

This implementation pre-compiles the provided script. Any syntax errors in the source code will throw an exception during construction of the object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroovyScript.InnerListFactory
static class	GroovyScript.InnerMapFactory

Constructor Summary

Constructors

Constructor and Description
GroovyScript(String scriptName, GroovyScriptEngineImpl groovyEngine)

Method Summary

Modifier and Type	Method and Description
Object	eval(Context context, Bindings request, Bindings... scopes) Evaluated the script stored in this CompiledScript object.
Bindings	prepareBindings(Context context, Bindings request, Bindings... scopes)

Methods inherited from class java.lang.Object

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

Constructor Detail

GroovyScript

public GroovyScript(String scriptName,
                    GroovyScriptEngineImpl groovyEngine)
             throws IllegalAccessException,
                    InstantiationException,
                    groovy.util.ResourceException,
                    groovy.util.ScriptException

Throws:

IllegalAccessException

InstantiationException

groovy.util.ResourceException

groovy.util.ScriptException

Method Detail

prepareBindings

public Bindings prepareBindings(Context context,
                                Bindings request,
                                Bindings... scopes)

Specified by:

prepareBindings in interface CompiledScript

eval

public Object eval(Context context,
                   Bindings request,
                   Bindings... scopes)
            throws ScriptException

Description copied from interface: CompiledScript

Evaluated the script stored in this CompiledScript object.

Specified by:

eval in interface CompiledScript

Parameters:

context - A context associated with the Request.

request - A ScriptContext that is used in the same way as the ScriptContext passed to the eval methods of ScriptEngine.

scopes - Additional Bindings extending the request with.

Returns:

The value returned by the script execution, if any. Should return null if no value is returned by the script execution.

Throws:

ScriptException - if an error occurs.