io.apigee.trireme.core

Class NodeEnvironment

java.lang.Object

io.apigee.trireme.core.NodeEnvironment

public class NodeEnvironment
extends Object

This class is the root of all script processing. Typically it will be created once per process (although this is not required). It sets up the global environment, including initializing the JavaScript context that will be inherited by everything else.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CORE_POOL_SIZE
static int	DEFAULT_JS_VERSION
static String	DEFAULT_NODE_VERSION The default version of the Node.js runtime that will be used.
static int	DEFAULT_OPT_LEVEL
static int	MAX_POOL_SIZE
static int	POOL_QUEUE_SIZE
static long	POOL_TIMEOUT_SECS

Constructor Summary

Constructors

Constructor and Description
NodeEnvironment() Create a new NodeEnvironment with all the defaults.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Free any resources used by the environment.
NodeScript	createScript(String[] args, boolean forceRepl) Create an instance of the script that will process command-line arguments from argv like regular Node.js.
NodeScript	createScript(String scriptName, File script, String[] args) Create an instance of a script attached to this environment.
NodeScript	createScript(String scriptName, String script, String[] args) Create an instance of a script attached to this environment.
ExecutorService	getAsyncPool() Internal: Get the thread pool for async tasks.
ClassCache	getClassCache()
org.mozilla.javascript.ContextFactory	getContextFactory() Internal: Get the Rhino ContextFactory for this environment.
String	getDefaultNodeVersion() Return the default implementation version.
HttpServerContainer	getHttpContainer()
int	getMaxAsyncPoolSize()
List<String>	getNodeVersions() Return a list of Node.js implementations available in this environment.
int	getOptLevel()
RootModuleRegistry	getRegistry(String version) Internal: Get the registry for a particular implementation
Sandbox	getSandbox()
ExecutorService	getScriptPool() Internal: Get the thread pool for running script threads.
long	getScriptTimeLimit()
boolean	isSealRoot() Deprecated.
void	setClassCache(ClassCache cache) Set a cache that may be used to store compiled JavaScript classes.
void	setDefaultClassCache() Create a default instance of the class cache using an internal implementation.
void	setDefaultNodeVersion(String version) Override the default version.
NodeEnvironment	setHttpContainer(HttpServerContainer container) Replace the default HTTP implementation with a custom implementation.
void	setMaxAsyncPoolSize(int size) Set the maximum thread pool size of the "async pool," which will be used for running short-duration blocking tasks like file I/O, DNS lookups, and some TLS operations.
NodeEnvironment	setOptLevel(int optLevel) Set the Rhino optimization level for all new scripts that are run.
NodeEnvironment	setSandbox(Sandbox box) Set up a restricted environment.
NodeEnvironment	setScriptTimeLimit(long limit, TimeUnit unit) Set the maximum amount of time that any one "tick" of this script is allowed to execute before an exception is raised and the script exits.
NodeEnvironment	setSealRoot(boolean sealRoot) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NODE_VERSION

public static final String DEFAULT_NODE_VERSION

The default version of the Node.js runtime that will be used.

See Also:

Constant Field Values

CORE_POOL_SIZE

public static final int CORE_POOL_SIZE

See Also:

Constant Field Values

MAX_POOL_SIZE

public static final int MAX_POOL_SIZE

See Also:

Constant Field Values

POOL_QUEUE_SIZE

public static final int POOL_QUEUE_SIZE

See Also:

Constant Field Values

POOL_TIMEOUT_SECS

public static final long POOL_TIMEOUT_SECS

See Also:

Constant Field Values

DEFAULT_JS_VERSION

public static final int DEFAULT_JS_VERSION

See Also:

Constant Field Values

DEFAULT_OPT_LEVEL

public static final int DEFAULT_OPT_LEVEL

See Also:

Constant Field Values

Constructor Detail

NodeEnvironment

public NodeEnvironment()

Create a new NodeEnvironment with all the defaults.

Method Detail

setSandbox

public NodeEnvironment setSandbox(Sandbox box)

Set up a restricted environment. The specified Sandbox object can specify restrictions on which files are opened, how standard input and output are handled, and what network I/O operations are allowed. The sandbox is checked when this call is made, so please set all parameters on the Sandbox object before calling this method.

getSandbox

public Sandbox getSandbox()

close

public void close()

Free any resources used by the environment.

getNodeVersions

public List<String> getNodeVersions()

Return a list of Node.js implementations available in this environment.

getDefaultNodeVersion

public String getDefaultNodeVersion()

Return the default implementation version.

setDefaultNodeVersion

public void setDefaultNodeVersion(String version)

Override the default version.

createScript

public NodeScript createScript(String scriptName,
                      File script,
                      String[] args)
                        throws NodeException

Create an instance of a script attached to this environment. Any "setters" that you wish to change for this environment must be called before the first script is run.

When this form of the script is used, all of the arguments will appear on the command line as if they were passed after the name of the script. So, if "foo" and "bar" are passed as arguments, and the script is called "baz.js", then the resulting process.argv will contain, in order:

1. ./node
2. baz.js
3. foo
4. bar

Throws:

NodeException

createScript

public NodeScript createScript(String scriptName,
                      String script,
                      String[] args)
                        throws NodeException

Create an instance of a script attached to this environment. Any "setters" that you wish to change for this environment must be called before the first script is run.

When this form of the script is used, all of the arguments will appear on the command line as if they were passed after the name of the script. So, if "foo" and "bar" are passed as arguments, and the script is called "baz.js", then the resulting process.argv will contain, in order:

1. ./node
2. baz.js
3. foo
4. bar

Throws:

NodeException

createScript

public NodeScript createScript(String[] args,
                      boolean forceRepl)
                        throws NodeException

Create an instance of the script that will process command-line arguments from argv like regular Node.js. This script will look at process.argv for a script file name, and if not found it will either run the "repl" (if "forceRepl" is true or stdin is not a TTY) or it will read from standard input.

When this form of the script is used, arguments passed before the script name are interpreted by Trireme and not passed to the script, just like regular Node.js. So for instance, if the following list of arguments is passed:

1. --expose-gc
2. foo.js
3. bar
4. baz

then process.argv will contain:

1. ./node
2. baz.js
3. foo
4. bar

and "--expose-gc" will be interpreted by Trireme.

Currently, only a small number of options are supported. They are:

• --expose-gc
• --trace-deprecation
• --throw-deprecation
• --no-deprecation

Throws:

NodeException

setHttpContainer

public NodeEnvironment setHttpContainer(HttpServerContainer container)

Replace the default HTTP implementation with a custom implementation. Must be set before any calls to "createScript" in order to have any effect.

getHttpContainer

public HttpServerContainer getHttpContainer()

getOptLevel

public int getOptLevel()

setOptLevel

public NodeEnvironment setOptLevel(int optLevel)

Set the Rhino optimization level for all new scripts that are run. -1 means interpreted mode, 0 means no optimization, 1 or greater means some optimization. Default is 1. Must be set before any calls to "createScript" in order to have any effect.

isSealRoot

@Deprecated
public boolean isSealRoot()

Deprecated.

setSealRoot

@Deprecated
public NodeEnvironment setSealRoot(boolean sealRoot)

Deprecated.

Formerly used to seal the root context so that scripts could not modify it. Now, all scripts have their own root context and there is no need to seal it, so this method does nothing.

setScriptTimeLimit

public NodeEnvironment setScriptTimeLimit(long limit,
                                 TimeUnit unit)

Set the maximum amount of time that any one "tick" of this script is allowed to execute before an exception is raised and the script exits. Must be set before any calls to "createScript" in order to have any effect.

getScriptTimeLimit

public long getScriptTimeLimit()

setClassCache

public void setClassCache(ClassCache cache)

Set a cache that may be used to store compiled JavaScript classes. This can result in a large decrease in PermGen space for large environments. The user must implement the interface.

setDefaultClassCache

public void setDefaultClassCache()

Create a default instance of the class cache using an internal implementation. Currently this implementation uses a hash map of SoftReference objects.

getClassCache

public ClassCache getClassCache()

setMaxAsyncPoolSize

public void setMaxAsyncPoolSize(int size)

Set the maximum thread pool size of the "async pool," which will be used for running short-duration blocking tasks like file I/O, DNS lookups, and some TLS operations. The default is 100. It must be called before "execute" is called on the first script that uses this environment, or it will have no effect.

getMaxAsyncPoolSize

public int getMaxAsyncPoolSize()

getAsyncPool

public ExecutorService getAsyncPool()

Internal: Get the thread pool for async tasks.

getScriptPool

public ExecutorService getScriptPool()

Internal: Get the thread pool for running script threads.

getRegistry

public RootModuleRegistry getRegistry(String version)

Internal: Get the registry for a particular implementation

getContextFactory

public org.mozilla.javascript.ContextFactory getContextFactory()

Internal: Get the Rhino ContextFactory for this environment.