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 Details

    • language

      protected String language

    • script

      protected String script

    • scopeContainer

      protected VariableContainer scopeContainer

    • inputVariableContainer

      protected VariableContainer inputVariableContainer

    • additionalResolvers

      protected List<Resolver> additionalResolvers

    • storeScriptVariables

      protected boolean storeScriptVariables

    • traceEnhancer

      protected ScriptTraceEnhancer traceEnhancer

  • Constructor Details

    • Builder

      protected Builder()

  • Method Details

    • 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.

    • scopeContainer

      public ScriptEngineRequest.Builder scopeContainer(VariableContainer variableContainer)
      The scope variable container in which the script is being executed in. 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.
      See Also:

    • inputVariableContainer

      public ScriptEngineRequest.Builder inputVariableContainer(VariableContainer variableContainer)
      The variable container that can be used to provide different dynamic variables for the script context. If not provided then the scopeContainer will be used.

      e.g. if we have the following script var sum = a + b. When inputVariableContainer is defined the variables a and b will come from it. Otherwise, they will come from the variable container defined in scopeContainer(VariableContainer).

      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 scopeContainer. 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()