org.forgerock.script.registry

Class ScriptRegistryImpl

java.lang.Object

org.forgerock.script.registry.ScriptRegistryImpl

All Implemented Interfaces:

ScriptEngineFactoryObserver, ScriptRegistry, SourceUnitObserver

public class ScriptRegistryImpl
extends Object
implements ScriptRegistry, ScriptEngineFactoryObserver

A ScriptRegistryImpl does ...

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicReference<Bindings>	globalScope This is the global scope bindings.
static String	SCRIPT_CACHE_DIR

Constructor Summary

Constructors

Constructor and Description
ScriptRegistryImpl()
ScriptRegistryImpl(Map<String,Object> properties, Iterable<ScriptEngineFactory> engine, Bindings globalScope)
ScriptRegistryImpl(Map<String,Object> properties, Iterable<ScriptEngineFactory> engine, Bindings globalScope, ClassLoader registryLevelScriptClassLoader)

Method Summary

Modifier and Type	Method and Description
void	addingEntries(ScriptEngineFactory factory) Called when a ScriptEngineFactory gets started.
void	addScriptListener(ScriptName name, ScriptListener hook)
void	addSourceUnit(SourceUnit unit) Called when a SourceUnit gets started.
Bindings	createBindings()
void	deleteScriptListener(ScriptName name, ScriptListener hook)
Object	get(String key)
Bindings	getBindings()
ScriptEngine	getEngineByName(String shortName) Looks up and creates a ScriptEngine for a given name.
ClassLoader	getRegistryLevelScriptClassLoader()
Set<ScriptName>	listScripts() Lists all ScriptNames available in the registry.
void	put(String key, Object value)
void	removeSourceUnit(SourceUnit unit) Called when a SourceUnit gets stopped.
void	removingEntries(ScriptEngineFactory factory) Called when a ScriptEngineFactory gets stopped.
void	setBindings(Bindings bindings)
protected void	setConfiguration(Map<String,Object> configuration)
void	setRegistryLevelScriptClassLoader(ClassLoader registryLevelScriptClassLoader)
ScriptEntry	takeScript(JsonValue script) Takes a ScriptEntry from this ScriptRegistry.
ScriptEntry	takeScript(ScriptName name) Takes a ScriptEntry from this ScriptRegistry.
ScriptEntry	takeScript(String name)

Methods inherited from class java.lang.Object

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

Field Detail

SCRIPT_CACHE_DIR

public static final String SCRIPT_CACHE_DIR

See Also:

Constant Field Values

globalScope

protected final AtomicReference<Bindings> globalScope

This is the global scope bindings. By default, a null value (which means no global scope) is used.

Constructor Detail

ScriptRegistryImpl

public ScriptRegistryImpl()

ScriptRegistryImpl

public ScriptRegistryImpl(Map<String,Object> properties,
                          Iterable<ScriptEngineFactory> engine,
                          Bindings globalScope)

ScriptRegistryImpl

public ScriptRegistryImpl(Map<String,Object> properties,
                          Iterable<ScriptEngineFactory> engine,
                          Bindings globalScope,
                          ClassLoader registryLevelScriptClassLoader)

Method Detail

setConfiguration

protected void setConfiguration(Map<String,Object> configuration)

getRegistryLevelScriptClassLoader

public ClassLoader getRegistryLevelScriptClassLoader()

Specified by:

getRegistryLevelScriptClassLoader in interface ScriptRegistry

setRegistryLevelScriptClassLoader

public void setRegistryLevelScriptClassLoader(ClassLoader registryLevelScriptClassLoader)

Specified by:

setRegistryLevelScriptClassLoader in interface ScriptRegistry

put

public void put(String key,
                Object value)

get

public Object get(String key)

getBindings

public Bindings getBindings()

setBindings

public void setBindings(Bindings bindings)

createBindings

public Bindings createBindings()

listScripts

public Set<ScriptName> listScripts()

Description copied from interface: ScriptRegistry

Lists all ScriptNames available in the registry.

Specified by:

listScripts in interface ScriptRegistry

Returns:

the list of registered

takeScript

public ScriptEntry takeScript(String name)
                       throws ScriptException

Throws:

ScriptException

getEngineByName

public ScriptEngine getEngineByName(String shortName)

Description copied from interface: ScriptRegistry

Looks up and creates a ScriptEngine for a given name. The algorithm first searches for a ScriptEngineFactory that has been registered as a handler for the specified name using the registerEngineName method.

If one is not found, it searches the array of ScriptEngineFactory instances stored by the constructor for one with the specified name. If a ScriptEngineFactory is found by either method, it is used to create instance of ScriptEngine.

Specified by:

getEngineByName in interface ScriptRegistry

Parameters:

shortName - The short name of the ScriptEngine implementation. returned by the getNames method of its ScriptEngineFactory.

Returns:

A ScriptEngine created by the factory located in the search. Returns null if no such factory was found. The ScriptEngineManager sets its own globalScope Bindings as the GLOBAL_SCOPE Bindings of the newly created ScriptEngine.

takeScript

public ScriptEntry takeScript(JsonValue script)
                       throws ScriptException

Description copied from interface: ScriptRegistry

Takes a ScriptEntry from this ScriptRegistry.

Specified by:

takeScript in interface ScriptRegistry

Parameters:

script - The identifier of the ScriptEntry.

Returns:

null if the registry does not have the script, else the ScriptEntry instance.

Throws:

ScriptException

takeScript

public ScriptEntry takeScript(ScriptName name)
                       throws ScriptException

Description copied from interface: ScriptRegistry

Takes a ScriptEntry from this ScriptRegistry.

Specified by:

takeScript in interface ScriptRegistry

Parameters:

name - The identifier of the ScriptEntry.

Returns:

null if the registry does not have the script, else the ScriptEntry instance.

Throws:

ScriptException

addScriptListener

public void addScriptListener(ScriptName name,
                              ScriptListener hook)

Specified by:

addScriptListener in interface ScriptRegistry

deleteScriptListener

public void deleteScriptListener(ScriptName name,
                                 ScriptListener hook)

Specified by:

deleteScriptListener in interface ScriptRegistry

addingEntries

public void addingEntries(ScriptEngineFactory factory)
                   throws ScriptException

Description copied from interface: ScriptEngineFactoryObserver

Called when a ScriptEngineFactory gets started.

Specified by:

addingEntries in interface ScriptEngineFactoryObserver

Parameters:

factory - started ScriptEngineFactory

Throws:

ScriptException

removingEntries

public void removingEntries(ScriptEngineFactory factory)
                     throws ScriptException

Description copied from interface: ScriptEngineFactoryObserver

Called when a ScriptEngineFactory gets stopped.

Specified by:

removingEntries in interface ScriptEngineFactoryObserver

Parameters:

factory - stopped ScriptEngineFactory

Throws:

ScriptException

addSourceUnit

public void addSourceUnit(SourceUnit unit)
                   throws ScriptException

Description copied from interface: SourceUnitObserver

Called when a SourceUnit gets started.

Specified by:

addSourceUnit in interface SourceUnitObserver

Parameters:

unit - started ScriptEngineFactory

Throws:

ScriptException

removeSourceUnit

public void removeSourceUnit(SourceUnit unit)
                      throws ScriptException

Description copied from interface: SourceUnitObserver

Called when a SourceUnit gets stopped.

Specified by:

removeSourceUnit in interface SourceUnitObserver

Parameters:

unit - stopped ScriptEngineFactory

Throws:

ScriptException