org.jaggeryjs.scriptengine.engine

Class RhinoEngine

java.lang.Object

org.jaggeryjs.scriptengine.engine.RhinoEngine

public class RhinoEngine
extends Object

The RhinoEngine class acts as a global engine for executing JavaScript codes using Mozilla Rhino. Each engine instance associates a scope and a caching manager.

During the class initialization time, it creates a static global scope, which will be cloned upon request. This also has a constructor which accepts class object itself as a parameter. So, it allows you to keep customised versions of RhinoEngine instances.

It also has several util methods to register hostobjects, methods, properties with the engine's scope.

Constructor Summary

Constructors

Constructor and Description
RhinoEngine(CacheManager cacheManager, RhinoContextFactory contextFactory) This constructor gets an existing CacheManager instance and returns a new engine instance with the new cache manager.

Method Summary

Methods

Modifier and Type	Method and Description
Object	call(Reader scriptReader, String funcName, Object[] args, org.mozilla.javascript.ScriptableObject thiz, org.mozilla.javascript.ScriptableObject scope, ScriptCachingContext sctx) Executes a particular JavaScript function from a script on the specified scope and returns the result.
Object	call(Reader scriptReader, String funcName, Object[] args, org.mozilla.javascript.ScriptableObject thiz, ScriptCachingContext sctx) Executes a particular JavaScript function from a script on a clone of engine's scope and returns the result.
Object	call(Reader scriptReader, String funcName, Object[] args, ScriptCachingContext sctx) Executes a particular JavaScript function from a script on a clone of engine's scope and returns the result.
void	defineHostObject(JavaScriptHostObject hostObject) This method registers a hostobject in the engine scope.
static void	defineHostObject(org.mozilla.javascript.ScriptableObject scope, JavaScriptHostObject hostObject) This method registers a hostobject in the given scope.
void	defineMethod(JavaScriptMethod method) This method registers the given method in the engine scope.
static void	defineMethod(org.mozilla.javascript.ScriptableObject scope, JavaScriptMethod method) This method registers the given method in the specified scope.
void	defineModule(JavaScriptModule module) This method registers the given module in the specified scope.
void	defineProperty(JavaScriptProperty property) This method registers the specified property in the engine scope.
static void	defineProperty(org.mozilla.javascript.ScriptableObject scope, JavaScriptProperty property) This method registers the specified property in the specified scope.
void	defineScript(JavaScriptScript script) This method executes the given script in the engine scope.
static void	defineScript(org.mozilla.javascript.ScriptableObject scope, JavaScriptScript script) This method executes the given script in the specified scope.
org.mozilla.javascript.Context	enterContext() Creates a Rhino Context in the current thread or returned the already created one
static org.mozilla.javascript.Context	enterContext(org.mozilla.javascript.ContextFactory factory) Creates a Rhino Context in the current thread using the specified ContextFactory or returned the already created one
static org.mozilla.javascript.Context	enterGlobalContext() Creates a Rhino Context in the current thread using the global ContextFactory or returned the already created one
Object	eval(Reader scriptReader, org.mozilla.javascript.ScriptableObject scope, ScriptCachingContext sctx) Evaluates the specified script and the result is returned.
Object	eval(Reader scriptReader, ScriptCachingContext sctx) Evaluates the specified script and the result is returned.
void	exec(Reader scriptReader, org.mozilla.javascript.ScriptableObject scope, ScriptCachingContext sctx) Executes the script on the specified scope.
org.mozilla.javascript.ScriptableObject	exec(Reader scriptReader, ScriptCachingContext sctx) Executes the script on a clone of the engine scope and the scope is returned.
static void	exitContext() Exists from the context associated in the current thread
static Object	getContextProperty(Object key) Gets a property from the Context of the current thread
org.mozilla.javascript.ScriptableObject	getRuntimeScope() This clones the engine scope and returns.
static org.mozilla.javascript.Scriptable	newObject(org.mozilla.javascript.ScriptableObject scope) Creates a new JavaScript object in the given scope
static void	putContextProperty(Object key, Object value) Puts a property in the Context of the current thread
void	unloadTenant(String tenantId) Unloads all the resources associated with a particular tenant

Methods inherited from class java.lang.Object

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

Constructor Detail

RhinoEngine

public RhinoEngine(CacheManager cacheManager,
           RhinoContextFactory contextFactory)

This constructor gets an existing CacheManager instance and returns a new engine instance with the new cache manager.

Scope of the engine will be a clone of the static global scope associates with the RhinoEngine class.

Parameters:

cacheManager - A CacheManager instance to be used as the cache manager of the engine

Method Detail

defineHostObject

public static void defineHostObject(org.mozilla.javascript.ScriptableObject scope,
                    JavaScriptHostObject hostObject)
                             throws ScriptException

This method registers a hostobject in the given scope.

Parameters:

scope - The scope where hostobject will be defined

hostObject - HostObject to be defined

Throws:

ScriptException

defineHostObject

public void defineHostObject(JavaScriptHostObject hostObject)

This method registers a hostobject in the engine scope.

Parameters:

hostObject - HostObject to be defined

defineProperty

public static void defineProperty(org.mozilla.javascript.ScriptableObject scope,
                  JavaScriptProperty property)

This method registers the specified property in the specified scope.

Parameters:

scope - The scope to register the bean object

property - Property to be defined

defineProperty

public void defineProperty(JavaScriptProperty property)

This method registers the specified property in the engine scope.

Parameters:

property - Property to be defined

defineScript

public static void defineScript(org.mozilla.javascript.ScriptableObject scope,
                JavaScriptScript script)

This method executes the given script in the specified scope.

Parameters:

scope - The scope to register the bean object

script - Script to be defined

defineScript

public void defineScript(JavaScriptScript script)

This method executes the given script in the engine scope.

Parameters:

script - Script to be defined

defineMethod

public static void defineMethod(org.mozilla.javascript.ScriptableObject scope,
                JavaScriptMethod method)
                         throws ScriptException

This method registers the given method in the specified scope.

Parameters:

scope - The scope to register the bean object

method - Method to be defined

Throws:

ScriptException

defineMethod

public void defineMethod(JavaScriptMethod method)

This method registers the given method in the engine scope.

Parameters:

method - Method to be defined

defineModule

public void defineModule(JavaScriptModule module)

This method registers the given module in the specified scope.

Parameters:

module - Module to be defined

eval

public Object eval(Reader scriptReader,
          ScriptCachingContext sctx)
            throws ScriptException

Evaluates the specified script and the result is returned. If the sctx is provided and cache is upto date, cached script will be evaluated instead of the original one. Otherwise, a either cache will be updated or evaluated the script directly without caching.

A clone of the engine scope will be used as the scope during the evaluation.

Parameters:

scriptReader - Reader object to read the script when ever needed

sctx - Script caching context which contains caching data. When null is passed for this, caching will be disabled.

Returns:

Returns the resulting object after evaluating script

Throws:

ScriptException - If error occurred while evaluating

eval

public Object eval(Reader scriptReader,
          org.mozilla.javascript.ScriptableObject scope,
          ScriptCachingContext sctx)
            throws ScriptException

Evaluates the specified script and the result is returned. If the sctx is provided and cache is upto date, cached script will be evaluated instead of the original one. Otherwise, either the cache will be updated or evaluated the script directly without caching.

The specified scope will be used as the scope during the evaluation.

Parameters:

scriptReader - Reader object to read the script when ever needed

scope - Scope to be used during the evaluation

sctx - Script caching context which contains caching data. When null is passed for this, caching will be disabled.

Returns:

Returns the resulting object after evaluating script

Throws:

ScriptException - If error occurred while evaluating

exec

public org.mozilla.javascript.ScriptableObject exec(Reader scriptReader,
                                           ScriptCachingContext sctx)
                                             throws ScriptException

Executes the script on a clone of the engine scope and the scope is returned.

If the sctx is provided and cache is upto date, cached script will be evaluated instead of the original one. Otherwise, either the cache will be updated or evaluated the script directly without caching.

Parameters:

scriptReader - Reader object to read the script when ever needed

sctx - Script caching context which contains caching data. When null is passed for this, caching will be disabled.

Returns:

Modified clone of the engine scope

Throws:

ScriptException - If error occurred while evaluating

exec

public void exec(Reader scriptReader,
        org.mozilla.javascript.ScriptableObject scope,
        ScriptCachingContext sctx)
          throws ScriptException

Executes the script on the specified scope.

If the sctx is provided and cache is upto date, cached script will be evaluated instead of the original one. Otherwise, either the cache will be updated or evaluated the script directly without caching.

Parameters:

scriptReader - Reader object to read the script when ever needed

scope - Scope to be used during the execution

sctx - Script caching context which contains caching data. When null is passed for this, caching will be disabled.

Throws:

ScriptException - If error occurred while evaluating

call

public Object call(Reader scriptReader,
          String funcName,
          Object[] args,
          ScriptCachingContext sctx)
            throws ScriptException

Executes a particular JavaScript function from a script on a clone of engine's scope and returns the result.

Parameters:

scriptReader - Reader object to read the script when ever needed

funcName - Name of the function to be invoked

args - Arguments for the functions as an array of objects

sctx - Script caching context which contains caching data. When null is passed for this, caching will be disabled.

Returns:

Returns the resulting object after invoking the function

Throws:

ScriptException - If error occurred while invoking the function

call

public Object call(Reader scriptReader,
          String funcName,
          Object[] args,
          org.mozilla.javascript.ScriptableObject thiz,
          ScriptCachingContext sctx)
            throws ScriptException

Executes a particular JavaScript function from a script on a clone of engine's scope and returns the result.

Parameters:

scriptReader - Reader object to read the script when ever needed

funcName - Name of the function to be invoked

args - Arguments for the functions as an array of objects

thiz - this object for the function

sctx - Script caching context which contains caching data. When null is passed for this, caching will be disabled.

Returns:

Returns the resulting object after invoking the function

Throws:

ScriptException - If error occurred while invoking the function

call

public Object call(Reader scriptReader,
          String funcName,
          Object[] args,
          org.mozilla.javascript.ScriptableObject thiz,
          org.mozilla.javascript.ScriptableObject scope,
          ScriptCachingContext sctx)
            throws ScriptException

Executes a particular JavaScript function from a script on the specified scope and returns the result.

Parameters:

scriptReader - Reader object to read the script when ever needed

funcName - Name of the function to be invoked

args - Arguments for the functions as an array of objects

thiz - this object for the function

scope - The scope where function will be executed

sctx - Script caching context which contains caching data. When null is passed for this, caching will be disabled.

Returns:

Returns the resulting object after invoking the function

Throws:

ScriptException - If error occurred while invoking the function

getRuntimeScope

public org.mozilla.javascript.ScriptableObject getRuntimeScope()
                                                        throws ScriptException

This clones the engine scope and returns.

Returns:

Cloned scope

Throws:

ScriptException

unloadTenant

public void unloadTenant(String tenantId)

Unloads all the resources associated with a particular tenant

Parameters:

tenantId - Tenant to be unloaded

newObject

public static org.mozilla.javascript.Scriptable newObject(org.mozilla.javascript.ScriptableObject scope)

Creates a new JavaScript object in the given scope

Parameters:

scope - Scope for the object constructor lookup

Returns:

Newly created object

putContextProperty

public static void putContextProperty(Object key,
                      Object value)

Puts a property in the Context of the current thread

Parameters:

key - Property name

value - Property value

getContextProperty

public static Object getContextProperty(Object key)

Gets a property from the Context of the current thread

Parameters:

key - Property name

Returns:

Property value

enterContext

public org.mozilla.javascript.Context enterContext()

Creates a Rhino Context in the current thread or returned the already created one

Returns:

Rhino Context instance

enterContext

public static org.mozilla.javascript.Context enterContext(org.mozilla.javascript.ContextFactory factory)

Creates a Rhino Context in the current thread using the specified ContextFactory or returned the already created one

Returns:

Rhino Context instance

enterGlobalContext

public static org.mozilla.javascript.Context enterGlobalContext()

Creates a Rhino Context in the current thread using the global ContextFactory or returned the already created one

Returns:

Rhino Context instance

exitContext

public static void exitContext()

Exists from the context associated in the current thread