ScriptEngineConfiguration (OpenAM Scripting 15.1.2 API)

java.lang.Object
- org.forgerock.openam.scripting.ScriptEngineConfiguration

```
public final class ScriptEngineConfiguration
extends Object
```
Holds the current configuration options for script engine execution. This controls various aspects of script execution, such as maximum time-outs, white-/black-lists for sandboxing, etc. This is an immutable value object to ensure that a script engine can rely on the configuration not changing during execution of a script. Configuration changes are made by updating the entire configuration object on the StandardScriptEngineManager as an atomic action and will be picked up by new script executions, while existing executions will continue using the old configuration. This ensures consistency of configuration parameters during script execution.

Since:

12.0.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ScriptEngineConfiguration.Builder` Builder pattern for constructing immutable script configuration instances using a fluent API.

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`NO_TIMEOUT` Constant to indicate no script timeout should be used.
`static int`	`UNBOUNDED_QUEUE_SIZE` Constant to indicate that the thread pool queue should be unbounded.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ScriptEngineConfiguration.Builder`	`builder()` Creates a fresh configuration builder.
`boolean`	`equals(Object o)`
`List<Pattern>`	`getClassBlackList()` Gets the current Java class name blacklist patterns.
`List<Pattern>`	`getClassWhiteList()` Gets the current Java class name whitelist patterns.
`long`	`getScriptExecutionTimeout()` Returns the maximum script execution time limit, in seconds.
`SecurityManager`	`getSecurityManager()` Gets the Java SecurityManager to use when checking if a Java class or package should be exposed to a script.
`int`	`getThreadPoolCoreSize()` The number of threads to keep in the thread pool used to service script execution requests.
`long`	`getThreadPoolIdleTimeoutSeconds()` The number of seconds to wait before terminating additional threads (beyond core pool size, up to max pool size) that were started to service a full task queue.
`int`	`getThreadPoolMaxSize()` The maximum number of threads to use to service script execution requests once the task queue has reached capacity.
`int`	`getThreadPoolQueueSize()` The size of the queue to use for buffering tasks when all threads in the thread pool are in use.
`int`	`hashCode()`
`String`	`toString()`

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

- Field Detail
  - NO_TIMEOUT
```
public static final long NO_TIMEOUT
```
    Constant to indicate no script timeout should be used.
    
    See Also:
    
    Constant Field Values
  - UNBOUNDED_QUEUE_SIZE
```
public static final int UNBOUNDED_QUEUE_SIZE
```
    Constant to indicate that the thread pool queue should be unbounded.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getScriptExecutionTimeout
```
public long getScriptExecutionTimeout()
```
    Returns the maximum script execution time limit, in seconds. Returns NO_TIMEOUT to indicate no timeout.
    
    Returns:
    
    the maximum script execution time in seconds.
  - getClassWhiteList
```
public List<Pattern> getClassWhiteList()
```
    Gets the current Java class name whitelist patterns. Every Java class that is accessed by a script must match at least one of the regular expression patterns in this list, otherwise an error will be raised and script execution halted. Patterns should match the fully-qualified class name.
    
    Returns:
    
    the Java class white-list. Never null. Unmodifiable.
  - getClassBlackList
```
public List<Pattern> getClassBlackList()
```
    Gets the current Java class name blacklist patterns. Any Java class that matches one of the whitelist patterns is then matched against each pattern in this blacklist. If the fully-qualified class name matches any pattern in this blacklist then access to that class is denied, and an error is raised.
    
    Returns:
    
    the Java class black-list. Never null. Unmodifiable.
  - getSecurityManager
```
public SecurityManager getSecurityManager()
```
    Gets the Java SecurityManager to use when checking if a Java class or package should be exposed to a script. If null then no additional checks are done beyond the white-/black-listing. If non-null, then the SecurityManager.checkPackageAccess(String) method will be called for every Java class that is accessed by the script.
    
    Returns:
    
    the SecurityManager to use to check package access. May be null to indicate no security manager.
  - getThreadPoolCoreSize
```
public int getThreadPoolCoreSize()
```
    The number of threads to keep in the thread pool used to service script execution requests. The pool will grow as new script executions are submitted up to this size initially before new tasks are queued to be processed later.
    
    Returns:
    
    the core number of threads in the thread pool.
  - getThreadPoolMaxSize
```
public int getThreadPoolMaxSize()
```
    The maximum number of threads to use to service script execution requests once the task queue has reached capacity. After the queue backlog has been serviced any additional threads beyond the core pool size (up to this maximum size) will eventually be terminated (after the idle timeout has elapsed). This setting has no effect if the queue is unbounded.
    
    Returns:
    
    the maximum number of threads to use when the task queue is at capacity.
  - getThreadPoolQueueSize
```
public int getThreadPoolQueueSize()
```
    The size of the queue to use for buffering tasks when all threads in the thread pool are in use. Use UNBOUNDED_QUEUE_SIZE to specify an unbounded queue (this disables the threadPoolMaxSize option). There is a trade-off between queue size and maximum pool size. For long-running I/O-bound scripts (e.g., those making REST calls) it is better to have a larger maximum pool size and a smaller queue size so that other threads can run while some are blocked in I/O calls. The short queue size ensures that new requests do not wait too long to be serviced. For scripts that are short-running and CPU-bound then the reverse is true: use a smaller pool size to minimise thread scheduling and context-switching overhead, with a longer queue to avoid rejected execution exceptions.
    
    Returns:
    
    the size of the queue to use for buffering script execution requests.
  - getThreadPoolIdleTimeoutSeconds
```
public long getThreadPoolIdleTimeoutSeconds()
```
    The number of seconds to wait before terminating additional threads (beyond core pool size, up to max pool size) that were started to service a full task queue. A longer timeout will allow the pool to react more quickly to another burst (as new threads do not need to be created and started), but the additional threads will consume some resources (memory, O/S threads, etc) during this time. This setting has no effect on threads in the core pool size as these are only terminated on shutdown.
    
    Returns:
    
    the thread idle timeout in seconds.
  - builder
```
public static ScriptEngineConfiguration.Builder builder()
```
    Creates a fresh configuration builder.
    
    Returns:
    
    a fresh configuration builder.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ScriptEngineConfiguration

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_TIMEOUT

UNBOUNDED_QUEUE_SIZE

Method Detail

getScriptExecutionTimeout

getClassWhiteList

getClassBlackList

getSecurityManager

getThreadPoolCoreSize

getThreadPoolMaxSize

getThreadPoolQueueSize

getThreadPoolIdleTimeoutSeconds

builder

toString

equals

hashCode