org.forgerock.openam.scripting

Class StandardScriptEngineManager

java.lang.Object

javax.script.ScriptEngineManager

org.forgerock.openam.scripting.StandardScriptEngineManager

public final class StandardScriptEngineManager
extends ScriptEngineManager

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. This is used to adjust sandboxing and thread pool implementations in response to application configuration changes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StandardScriptEngineManager.ConfigurationListener Observer pattern interface for listening to changes in the script engine configuration.

Constructor Summary

Constructors

Constructor and Description
StandardScriptEngineManager() Constructs and configures the engine manager.

Method Summary

Modifier and Type	Method and Description
boolean	addConfigurationListener(StandardScriptEngineManager.ConfigurationListener listener) Adds an observer to be called whenever the current script engine configuration changes.
ScriptEngineConfiguration	getConfiguration() Get the current script engine configuration in use for evaluating scripts.
boolean	removeConfigurationListener(StandardScriptEngineManager.ConfigurationListener listener) Removes a configuration listener from the list of active subscribers.
void	setConfiguration(ScriptEngineConfiguration newConfiguration) Sets the configuration to use when evaluating any scripts.

Methods inherited from class javax.script.ScriptEngineManager

get, getBindings, getEngineByExtension, getEngineByMimeType, getEngineByName, getEngineFactories, put, registerEngineExtension, registerEngineMimeType, registerEngineName, setBindings

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardScriptEngineManager

@Inject
public StandardScriptEngineManager()

Constructs and configures the engine manager.

Method Detail

setConfiguration

public void setConfiguration(ScriptEngineConfiguration newConfiguration)

Sets the configuration to use when evaluating any scripts. This method will synchronously publish the new configuration to all registered listeners and atomically update the configuration stored in this manager.

Parameters:

newConfiguration - the new configuration to use.

getConfiguration

public ScriptEngineConfiguration getConfiguration()

Get the current script engine configuration in use for evaluating scripts. The configuration object is immutable and is guaranteed to be a consistent reflection of the last configuration that was set. Calls to setConfiguration(ScriptEngineConfiguration) always 'happen-before' any subsequent calls to this method.

Returns:

the current configuration.

addConfigurationListener

public boolean addConfigurationListener(StandardScriptEngineManager.ConfigurationListener listener)

Adds an observer to be called whenever the current script engine configuration changes. The listener will be called immediately after the configuration is updated and is guaranteed to be passed a consistent (immutable) object representing the new configuration. If the configuration is updated by multiple threads in quick succession, then the final configuration is guaranteed to be the configuration that was most recently published to any subscribers.

Parameters:

listener - the configuration listener to register.

Returns:

true if the listener was registered, or false if it was already registered.

removeConfigurationListener

public boolean removeConfigurationListener(StandardScriptEngineManager.ConfigurationListener listener)

Removes a configuration listener from the list of active subscribers. No subsequent configuration changes will be published to this listener.

Parameters:

listener - the listener to remove.

Returns:

true if the listener was removed, or false if it was not previously registered.