Package org.flowable.common.engine.impl.scripting

Class AbstractScriptEvaluator

java.lang.Object

org.flowable.common.engine.impl.scripting.AbstractScriptEvaluator

Direct Known Subclasses:

ScriptExecutionListener, ScriptHttpHandler, ScriptTaskListener, ScriptTypeExecutionListener, ScriptTypeTaskListener

public abstract class AbstractScriptEvaluator
extends Object

Base class simplifying binding and evaluation of scriptable elements.

Author:

Rich Kroll, Joram Barrez, Arthur Hupka-Merle

Field Summary

Fields

Modifier and Type	Field	Description
protected Expression	language	The language of the script e.g.
protected Expression	resultVariable	The name of the result variable to store the result of the script evaluation in the variableScope.
protected String	script	The actual payload of the script in the given language.

Constructor Summary

Constructors

Constructor	Description
AbstractScriptEvaluator()
AbstractScriptEvaluator(Expression language, String script)

Method Summary

Modifier and Type	Method	Description
ScriptEngineRequest.Builder	createScriptRequest(VariableContainer variableContainer)	Validates language and script and creates a pre-populated ScriptEngineRequest.Builder which can be evaluated using evaluateScriptRequest(ScriptEngineRequest.Builder).
protected Object	evaluateScript(ScriptingEngines scriptingEngines, ScriptEngineRequest request)
protected Object	evaluateScriptRequest(ScriptEngineRequest.Builder requestBuilder)
String	getScript()
protected abstract ScriptingEngines	getScriptingEngines()
void	setLanguage(Expression language)
void	setResultVariable(Expression resultVariable)
void	setScript(String script)
void	setScript(Expression script)	Sets the script as Expression for backwards compatibility.
protected void	validateParameters()

Methods inherited from class java.lang.Object

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

Field Details

language

protected Expression language

The language of the script e.g. an Expression evaluating to javascript, juel, groovy, etc. Mandatory.

Must not be or evaluate to null to null.

script

protected String script

The actual payload of the script in the given language. Mandatory.

Must not be or evaluate to null to null.

resultVariable

protected Expression resultVariable

The name of the result variable to store the result of the script evaluation in the variableScope.

Constructor Details

AbstractScriptEvaluator

public AbstractScriptEvaluator()

AbstractScriptEvaluator

public AbstractScriptEvaluator(Expression language,
 String script)

Method Details

createScriptRequest

public ScriptEngineRequest.Builder createScriptRequest(VariableContainer variableContainer)

Validates language and script and creates a pre-populated ScriptEngineRequest.Builder which can be evaluated using evaluateScriptRequest(ScriptEngineRequest.Builder).

Returns:

the ScriptEngineRequest builder instance for further population

evaluateScriptRequest

protected Object evaluateScriptRequest(ScriptEngineRequest.Builder requestBuilder)

evaluateScript

protected Object evaluateScript(ScriptingEngines scriptingEngines,
 ScriptEngineRequest request)

validateParameters

protected void validateParameters()

getScriptingEngines

protected abstract ScriptingEngines getScriptingEngines()

setScript

public void setScript(String script)

setScript

public void setScript(Expression script)

Sets the script as Expression for backwards compatibility. Requires to for 'field' injection of scripts. Expression is not evaluated

getScript

public String getScript()

setLanguage

public void setLanguage(Expression language)

setResultVariable

public void setResultVariable(Expression resultVariable)