SecureJavascriptConfigurator (Flowable - Secure Scripting 6.4.2 API)

java.lang.Object
- org.flowable.engine.cfg.AbstractProcessEngineConfigurator
- - org.flowable.scripting.secure.SecureJavascriptConfigurator

All Implemented Interfaces:

org.flowable.common.engine.impl.EngineConfigurator
```
public class SecureJavascriptConfigurator
extends AbstractProcessEngineConfigurator
```
Author:

Joram Barrez

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`enableClassWhiteListing` When true, by default all classes will be blacklisted and all classes that want to be used will need to be whitelisted individually.
`protected long`	`maxMemoryUsed` Limits the memory used by the script.
`protected long`	`maxScriptExecutionTime` The maximum time (in ms) that a script is allowed to execute before stopping it.
`protected int`	`maxStackDepth` Limits the stack depth while calling functions within the script.
`protected int`	`nrOfInstructionsBeforeStateCheckCallback` The maximum script execution time and memory usage is implemented using a callback that is called every x instructions of the script.
`protected int`	`scriptOptimizationLevel` By default, no script optimization is applied.
`static SecureScriptClassShutter`	`secureScriptClassShutter`
`static SecureScriptContextFactory`	`secureScriptContextFactory`
`protected Set<String>`	`whiteListedClasses` Whitelisted classes for script execution.

Fields inherited from class org.flowable.engine.cfg.AbstractProcessEngineConfigurator
DEFAULT_CONFIGURATOR_PRIORITY

Constructor Summary

Constructors
Constructor and Description

SecureJavascriptConfigurator()

Constructors
Constructor and Description
`SecureJavascriptConfigurator()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SecureJavascriptConfigurator`	`addWhiteListedClass(String whiteListedClass)`
`void`	`beforeInit(org.flowable.common.engine.impl.AbstractEngineConfiguration engineConfiguration)`
`long`	`getMaxMemoryUsed()`
`long`	`getMaxScriptExecutionTime()`
`int`	`getMaxStackDepth()`
`int`	`getNrOfInstructionsBeforeStateCheckCallback()`
`int`	`getScriptOptimizationLevel()`
`static SecureScriptClassShutter`	`getSecureScriptClassShutter()`
`SecureScriptContextFactory`	`getSecureScriptContextFactory()`
`Set<String>`	`getWhiteListedClasses()`
`protected void`	`initSecureScriptContextFactory()`
`boolean`	`isEnableClassWhiteListing()`
`SecureJavascriptConfigurator`	`setEnableClassWhiteListing(boolean enableClassWhiteListing)`
`SecureJavascriptConfigurator`	`setMaxMemoryUsed(long maxMemoryUsed)`
`SecureJavascriptConfigurator`	`setMaxScriptExecutionTime(long maxScriptExecutionTime)`
`SecureJavascriptConfigurator`	`setMaxStackDepth(int maxStackDepth)`
`SecureJavascriptConfigurator`	`setNrOfInstructionsBeforeStateCheckCallback(int nrOfInstructionsBeforeStateCheckCallback)`
`SecureJavascriptConfigurator`	`setScriptOptimizationLevel(int scriptOptimizationLevel)`
`SecureJavascriptConfigurator`	`setWhiteListedClasses(Set<String> whiteListedClasses)`

Methods inherited from class org.flowable.engine.cfg.AbstractProcessEngineConfigurator
configure, getPriority

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - secureScriptContextFactory
```
public static SecureScriptContextFactory secureScriptContextFactory
```
  - secureScriptClassShutter
```
public static SecureScriptClassShutter secureScriptClassShutter
```
  - enableClassWhiteListing
```
protected boolean enableClassWhiteListing
```
    When true, by default all classes will be blacklisted and all classes that want to be used will need to be whitelisted individually.
  - whiteListedClasses
```
protected Set<String> whiteListedClasses
```
    Whitelisted classes for script execution. By default empty (i.e. everything is blacklisted) From the Rhino ClassShutter javadoc: Due to the fact that there is no package reflection in Java, this method will also be called with package names. There is no way for Rhino to tell if "Packages.a.b" is a package name or a class that doesn't exist. What Rhino does is attempt to load each segment of "Packages.a.b.c": It first attempts to load class "a", then attempts to load class "a.b", then finally attempts to load class "a.b.c". On a Rhino installation without any ClassShutter set, and without any of the above classes, the expression "Packages.a.b.c" will result in a [JavaPackage a.b.c] and not an error. With ClassShutter supplied, Rhino will first call visibleToScripts before attempting to look up the class name. If visibleToScripts returns false, the class name lookup is not performed and subsequent Rhino execution assumes the class is not present. So for "java.lang.System.out.println" the lookup of "java.lang.System" is skipped and thus Rhino assumes that "java.lang.System" doesn't exist. So then for "java.lang.System.out", Rhino attempts to load the class "java.lang.System.out" because it assumes that "java.lang.System" is a package name.
  - maxScriptExecutionTime
```
protected long maxScriptExecutionTime
```
    The maximum time (in ms) that a script is allowed to execute before stopping it. By default disabled.
  - maxStackDepth
```
protected int maxStackDepth
```
    Limits the stack depth while calling functions within the script. By default disabled.
  - maxMemoryUsed
```
protected long maxMemoryUsed
```
    Limits the memory used by the script. If the memory limit is reached, an exception will be thrown and the script will be stopped.
  - nrOfInstructionsBeforeStateCheckCallback
```
protected int nrOfInstructionsBeforeStateCheckCallback
```
    The maximum script execution time and memory usage is implemented using a callback that is called every x instructions of the script. Note that these are not script instructions, but java byte code instructions (which means one script line can be thousands of byte code instructions!).
  - scriptOptimizationLevel
```
protected int scriptOptimizationLevel
```
    By default, no script optimization is applied. Change this setting to change the Rhino script optimization level. Note: some simple performance tests seem to indicate that for basic scripts upping this value actually has worse results ... Note: if using a maxStackDepth setting, the script optimization level will always be -1.
- Constructor Detail
  - SecureJavascriptConfigurator
```
public SecureJavascriptConfigurator()
```
- Method Detail
  - beforeInit
```
public void beforeInit(org.flowable.common.engine.impl.AbstractEngineConfiguration engineConfiguration)
```
    Specified by:
    
    beforeInit in interface org.flowable.common.engine.impl.EngineConfigurator
    
    Overrides:
    
    beforeInit in class AbstractProcessEngineConfigurator
  - initSecureScriptContextFactory
```
protected void initSecureScriptContextFactory()
```
  - isEnableClassWhiteListing
```
public boolean isEnableClassWhiteListing()
```
  - setEnableClassWhiteListing
```
public SecureJavascriptConfigurator setEnableClassWhiteListing(boolean enableClassWhiteListing)
```
  - getWhiteListedClasses
```
public Set<String> getWhiteListedClasses()
```
  - setWhiteListedClasses
```
public SecureJavascriptConfigurator setWhiteListedClasses(Set<String> whiteListedClasses)
```
  - addWhiteListedClass
```
public SecureJavascriptConfigurator addWhiteListedClass(String whiteListedClass)
```
  - getMaxScriptExecutionTime
```
public long getMaxScriptExecutionTime()
```
  - setMaxScriptExecutionTime
```
public SecureJavascriptConfigurator setMaxScriptExecutionTime(long maxScriptExecutionTime)
```
  - getNrOfInstructionsBeforeStateCheckCallback
```
public int getNrOfInstructionsBeforeStateCheckCallback()
```
  - setNrOfInstructionsBeforeStateCheckCallback
```
public SecureJavascriptConfigurator setNrOfInstructionsBeforeStateCheckCallback(int nrOfInstructionsBeforeStateCheckCallback)
```
  - getMaxStackDepth
```
public int getMaxStackDepth()
```
  - setMaxStackDepth
```
public SecureJavascriptConfigurator setMaxStackDepth(int maxStackDepth)
```
  - getMaxMemoryUsed
```
public long getMaxMemoryUsed()
```
  - setMaxMemoryUsed
```
public SecureJavascriptConfigurator setMaxMemoryUsed(long maxMemoryUsed)
```
  - getScriptOptimizationLevel
```
public int getScriptOptimizationLevel()
```
  - setScriptOptimizationLevel
```
public SecureJavascriptConfigurator setScriptOptimizationLevel(int scriptOptimizationLevel)
```
  - getSecureScriptContextFactory
```
public SecureScriptContextFactory getSecureScriptContextFactory()
```
  - getSecureScriptClassShutter
```
public static SecureScriptClassShutter getSecureScriptClassShutter()
```

Class SecureJavascriptConfigurator

Field Summary

Fields inherited from class org.flowable.engine.cfg.AbstractProcessEngineConfigurator

Constructor Summary

Method Summary

Methods inherited from class org.flowable.engine.cfg.AbstractProcessEngineConfigurator

Methods inherited from class java.lang.Object

Field Detail

secureScriptContextFactory

secureScriptClassShutter

enableClassWhiteListing

whiteListedClasses

maxScriptExecutionTime

maxStackDepth

maxMemoryUsed

nrOfInstructionsBeforeStateCheckCallback

scriptOptimizationLevel

Constructor Detail

SecureJavascriptConfigurator

Method Detail

beforeInit

initSecureScriptContextFactory

isEnableClassWhiteListing

setEnableClassWhiteListing

getWhiteListedClasses

setWhiteListedClasses

addWhiteListedClass

getMaxScriptExecutionTime

setMaxScriptExecutionTime

getNrOfInstructionsBeforeStateCheckCallback

setNrOfInstructionsBeforeStateCheckCallback

getMaxStackDepth

setMaxStackDepth

getMaxMemoryUsed

setMaxMemoryUsed

getScriptOptimizationLevel

setScriptOptimizationLevel

getSecureScriptContextFactory

getSecureScriptClassShutter