Interface GremlinScriptEngineManager
-
- All Known Implementing Classes:
CachedGremlinScriptEngineManager
,DefaultGremlinScriptEngineManager
public interface GremlinScriptEngineManager
TheScriptEngineManager
implements a discovery, instantiation and configuration mechanism forGremlinScriptEngine
classes and also maintains a collection of key/value pairs storing state shared by all engines created by it. This class uses theServiceProvider
mechanism to enumerate all the implementations ofGremlinScriptEngineFactory
. TheScriptEngineManager
provides a method to return a list of all these factories as well as utility methods which look up factories on the basis of language name, file extension and mime type. TheBindings
of key/value pairs, referred to as the "Global Scope" maintained by the manager is available to all instances of @code ScriptEngine} created by theGremlinScriptEngineManager
. The values in theBindings
are generally exposed in all scripts. This interface is based quite heavily on the workings of theScriptEngineManager
supplied in thejavax.script
packages, but adds some additional features that are specific to Gremlin and TinkerPop. Unfortunately, it's not easily possible to extendScriptEngineManager
directly as there certain behaviors don't appear to be be straightforward to implement and member variables are all private. It is important to note that this interface is designed to provide support for "Gremlin-enabled"ScriptEngine
instances (i.e. those that extend fromGremlinScriptEngine
) and is not meant to manage just anyScriptEngine
instance that may be on the path.- Author:
- Stephen Mallette (http://stephen.genoprime.com)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addPlugin(GremlinPlugin plugin)
AddGremlinPlugin
instances to customize newly createdGremlinScriptEngine
instances.Object
get(String key)
Gets the value for the specified key in the global scope.Bindings
getBindings()
Gets the bindings of theBindings
in global scope.List<Customizer>
getCustomizers(String scriptEngineName)
Get the list ofCustomizer
instances filtered by thescriptEngineName
.GremlinScriptEngine
getEngineByExtension(String extension)
Look up and create aGremlinScriptEngine
for a given extension.GremlinScriptEngine
getEngineByMimeType(String mimeType)
Look up and create aGremlinScriptEngine
for a given mime type.GremlinScriptEngine
getEngineByName(String shortName)
Looks up and creates aGremlinScriptEngine
for a given name.List<GremlinScriptEngineFactory>
getEngineFactories()
Returns a list whose elements are instances of all theGremlinScriptEngineFactory
classes found by the discovery mechanism.void
put(String key, Object value)
Sets the specified key/value pair in the global scope.void
registerEngineExtension(String extension, GremlinScriptEngineFactory factory)
Registers aGremlinScriptEngineFactory
to handle an extension.void
registerEngineMimeType(String type, GremlinScriptEngineFactory factory)
Registers aGremlinScriptEngineFactory
to handle a mime type.void
registerEngineName(String name, GremlinScriptEngineFactory factory)
Registers aGremlinScriptEngineFactory
to handle a language name.void
setBindings(Bindings bindings)
Stores the specifiedBindings
as a global for allGremlinScriptEngine
objects created by it.
-
-
-
Method Detail
-
setBindings
void setBindings(Bindings bindings)
Stores the specifiedBindings
as a global for allGremlinScriptEngine
objects created by it.- Throws:
IllegalArgumentException
- if bindings is null.
-
getBindings
Bindings getBindings()
Gets the bindings of theBindings
in global scope.
-
put
void put(String key, Object value)
Sets the specified key/value pair in the global scope. The key may not be null or empty.- Throws:
IllegalArgumentException
- if key is null or empty.
-
getEngineByName
GremlinScriptEngine getEngineByName(String shortName)
Looks up and creates aGremlinScriptEngine
for a given name. The algorithm first searches for aGremlinScriptEngineFactory
that has been registered as a handler for the specified name using theregisterEngineExtension(String, GremlinScriptEngineFactory)
method. If one is not found, it searches the set ofGremlinScriptEngineFactory
instances stored by the constructor for one with the specified name. If aScriptEngineFactory
is found by either method, it is used to create instance ofGremlinScriptEngine
.- Parameters:
shortName
- The short name of theGremlinScriptEngine
implementation returned by theScriptEngineFactory.getNames()
method.- Returns:
- A
GremlinScriptEngine
created by the factory located in the search. Returnsnull
if no such factory was found. The global scope of this manager is applied to the newly createdGremlinScriptEngine
- Throws:
NullPointerException
- if shortName isnull
.
-
getEngineByExtension
GremlinScriptEngine getEngineByExtension(String extension)
Look up and create aGremlinScriptEngine
for a given extension. The algorithm used bygetEngineByName(String)
is used except that the search starts by looking for aGremlinScriptEngineFactory
registered to handle the given extension usingregisterEngineExtension(String, GremlinScriptEngineFactory)
.- Returns:
- The engine to handle scripts with this extension. Returns
null
if not found. - Throws:
NullPointerException
- if extension isnull
.
-
getEngineByMimeType
GremlinScriptEngine getEngineByMimeType(String mimeType)
Look up and create aGremlinScriptEngine
for a given mime type. The algorithm used bygetEngineByName(String)
is used except that the search starts by looking for aGremlinScriptEngineFactory
registered to handle the given mime type usingregisterEngineMimeType(String, GremlinScriptEngineFactory)
.- Parameters:
mimeType
- The given mime type- Returns:
- The engine to handle scripts with this mime type. Returns
null
if not found. - Throws:
NullPointerException
- if mime-type isnull
.
-
getEngineFactories
List<GremlinScriptEngineFactory> getEngineFactories()
Returns a list whose elements are instances of all theGremlinScriptEngineFactory
classes found by the discovery mechanism.- Returns:
- List of all discovered
GremlinScriptEngineFactory
objects.
-
addPlugin
void addPlugin(GremlinPlugin plugin)
AddGremlinPlugin
instances to customize newly createdGremlinScriptEngine
instances.
-
registerEngineName
void registerEngineName(String name, GremlinScriptEngineFactory factory)
Registers aGremlinScriptEngineFactory
to handle a language name. Overrides any such association found using the discovery mechanism.- Parameters:
name
- The name to be associated with theGremlinScriptEngineFactory
factory
- The class to associate with the given name.- Throws:
NullPointerException
- if any of the parameters is null.
-
registerEngineMimeType
void registerEngineMimeType(String type, GremlinScriptEngineFactory factory)
Registers aGremlinScriptEngineFactory
to handle a mime type. Overrides any such association found using the discovery mechanism.- Parameters:
type
- The mime type to be associated with theGremlinScriptEngineFactory
.factory
- The class to associate with the given mime type.- Throws:
NullPointerException
- if any of the parameters is null.
-
registerEngineExtension
void registerEngineExtension(String extension, GremlinScriptEngineFactory factory)
Registers aGremlinScriptEngineFactory
to handle an extension. Overrides any such association found using the discovery mechanism.- Parameters:
extension
- The extension type to be associated with theGremlinScriptEngineFactory
factory
- The class to associate with the given extension.- Throws:
NullPointerException
- if any of the parameters is null.
-
getCustomizers
List<Customizer> getCustomizers(String scriptEngineName)
Get the list ofCustomizer
instances filtered by thescriptEngineName
.
-
-