org.forgerock.script

Interface ScriptRegistry

All Superinterfaces:

SourceUnitObserver

All Known Implementing Classes:

ScriptRegistryImpl

public interface ScriptRegistry
extends SourceUnitObserver

A NAME does ...

Method Summary

Modifier and Type	Method and Description
void	addScriptListener(ScriptName name, ScriptListener hook)
void	deleteScriptListener(ScriptName name, ScriptListener hook)
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	setRegistryLevelScriptClassLoader(ClassLoader registryLevelScriptClassLoader)
ScriptEntry	takeScript(JsonValue script) Takes a ScriptEntry from this ScriptRegistry.
ScriptEntry	takeScript(ScriptName name) Takes a ScriptEntry from this ScriptRegistry.

Methods inherited from interface org.forgerock.script.source.SourceUnitObserver

addSourceUnit, removeSourceUnit

Method Detail

getEngineByName

ScriptEngine getEngineByName(String shortName)

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.

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.

Throws:

NullPointerException - if shortName is null.

listScripts

Set<ScriptName> listScripts()

Lists all ScriptNames available in the registry.

Returns:

the list of registered

takeScript

ScriptEntry takeScript(JsonValue script)
                throws ScriptException

Takes a ScriptEntry from this ScriptRegistry.

Parameters:

script - The identifier of the ScriptEntry.

Returns:

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

Throws:

NullPointerException - if script is null.

JsonValueException

IllegalArgumentException

ScriptException

takeScript

ScriptEntry takeScript(ScriptName name)
                throws ScriptException

Takes a ScriptEntry from this ScriptRegistry.

Parameters:

name - The identifier of the ScriptEntry.

Returns:

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

Throws:

NullPointerException - if script is null.

ScriptException

addScriptListener

void addScriptListener(ScriptName name,
                       ScriptListener hook)

deleteScriptListener

void deleteScriptListener(ScriptName name,
                          ScriptListener hook)

getRegistryLevelScriptClassLoader

ClassLoader getRegistryLevelScriptClassLoader()

setRegistryLevelScriptClassLoader

void setRegistryLevelScriptClassLoader(ClassLoader registryLevelScriptClassLoader)