org.forgerock.script.javascript

Class RhinoScript

java.lang.Object

org.forgerock.script.javascript.RhinoScript

All Implemented Interfaces:

CompiledScript

public class RhinoScript
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.

Field Summary

Fields

Modifier and Type	Field and Description
static org.mozilla.javascript.tools.shell.Global	GLOBAL

Constructor Summary

Constructors

Constructor and Description
RhinoScript(String name, RhinoScriptEngine engine, org.mozilla.javascript.commonjs.module.RequireBuilder requireBuilder, boolean sharedScope)
RhinoScript(String name, org.mozilla.javascript.Script compiledScript, RhinoScriptEngine engine, org.mozilla.javascript.commonjs.module.RequireBuilder requireBuilder, boolean sharedScope)

Method Summary

Modifier and Type	Method and Description
Object	eval(Context ctx, 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

Field Detail

GLOBAL

public static final org.mozilla.javascript.tools.shell.Global GLOBAL

Constructor Detail

RhinoScript

public RhinoScript(String name,
                   org.mozilla.javascript.Script compiledScript,
                   RhinoScriptEngine engine,
                   org.mozilla.javascript.commonjs.module.RequireBuilder requireBuilder,
                   boolean sharedScope)

Parameters:

name - the name of the script

compiledScript - the to-be-executed compiled script

engine - the parent script engine

requireBuilder - The CommonJS module builder for Require instances.

sharedScope - Indicates if this script instance should use the shared scope. If useSharedScope is true, then a sealed shared scope containing standard JavaScript objects (Object, String, Number, Date, etc.) will be used for script execution; otherwise a new unsealed scope will be allocated for each execution.

RhinoScript

public RhinoScript(String name,
                   RhinoScriptEngine engine,
                   org.mozilla.javascript.commonjs.module.RequireBuilder requireBuilder,
                   boolean sharedScope)

Parameters:

name - the name of the script

engine - the parent script engine

requireBuilder - The CommonJS module builder for Require instances.

sharedScope - Indicates if this script instance should use the shared scope. If useSharedScope is true, then a sealed shared scope containing standard JavaScript objects (Object, String, Number, Date, etc.) will be used for script execution; otherwise a new unsealed scope will be allocated for each execution.

Method Detail

prepareBindings

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

Specified by:

prepareBindings in interface CompiledScript

eval

public Object eval(Context ctx,
                   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:

ctx - 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.