org.forgerock.script.engine

Interface CompilationHandler

public interface CompilationHandler

A NAME does ...

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTIVE The script is now running.
static int	INSTALLED The script is installed but not yet resolved.
static int	RESOLVED The script is resolved and is able to be started.
static int	STARTING The script is in the process of starting.
static int	STOPPING The script is in the process of stopping.
static int	UNINSTALLED The script is uninstalled and may not be used.

Method Summary

Modifier and Type	Method and Description
ClassLoader	getParentClassLoader()
ScriptSource	getScriptSource()
void	handleException(Exception exception)
void	setClassLoader(ClassLoader classLoader)
void	setCompiledScript(CompiledScript script)

Field Detail

UNINSTALLED

static final int UNINSTALLED

The script is uninstalled and may not be used.

The UNINSTALLED state is only visible after a script is uninstalled; the script is in an unusable state but references to the script object may still be available and used for introspection.

The value of UNINSTALLED is 0x00000001.

See Also:

Constant Field Values

INSTALLED

static final int INSTALLED

The script is installed but not yet resolved.

A script is in the INSTALLED state when it has been installed in the ScriptRegistry but is not or cannot be resolved.

This state is visible if the script's code dependencies are not resolved. The ScriptRegistry may attempt to resolve an INSTALLED script's code dependencies and move the script to the RESOLVED state.

The value of INSTALLED is 0x00000002.

See Also:

Constant Field Values

RESOLVED

static final int RESOLVED

The script is resolved and is able to be started.

A script is in the RESOLVED state when the Framework has successfully resolved the script's code dependencies. Note that the script is not active yet. A script must be put in the RESOLVED state before it can be started. The ScriptRegistry may attempt to resolve a script at any time.

The value of RESOLVED is 0x00000004.

See Also:

Constant Field Values

STARTING

static final int STARTING

The script is in the process of starting.

A script is in the STARTING state when its ScriptEngine.compileScript(CompilationHandler) method is active. A script must be in this state when the script's ScriptEngine.compileScript(CompilationHandler) is called. If the ScriptEngine.compileScript method completes without exception, then the script has successfully started and must move to the ACTIVE state.

The value of STARTING is 0x00000008.

See Also:

Constant Field Values

STOPPING

static final int STOPPING

The script is in the process of stopping.

A script is in the STOPPING state when its ACTIVE state is active. A script must be in this state when the script's ScriptEngine#compileScript(CompilationHandler) method is called.

When the ScriptEngine.compileScript method completes the script is stopped and must move to the RESOLVED state.

The value of STOPPING is 0x00000010.

See Also:

Constant Field Values

ACTIVE

static final int ACTIVE

The script is now running.

A script is in the ACTIVE state when it has been successfully started and activated.

The value of ACTIVE is 0x00000020.

See Also:

Constant Field Values

Method Detail

getScriptSource

ScriptSource getScriptSource()

getParentClassLoader

ClassLoader getParentClassLoader()

setClassLoader

void setClassLoader(ClassLoader classLoader)

setCompiledScript

void setCompiledScript(CompiledScript script)

handleException

void handleException(Exception exception)