org.netbeans.api.scripting

Class Scripting

java.lang.Object

org.netbeans.api.scripting.Scripting

public final class Scripting
extends Object

NetBeans aware access to ScriptEngineManager manager. Rather than using JDK's ScriptEngineManager manager directly, instantiate it via Scripting.createManager() method. This method is aware of NetBeans specific runtime configurations. It uses the right classloader as well as specific discovery mechanisms to locate additional implementations of ScriptEngineFactory. To execute a JavaScript code use:

ScriptEngine js = Scripting.createManager().getEngineByMimeType("text/javascript");
assumeTrue(js != null || System.getProperty("java.vendor.version").contains("Graal"));

Number x = (Number) js.eval("6 * 7");

assert x.intValue() == 42;

Consult scripting tutorial to learn more about advanced polyglot scripting topics.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Scripting	allowAllAccess(boolean allAccess) Allows the scripts to access JVM classes.
ScriptEngineManager	build() Create new ScriptEngineManager configured for the NetBeans environment.
static ScriptEngineManager	createManager() Create new ScriptEngineManager configured for the NetBeans environment.
static Scripting	newBuilder() A builder to configure and create new instance of ScriptEngineManager.

Methods inherited from class java.lang.Object

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

Method Detail

createManager

public static ScriptEngineManager createManager()

Create new ScriptEngineManager configured for the NetBeans environment. The manager serves as an isolated environment - engines created from the same manager are supposed to share the same internals and be able to communicate with each other.

Returns:

new instance of the engine manager

newBuilder

public static Scripting newBuilder()

A builder to configure and create new instance of ScriptEngineManager.

Returns:

a builder object with Scripting.build() method

Since:

1.2

allowAllAccess

public Scripting allowAllAccess(boolean allAccess)

Allows the scripts to access JVM classes. By default the scripts run in as restricted environment as possible. See scripting tutorial for details. That is the prefered mode of execution. However, if your script is known and trusted, you may allow it to access classes and features in the JVM. For example it is common in Nashorn scripts to use:

Object fn = engine.eval("(function(obj) {\n"
        + "  var Long = Java.type('java.lang.Long');\n"
        + "  return new Long(33);\n"
        + "})\n");

Such classloading is prevented by default. To allow it, specify true in here.

ScriptEngineManager created with all access on, has a boolean property in its ScriptEngineManager.getBindings():

ScriptEngineManager manager = Scripting.newBuilder().
    allowAllAccess(true).build();
assertEquals(Boolean.TRUE, manager.getBindings().get("allowAllAccess"));

Parameters:

allAccess - allow access to JVM internals from the script

Returns:

instance of this builder

Since:

1.2

build

public ScriptEngineManager build()

Create new ScriptEngineManager configured for the NetBeans environment. The manager serves as an isolated environment - engines created from the same manager are supposed to share the same internals and be able to communicate with each other.

Returns:

new instance of the engine manager

Since:

1.2