org.forgerock.openam.scripting

Class ScriptEngineConfiguration.Builder

java.lang.Object

org.forgerock.openam.scripting.ScriptEngineConfiguration.Builder

Enclosing class:

ScriptEngineConfiguration

public static final class ScriptEngineConfiguration.Builder
extends Object

Builder pattern for constructing immutable script configuration instances using a fluent API.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ScriptEngineConfiguration	build() Builds the script engine configuration object from the specified parameters.
ScriptEngineConfiguration.Builder	withBlackList(List<Pattern> blackList) Sets the Java class black-list for classes that a script should be forbidden from accessing.
ScriptEngineConfiguration.Builder	withSecurityManager(SecurityManager securityManager) Sets the security manager to use when checking access to Java packages in script execution.
ScriptEngineConfiguration.Builder	withSystemSecurityManager() Sets the security manager to use when checking access to Java packages to the configured system security manager (if enabled).
ScriptEngineConfiguration.Builder	withThreadPoolCoreSize(int coreSize) Sets the core size of the thread pool to use for executing scripts (see ThreadPoolScriptEvaluator).
ScriptEngineConfiguration.Builder	withThreadPoolIdleTimeout(long timeout, TimeUnit units) Sets the timeout after which additional threads (beyond the core pool size) will be terminated once pending requests on the queue have been satisfied.
ScriptEngineConfiguration.Builder	withThreadPoolMaxSize(int maxSize) Sets the maximum size of the thread pool to use for executing scripts (see ThreadPoolScriptEvaluator).
ScriptEngineConfiguration.Builder	withThreadPoolQueueSize(int queueSize) Sets the size of the queue to use for buffering requests for script execution once all core threads are in use.
ScriptEngineConfiguration.Builder	withTimeout(long timeout, TimeUnit unit) Sets the maximum amount of time (in seconds) to allow a script to execute before interrupting it.
ScriptEngineConfiguration.Builder	withWhiteList(List<Pattern> whiteList) Sets the Java class white-list for classes that a script should be allowed to access.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withTimeout

public ScriptEngineConfiguration.Builder withTimeout(long timeout,
                                                     TimeUnit unit)

Sets the maximum amount of time (in seconds) to allow a script to execute before interrupting it. Use ScriptEngineConfiguration.NO_TIMEOUT for no timeout.

Parameters:

timeout - the script execution timeout. Must be >= 0.

unit - the time units of the timeout.

Returns:

this.

withWhiteList

public ScriptEngineConfiguration.Builder withWhiteList(List<Pattern> whiteList)

Sets the Java class white-list for classes that a script should be allowed to access.

Parameters:

whiteList - the class white list. Must not be null.

Returns:

this.

withBlackList

public ScriptEngineConfiguration.Builder withBlackList(List<Pattern> blackList)

Sets the Java class black-list for classes that a script should be forbidden from accessing. Applies after the whitelist.

Parameters:

blackList - the class black list. Must not be null.

Returns:

this.

withSecurityManager

public ScriptEngineConfiguration.Builder withSecurityManager(SecurityManager securityManager)

Sets the security manager to use when checking access to Java packages in script execution.

Parameters:

securityManager - the security manager to use. Use null to disable.

Returns:

this.

withSystemSecurityManager

public ScriptEngineConfiguration.Builder withSystemSecurityManager()

Sets the security manager to use when checking access to Java packages to the configured system security manager (if enabled).

Returns:

this.

See Also:

System.getSecurityManager()

withThreadPoolCoreSize

public ScriptEngineConfiguration.Builder withThreadPoolCoreSize(int coreSize)

Sets the core size of the thread pool to use for executing scripts (see ThreadPoolScriptEvaluator). This is the number of threads that will be created to service requests before new requests are queued.

Parameters:

coreSize - the number of threads to keep in the thread pool. Must be >= 1.

Returns:

this.

withThreadPoolMaxSize

public ScriptEngineConfiguration.Builder withThreadPoolMaxSize(int maxSize)

Sets the maximum size of the thread pool to use for executing scripts (see ThreadPoolScriptEvaluator). This is the maximum number of threads that will be created once the queue reaches capacity.

Parameters:

maxSize - the maximum number of threads to use in the thread pool.

Returns:

this.

withThreadPoolQueueSize

public ScriptEngineConfiguration.Builder withThreadPoolQueueSize(int queueSize)

Sets the size of the queue to use for buffering requests for script execution once all core threads are in use. Use ScriptEngineConfiguration.UNBOUNDED_QUEUE_SIZE for no limit (in which case the maximum pool size option has no effect). Once the core thread pool is at capacity then new script execution requests will be queued up to this limit. Once this limit is reached, then additional threads will be created to service the queue, up to the maximum queue size.

Parameters:

queueSize - the maximum queue size or ScriptEngineConfiguration.UNBOUNDED_QUEUE_SIZE for no limit. Cannot be negative if specified.

Returns:

this.

withThreadPoolIdleTimeout

public ScriptEngineConfiguration.Builder withThreadPoolIdleTimeout(long timeout,
                                                                   TimeUnit units)

Sets the timeout after which additional threads (beyond the core pool size) will be terminated once pending requests on the queue have been satisfied.

Parameters:

timeout - the thread idle timeout.

units - the time unit of the timeout.

Returns:

this.

build

public ScriptEngineConfiguration build()

Builds the script engine configuration object from the specified parameters.

Returns:

a non-null script engine configuration.

Throws:

IllegalStateException - if inconsistent parameters have been specified.