org.forgerock.openam.scripting.factories

Class RhinoScriptEngineFactory

java.lang.Object

org.forgerock.openam.scripting.factories.RhinoScriptEngineFactory

All Implemented Interfaces:

ScriptEngineFactory

public class RhinoScriptEngineFactory
extends Object
implements ScriptEngineFactory

JSR-223 wrapper around a Rhino ContextFactory. Uses the configured ContextFactory to compile and evaluate scripts and so does not require use of the global context factory.

See Also:

JSR-223: Scripting for the Java Platform

Field Summary

Fields

Modifier and Type	Field and Description
static int	INTERPRETED Optimisation level constant indicating that scripts should be fully interpreted and not compiled.

Constructor Summary

Constructors

Constructor and Description
RhinoScriptEngineFactory() Constructs the script engine factory with a fresh context factory and no class-shutter.
RhinoScriptEngineFactory(org.mozilla.javascript.ContextFactory contextFactory) Constructs a script engine factory using the given context factory and class-shutter.

Method Summary

Modifier and Type	Method and Description
String	getEngineName()
String	getEngineVersion()
List<String>	getExtensions()
String	getLanguageName()
String	getLanguageVersion()
String	getMethodCallSyntax(String object, String method, String... args)
List<String>	getMimeTypes()
List<String>	getNames()
String	getOutputStatement(String s)
Object	getParameter(String paramName)
String	getProgram(String... statements)
ScriptEngine	getScriptEngine()
void	setClassShutter(org.mozilla.javascript.ClassShutter classShutter) Sets the class shutter to be used to sandbox scripts running in this engine.
void	setOptimisationLevel(int optimisationLevel) Sets the optimisation level to use for context objects created by this script engine.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

INTERPRETED

public static final int INTERPRETED

Optimisation level constant indicating that scripts should be fully interpreted and not compiled.

See Also:

Constant Field Values

Constructor Detail

RhinoScriptEngineFactory

public RhinoScriptEngineFactory(org.mozilla.javascript.ContextFactory contextFactory)

Constructs a script engine factory using the given context factory and class-shutter. If non-null, the given class-shutter will be applied to all context objects created by this script engine factory, providing a means of sandboxing scripts. This constructor will interrogate the given context factory to determine the implementation and language version provided.

Parameters:

contextFactory - the Rhino context factory. May not be null.

RhinoScriptEngineFactory

public RhinoScriptEngineFactory()

Constructs the script engine factory with a fresh context factory and no class-shutter.

See Also:

RhinoScriptEngineFactory(org.mozilla.javascript.ContextFactory)

Method Detail

getEngineName

public String getEngineName()

Specified by:

getEngineName in interface ScriptEngineFactory

getEngineVersion

public String getEngineVersion()

Specified by:

getEngineVersion in interface ScriptEngineFactory

getExtensions

public List<String> getExtensions()

Specified by:

getExtensions in interface ScriptEngineFactory

getMimeTypes

public List<String> getMimeTypes()

Specified by:

getMimeTypes in interface ScriptEngineFactory

getNames

public List<String> getNames()

Specified by:

getNames in interface ScriptEngineFactory

getLanguageName

public String getLanguageName()

Specified by:

getLanguageName in interface ScriptEngineFactory

getLanguageVersion

public String getLanguageVersion()

Specified by:

getLanguageVersion in interface ScriptEngineFactory

getParameter

public Object getParameter(String paramName)

Specified by:

getParameter in interface ScriptEngineFactory

getMethodCallSyntax

public String getMethodCallSyntax(String object,
                                  String method,
                                  String... args)

Specified by:

getMethodCallSyntax in interface ScriptEngineFactory

getOutputStatement

public String getOutputStatement(String s)

Specified by:

getOutputStatement in interface ScriptEngineFactory

getProgram

public String getProgram(String... statements)

Specified by:

getProgram in interface ScriptEngineFactory

getScriptEngine

public ScriptEngine getScriptEngine()

Specified by:

getScriptEngine in interface ScriptEngineFactory

setOptimisationLevel

public void setOptimisationLevel(int optimisationLevel)

Sets the optimisation level to use for context objects created by this script engine. Use INTERPRETED to disable all optimisations and use a purely interpreted script engine.

Parameters:

optimisationLevel - the optimisation level to use.

setClassShutter

public void setClassShutter(org.mozilla.javascript.ClassShutter classShutter)

Sets the class shutter to be used to sandbox scripts running in this engine.

Parameters:

classShutter - the class-shutter to use. May be null to disable sandboxing.

toString

public String toString()

Overrides:

toString in class Object