org.apache.tinkerpop.gremlin.groovy.jsr223

Class GremlinGroovyScriptEngine

java.lang.Object

GroovyScriptEngineImpl

org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine

All Implemented Interfaces:

AutoCloseable, DependencyManager

public class GremlinGroovyScriptEngine
extends GroovyScriptEngineImpl
implements DependencyManager, AutoCloseable

This ScriptEngine implementation is heavily adapted from the GroovyScriptEngineImpl to include some additional functionality.

Author:

Marko A. Rodriguez (http://markorodriguez.com), Stephen Mallette (http://stephen.genoprime.com)

Field Summary

Fields

Modifier and Type	Field and Description
static ThreadLocal<Map<String,Object>>	COMPILE_OPTIONS
static String	COMPILE_OPTIONS_VAR_TYPES
static String	KEY_REFERENCE_TYPE
protected GremlinGroovyClassLoader	loader
static String	REFERENCE_TYPE_HARD
static String	REFERENCE_TYPE_PHANTOM
static String	REFERENCE_TYPE_SOFT
static String	REFERENCE_TYPE_WEAK

Constructor Summary

Constructors

Constructor and Description
GremlinGroovyScriptEngine()
GremlinGroovyScriptEngine(CompilerCustomizerProvider... compilerCustomizerProviders)

Method Summary

Modifier and Type	Method and Description
void	addImports(Set<String> importStatements) Perform class imports for the ScriptEngine.
void	close()
CompiledScript	compile(Reader reader)
CompiledScript	compile(String scriptSource)
Bindings	createBindings()
Map[]	dependencies() List the dependencies in the ScriptEngine classloader.
Object	eval(Reader reader, ScriptContext context)
Object	eval(String script, ScriptContext context)
ScriptEngineFactory	getFactory()
<T> T	getInterface(Class<T> clazz)
<T> T	getInterface(Object thiz, Class<T> clazz)
protected ClassLoader	getParentLoader()
Map<String,Set<String>>	imports() List the imports in the ScriptEngine;
Object	invokeFunction(String name, Object... args)
Object	invokeMethod(Object thiz, String name, Object... args)
void	loadPlugins(List<GremlinPlugin> plugins) Load a list of GremlinPlugin instances.
Set	plugins()
void	reset() Reset the ScriptEngine.
List<GremlinPlugin>	use(String group, String artifact, String version) Take maven coordinates and load the classes into the classloader used by the ScriptEngine.

Methods inherited from class java.lang.Object

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

Field Detail

COMPILE_OPTIONS_VAR_TYPES

public static final String COMPILE_OPTIONS_VAR_TYPES

See Also:

Constant Field Values

KEY_REFERENCE_TYPE

public static final String KEY_REFERENCE_TYPE

See Also:

Constant Field Values

REFERENCE_TYPE_PHANTOM

public static final String REFERENCE_TYPE_PHANTOM

See Also:

Constant Field Values

REFERENCE_TYPE_WEAK

public static final String REFERENCE_TYPE_WEAK

See Also:

Constant Field Values

REFERENCE_TYPE_SOFT

public static final String REFERENCE_TYPE_SOFT

See Also:

Constant Field Values

REFERENCE_TYPE_HARD

public static final String REFERENCE_TYPE_HARD

See Also:

Constant Field Values

COMPILE_OPTIONS

public static final ThreadLocal<Map<String,Object>> COMPILE_OPTIONS

loader

protected GremlinGroovyClassLoader loader

Constructor Detail

GremlinGroovyScriptEngine

public GremlinGroovyScriptEngine()

GremlinGroovyScriptEngine

public GremlinGroovyScriptEngine(CompilerCustomizerProvider... compilerCustomizerProviders)

Method Detail

use

public List<GremlinPlugin> use(String group,
                               String artifact,
                               String version)

Take maven coordinates and load the classes into the classloader used by the ScriptEngine. Those ScriptEngines that can support script engine plugins should check if there are any new GremlinPlugin implementations in the classloader. The GremlinGroovyScriptEngine implementation uses ServiceLoader to figure out if there are such classes to return.

It is up to the caller to execute the GremlinPlugin.pluginTo(org.apache.tinkerpop.gremlin.groovy.plugin.PluginAcceptor) method. The reason for this has to do with conflicts that can occur with mapper imports that are added via the ImportCustomizerProvider and scripts executed through the PluginAcceptor. Generally speaking, all calls to this "use" method should be complete prior to calling GremlinPlugin.pluginTo(PluginAcceptor).

This method should be called after "expected" imports have been added to the DependencyManager because adding imports with addImports(java.util.Set) will reset the classloader and flush away dependencies.

Specified by:

use in interface DependencyManager

loadPlugins

public void loadPlugins(List<GremlinPlugin> plugins)
                 throws GremlinPluginException

Description copied from interface: DependencyManager

Load a list of GremlinPlugin instances. These plugins are typically returned from calls to DependencyManager.use(String, String, String).

Specified by:

loadPlugins in interface DependencyManager

Throws:

GremlinPluginException - if there is a problem loading the plugin itself.

dependencies

public Map[] dependencies()

Description copied from interface: DependencyManager

List the dependencies in the ScriptEngine classloader.

Specified by:

dependencies in interface DependencyManager

imports

public Map<String,Set<String>> imports()

Description copied from interface: DependencyManager

List the imports in the ScriptEngine;

Specified by:

imports in interface DependencyManager

addImports

public void addImports(Set<String> importStatements)

Description copied from interface: DependencyManager

Perform class imports for the ScriptEngine.

Specified by:

addImports in interface DependencyManager

plugins

public Set plugins()

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

reset

public void reset()

Description copied from interface: DependencyManager

Reset the ScriptEngine. Clear caches and kill the classloader.

Specified by:

reset in interface DependencyManager

eval

public Object eval(Reader reader,
                   ScriptContext context)
            throws ScriptException

Throws:

ScriptException

eval

public Object eval(String script,
                   ScriptContext context)
            throws ScriptException

Throws:

ScriptException

createBindings

public Bindings createBindings()

getFactory

public ScriptEngineFactory getFactory()

compile

public CompiledScript compile(String scriptSource)
                       throws ScriptException

Throws:

ScriptException

compile

public CompiledScript compile(Reader reader)
                       throws ScriptException

Throws:

ScriptException

invokeFunction

public Object invokeFunction(String name,
                             Object... args)
                      throws ScriptException,
                             NoSuchMethodException

Throws:

ScriptException

NoSuchMethodException

invokeMethod

public Object invokeMethod(Object thiz,
                           String name,
                           Object... args)
                    throws ScriptException,
                           NoSuchMethodException

Throws:

ScriptException

NoSuchMethodException

getInterface

public <T> T getInterface(Class<T> clazz)

getInterface

public <T> T getInterface(Object thiz,
                          Class<T> clazz)

getParentLoader

protected ClassLoader getParentLoader()