io.apigee.trireme.core.modules

Class NativeModule

java.lang.Object

io.apigee.trireme.core.modules.NativeModule

All Implemented Interfaces:

NodeModule

public class NativeModule
extends Object
implements NodeModule

This class implements the NativeModule, which is normally part of "node.js" itself. It is the bootstrapper for the module system and also loads all native modules. The "module" module calls it first to load any internal modules.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NativeModule.ModuleImpl
static class	NativeModule.NativeImpl

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log
static String	MODULE_NAME
static String	NODE_SCRIPT_BASE
static String	NR_SCRIPT_BASE
static String	SCRIPT_SUFFIX

Constructor Summary

Constructors

Constructor and Description
NativeModule()

Method Summary

Methods

Modifier and Type	Method and Description
String	getModuleName() Return the top-level name of the module as it'd be looked up in a "require" call.
org.mozilla.javascript.Scriptable	registerExports(org.mozilla.javascript.Context cx, org.mozilla.javascript.Scriptable scope, NodeRuntime runner) This is the Java equivalent of a Node module.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

MODULE_NAME

public static final String MODULE_NAME

See Also:

Constant Field Values

NODE_SCRIPT_BASE

public static final String NODE_SCRIPT_BASE

See Also:

Constant Field Values

NR_SCRIPT_BASE

public static final String NR_SCRIPT_BASE

See Also:

Constant Field Values

SCRIPT_SUFFIX

public static final String SCRIPT_SUFFIX

See Also:

Constant Field Values

Constructor Detail

NativeModule

public NativeModule()

Method Detail

getModuleName

public String getModuleName()

Description copied from interface: NodeModule

Return the top-level name of the module as it'd be looked up in a "require" call.

Specified by:

getModuleName in interface NodeModule

registerExports

public org.mozilla.javascript.Scriptable registerExports(org.mozilla.javascript.Context cx,
                                                org.mozilla.javascript.Scriptable scope,
                                                NodeRuntime runner)
                                                  throws InvocationTargetException,
                                                         IllegalAccessException,
                                                         InstantiationException

Description copied from interface: NodeModule

This is the Java equivalent of a Node module. In here, you can set properties on "exports" just as you would set properties on "exports" in a regular Node module. You may also declare any classes using ScriptableObject.defineClass -- by defining them on the "exports" object you may make them private to your module. You may also access and define global properties using "scope." Declare any classes that this module needs, and set any other variables on the exports.

The module must create a Scriptable object using the supplied context, then set any "exports" properties on this object and return it.

For example, a module that in JavaScript would assign several functions to "exports" would create a Scriptable object using "scope" as the parent scope, and then set the various functions as properties.

Specified by:

registerExports in interface NodeModule

Parameters:

cx - The Rhino context for the current script and thread

scope - The global scope for the script

runner - an object that may be used to interact with the script runtime

Returns:

the "exports" for the specified module, which may be empty but must not be null

Throws:

InvocationTargetException

IllegalAccessException

InstantiationException