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

Class ScriptEngineRequest.Builder

java.lang.Object

org.flowable.common.engine.impl.scripting.ScriptEngineRequest.Builder

Enclosing class:

ScriptEngineRequest

public static class ScriptEngineRequest.Builder
extends Object

Builder for ScriptEngineRequest.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Resolver>	additionalResolvers
protected String	language
protected String	script
protected boolean	storeScriptVariables
protected ScriptTraceEnhancer	traceEnhancer
protected VariableContainer	variableContainer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()

Method Summary

Modifier and Type	Method	Description
ScriptEngineRequest.Builder	additionalResolver(Resolver additionalResolver)	Adds additional resolver to the end of the list of resolvers.
ScriptEngineRequest	build()
ScriptEngineRequest.Builder	language(String language)	The script language for the script.
ScriptEngineRequest.Builder	script(String script)	The script content for the given language.
ScriptEngineRequest.Builder	storeScriptVariables()	Automatically store variables from script evaluation context to the given variable container.
ScriptEngineRequest.Builder	traceEnhancer(ScriptTraceEnhancer enhancer)	Configure an ScriptTraceEnhancer which is called, when a ScriptTrace is created.
ScriptEngineRequest.Builder	variableContainer(VariableContainer variableContainer)	The variable container used to create Resolvers for the script context.

Methods inherited from class java.lang.Object

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

Field Detail

language

protected String language

script

protected String script

variableContainer

protected VariableContainer variableContainer

additionalResolvers

protected List<Resolver> additionalResolvers

storeScriptVariables

protected boolean storeScriptVariables

traceEnhancer

protected ScriptTraceEnhancer traceEnhancer

Constructor Detail

Builder

protected Builder()

Method Detail

script

public ScriptEngineRequest.Builder script(String script)

The script content for the given language.

language

public ScriptEngineRequest.Builder language(String language)

The script language for the script.

variableContainer

public ScriptEngineRequest.Builder variableContainer(VariableContainer variableContainer)

The variable container used to create Resolvers for the script context. The variable container will be passed to ResolverFactory to create specialized Resolvers for the specific VariableContainer implementations.

storeScriptVariables

public ScriptEngineRequest.Builder storeScriptVariables()

Automatically store variables from script evaluation context to the given variable container. Not recommended, to avoid variableContainer pollution. Better to put the script evaluation result object to the variableContainer, if required.

additionalResolver

public ScriptEngineRequest.Builder additionalResolver(Resolver additionalResolver)

Adds additional resolver to the end of the list of resolvers. The order of the resolvers matter, as the first resolver returning containsKey = true will be used to resolve a variable during script execution. The resolvers take precedence over the resolvers created for the variableContainer. Useful to provide context objects to the scripting environment.

traceEnhancer

public ScriptEngineRequest.Builder traceEnhancer(ScriptTraceEnhancer enhancer)

Configure an ScriptTraceEnhancer which is called, when a ScriptTrace is created. Allows to provide additional context information for a script trace by allow to "tag" the script invocation with additional meta information. Script traces are produced in case of errors and/or when a ScriptTraceListener is configured.

build

public ScriptEngineRequest build()