Package org.camunda.bpm.engine.impl.scripting.env

Class ScriptingEnvironment

java.lang.Object

org.camunda.bpm.engine.impl.scripting.env.ScriptingEnvironment

public class ScriptingEnvironment
extends Object

The scripting environment contains scripts that provide an environment to a user provided script. The environment may contain additional libraries or imports.

The environment performs lazy initialization of scripts: the first time a script of a given script language is executed, the environment will use the ScriptEnvResolvers for resolving the environment scripts for that language. The scripts (if any) are then pre-compiled and cached for reuse.

Author:

Daniel Meyer

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,List<ExecutableScript>>	env	the cached environment scripts per script language
protected List<ScriptEnvResolver>	envResolvers	the resolvers
protected ScriptFactory	scriptFactory	the script factory used for compiling env scripts
protected ScriptingEngines	scriptingEngines	the scripting engines

Constructor Summary

Constructors

Constructor	Description
ScriptingEnvironment(ScriptFactory scriptFactory, List<ScriptEnvResolver> scriptEnvResolvers, ScriptingEngines scriptingEngines)

Method Summary

Modifier and Type	Method	Description
Object	execute(ExecutableScript script, VariableScope scope)	execute a given script in the environment
Object	execute(ExecutableScript script, VariableScope scope, Bindings bindings, ScriptEngine scriptEngine)
protected Map<String,List<ExecutableScript>>	getEnv(String language)
protected List<ExecutableScript>	getEnvScripts(String scriptLanguage)	Returns the env scripts for the given language.
protected List<ExecutableScript>	getEnvScripts(ExecutableScript script, ScriptEngine scriptEngine)
protected Map<String,List<ExecutableScript>>	getPaEnvScripts(ProcessApplicationReference pa)
protected List<ExecutableScript>	initEnvForLanguage(String language)	Initializes the env scripts for a given language.
protected boolean	isEngineRetained(ScriptEngine scriptEngine, ExecutableScript script)
protected boolean	isEngineRetainedBy(ScriptEngine scriptEngine, ExecutableScript script)
protected boolean	isEngineRetainedFailSafe(ScriptEngine scriptEngine, ExecutableScript script)	Wraps isEngineRetained(javax.script.ScriptEngine, org.camunda.bpm.engine.impl.scripting.ExecutableScript) so a failure while determining retention (e.g.

Methods inherited from class java.lang.Object

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

Field Details

env

protected Map<String,List<ExecutableScript>> env

the cached environment scripts per script language

envResolvers

protected List<ScriptEnvResolver> envResolvers

the resolvers

scriptFactory

protected ScriptFactory scriptFactory

the script factory used for compiling env scripts

scriptingEngines

protected ScriptingEngines scriptingEngines

the scripting engines

Constructor Details

ScriptingEnvironment

public ScriptingEnvironment(ScriptFactory scriptFactory,
 List<ScriptEnvResolver> scriptEnvResolvers,
 ScriptingEngines scriptingEngines)

Method Details

execute

public Object execute(ExecutableScript script,
 VariableScope scope)

execute a given script in the environment

Parameters:

script - the ExecutableScript to execute

scope - the scope in which to execute the script

Returns:

the result of the script evaluation

isEngineRetainedFailSafe

protected boolean isEngineRetainedFailSafe(ScriptEngine scriptEngine,
 ExecutableScript script)

Wraps isEngineRetained(javax.script.ScriptEngine, org.camunda.bpm.engine.impl.scripting.ExecutableScript) so a failure while determining retention (e.g. env script resolution hitting an unavailable process application - see getPaEnvScripts(org.camunda.bpm.application.ProcessApplicationReference)) can never propagate out of the finally block in execute(ExecutableScript, VariableScope), where it would mask the try block's real result/exception and skip disposal entirely. On failure, conservatively treats the engine as retained: leaving one private Engine open a little longer is preferable to risking closing one a cached CompiledScript still depends on - see issue #3174.

isEngineRetained

protected boolean isEngineRetained(ScriptEngine scriptEngine,
 ExecutableScript script)

isEngineRetainedBy

protected boolean isEngineRetainedBy(ScriptEngine scriptEngine,
 ExecutableScript script)

execute

public Object execute(ExecutableScript script,
 VariableScope scope,
 Bindings bindings,
 ScriptEngine scriptEngine)

getEnv

protected Map<String,List<ExecutableScript>> getEnv(String language)

getPaEnvScripts

protected Map<String,List<ExecutableScript>> getPaEnvScripts(ProcessApplicationReference pa)

getEnvScripts

protected List<ExecutableScript> getEnvScripts(ExecutableScript script,
 ScriptEngine scriptEngine)

getEnvScripts

protected List<ExecutableScript> getEnvScripts(String scriptLanguage)

Returns the env scripts for the given language. Performs lazy initialization of the env scripts.

Parameters:

scriptLanguage - the language

Returns:

a list of executable environment scripts. Never null.

initEnvForLanguage

protected List<ExecutableScript> initEnvForLanguage(String language)

Initializes the env scripts for a given language.

Parameters:

language - the language

Returns:

the list of env scripts. Never null.