Package org.forgerock.openam.scripting

Common scripting-related components for use in scripted OpenAM modules (e.g., scripted authentication modules).

Since:

12.0.0

Interface Summary

Interface	Description
ScriptEvaluator	Common component for evaluating scripts in one of the supported scripting languages.
ScriptingLanguage	Pluggable interface for adding support for particular scripting languages.
ScriptValidator	Common component for Validating scripts in one of the supported scripting languages.
StandardScriptEngineManager.ConfigurationListener	Observer pattern interface for listening to changes in the script engine configuration.

Class Summary

Class	Description
ChainedBindings	Custom Bindings implementation that allows scopes to be chained from parent to child.
ScriptConstants	Constants used for managing scripts.
ScriptEngineConfiguration	Holds the current configuration options for script engine execution.
ScriptEngineConfiguration.Builder	Builder pattern for constructing immutable script configuration instances using a fluent API.
ScriptEngineConfigurator	Listens for changes in the global configuration for scripts and propagates those changes to the StandardScriptEngineManager so that individual engines can be configured.
ScriptError	Holds information about validation errors found in a script.
ScriptingSetupListener	This listener will be notified when setup is complete and then try to configure the scripting service.
ScriptObject	Representation of a script in some scripting language.
StandardScriptEngineManager	A singleton implementation of the ScriptEngineManager, this is augmented to support a publish/subscribe (observer) pattern for propagating configuration changes to individual language implementations and other listeners.
StandardScriptEvaluator	Evaluates scripts using the standard JSR 223 script engine framework.
StandardScriptValidator	Validates scripts using the standard JSR 223 script engine framework.
ThreadPoolScriptEvaluator	Evaluates scripts in a configured thread pool so that they can be interrupted after a timeout has occurred.

Enum Summary

Enum	Description
ScriptConstants.GlobalScript	Predefined global script configuration IDs.
ScriptConstants.ScriptContext	The context in which a script will be used.
ScriptConstants.ScriptErrorCode	Error messages are stored in the scripting.properties file to facilitate translation.
SupportedScriptingLanguage	Standard scripting languages supported by OpenAM.

Exception Summary

Exception	Description
ScriptException	General script exception that allows for localised messages.