Package com.orientechnologies.orient.core.command.script

Class OScriptManager

java.lang.Object

com.orientechnologies.orient.core.command.script.OScriptManager

public class OScriptManager
extends Object

Executes Script Commands.

Author:

Luca Garulli (l.garulli--(at)--orientdb.com)

See Also:

• OCommandScript

Field Summary

Fields

Modifier and Type	Field	Description
protected OCommandManager	commandManager
protected ConcurrentHashMap<String,ODatabaseScriptManager>	dbManagers
protected static final String	DEF_LANGUAGE
protected String	defaultLanguage
protected static final Object[]	EMPTY_PARAMS
protected Map<String,ScriptEngineFactory>	engines
protected Map<String,Function<String,OScriptExecutor>>	executorsFactories
protected Map<String,OScriptFormatter>	formatters
protected Map<String,OScriptResultHandler>	handlers
protected List<OScriptInjection>	injections
protected static final int	LINES_AROUND_ERROR
protected ScriptEngineManager	scriptEngineManager

Constructor Summary

Constructors

Constructor	Description
OScriptManager()

Method Summary

Modifier and Type	Method	Description
ScriptEngine	acquireDatabaseEngine(String databaseName, String language)	Acquires a database engine from the pool.
void	addAllowedPackages(Set<String> packages)
Bindings	bind(ScriptEngine scriptEngine, Bindings binding, ODatabaseDocumentInternal db, OCommandContext iContext, Map<Object,Object> iArgs)	Deprecated.
Bindings	bindContextVariables(ScriptEngine engine, Bindings binding, ODatabaseDocumentInternal db, OCommandContext iContext, Map<Object,Object> iArgs)
void	close(String iDatabaseName)	Closes the pool for a database.
void	closeAll()
boolean	existsEngine(String iLanguage)
Set<String>	getAllowedPackages()
OCommandManager	getCommandManager()
ScriptEngine	getEngine(String iLanguage)
Map<String,OScriptFormatter>	getFormatters()	Ask to the Script engine all the formatters
String	getFunctionDefinition(OFunction iFunction)
String	getFunctionInvoke(OFunction iFunction, Object[] iArgs)
List<OScriptInjection>	getInjections()
String	getLibrary(ODatabase<?> db, String iLanguage)	Formats the library of functions for a language.
Iterable<String>	getSupportedLanguages()
Object	handleResult(String language, Object result, ScriptEngine engine, Bindings binding, ODatabaseDocument database)
OScriptManager	registerEngine(String iLanguage, ScriptEngineFactory iEngine)
OScriptManager	registerFormatter(String iLanguage, OScriptFormatter iFormatterImpl)
void	registerInjection(OScriptInjection iInj)
OScriptManager	registerResultHandler(String iLanguage, OScriptResultHandler resultHandler)
void	releaseDatabaseEngine(String iLanguage, String iDatabaseName, ScriptEngine poolEntry)	Acquires a database engine from the pool.
void	removeAllowedPackages(Set<String> packages)
String	throwErrorMessage(ScriptException e, String lib)
void	unbind(ScriptEngine scriptEngine, Bindings binding, OCommandContext iContext, Map<Object,Object> iArgs)	Unbinds variables
void	unregisterInjection(OScriptInjection iInj)

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_PARAMS

protected static final Object[] EMPTY_PARAMS

LINES_AROUND_ERROR

protected static final int LINES_AROUND_ERROR

See Also:

• Constant Field Values

DEF_LANGUAGE

protected static final String DEF_LANGUAGE

See Also:

• Constant Field Values

defaultLanguage

protected String defaultLanguage

scriptEngineManager

protected ScriptEngineManager scriptEngineManager

engines

protected Map<String,ScriptEngineFactory> engines

formatters

protected Map<String,OScriptFormatter> formatters

injections

protected List<OScriptInjection> injections

dbManagers

protected ConcurrentHashMap<String,ODatabaseScriptManager> dbManagers

handlers

protected Map<String,OScriptResultHandler> handlers

executorsFactories

protected Map<String,Function<String,OScriptExecutor>> executorsFactories

commandManager

protected OCommandManager commandManager

Constructor Details

OScriptManager

public OScriptManager()

Method Details

getFunctionDefinition

public String getFunctionDefinition(OFunction iFunction)

getFunctionInvoke

public String getFunctionInvoke(OFunction iFunction,
 Object[] iArgs)

getLibrary

public String getLibrary(ODatabase<?> db,
 String iLanguage)

Formats the library of functions for a language.

Parameters:

db - Current database instance

iLanguage - Language as filter

Returns:

String containing all the functions

existsEngine

public boolean existsEngine(String iLanguage)

getEngine

public ScriptEngine getEngine(String iLanguage)

acquireDatabaseEngine

public ScriptEngine acquireDatabaseEngine(String databaseName,
 String language)

Acquires a database engine from the pool. Once finished using it, the instance MUST be returned in the pool by calling the method #releaseDatabaseEngine(String, ScriptEngine).

Parameters:

databaseName - Database name

language - Script language

Returns:

ScriptEngine instance with the function library already parsed

See Also:

• releaseDatabaseEngine(String, String, ScriptEngine)

releaseDatabaseEngine

public void releaseDatabaseEngine(String iLanguage,
 String iDatabaseName,
 ScriptEngine poolEntry)

Acquires a database engine from the pool. Once finished using it, the instance MUST be returned in the pool by calling the method

Parameters:

iLanguage - Script language

iDatabaseName - Database name

poolEntry - Pool entry to free

See Also:

• acquireDatabaseEngine(String, String)

getSupportedLanguages

public Iterable<String> getSupportedLanguages()

bindContextVariables

public Bindings bindContextVariables(ScriptEngine engine,
 Bindings binding,
 ODatabaseDocumentInternal db,
 OCommandContext iContext,
 Map<Object,Object> iArgs)

bind

@Deprecated
public Bindings bind(ScriptEngine scriptEngine,
 Bindings binding,
 ODatabaseDocumentInternal db,
 OCommandContext iContext,
 Map<Object,Object> iArgs)

Deprecated.

throwErrorMessage

public String throwErrorMessage(ScriptException e,
 String lib)

unbind

public void unbind(ScriptEngine scriptEngine,
 Bindings binding,
 OCommandContext iContext,
 Map<Object,Object> iArgs)

Unbinds variables

Parameters:

binding -

registerInjection

public void registerInjection(OScriptInjection iInj)

getAllowedPackages

public Set<String> getAllowedPackages()

addAllowedPackages

public void addAllowedPackages(Set<String> packages)

removeAllowedPackages

public void removeAllowedPackages(Set<String> packages)

unregisterInjection

public void unregisterInjection(OScriptInjection iInj)

getInjections

public List<OScriptInjection> getInjections()

registerEngine

public OScriptManager registerEngine(String iLanguage,
 ScriptEngineFactory iEngine)

registerFormatter

public OScriptManager registerFormatter(String iLanguage,
 OScriptFormatter iFormatterImpl)

registerResultHandler

public OScriptManager registerResultHandler(String iLanguage,
 OScriptResultHandler resultHandler)

handleResult

public Object handleResult(String language,
 Object result,
 ScriptEngine engine,
 Bindings binding,
 ODatabaseDocument database)

getFormatters

public Map<String,OScriptFormatter> getFormatters()

Ask to the Script engine all the formatters

Returns:

Map containing all the formatters

close

public void close(String iDatabaseName)

Closes the pool for a database. This is called at Orient shutdown and in case a function has been updated.

Parameters:

iDatabaseName -

closeAll

public void closeAll()

getCommandManager

public OCommandManager getCommandManager()