org.forgerock.script

Class ScriptEvent

java.lang.Object

java.util.EventObject

org.forgerock.script.ScriptEvent

All Implemented Interfaces:

Serializable

public class ScriptEvent
extends EventObject

A ScriptEvent does ...

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODIFIED The properties of a registered script have been modified.
static int	REGISTERED This script has been registered.
static int	UNREGISTERING This script is in the process of being unregistered.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ScriptEvent(int type, ScriptRegistry reference, ScriptName name) Creates a new script event object.

Method Summary

Modifier and Type	Method and Description
ScriptEntry	getScriptLibraryEntry() Returns a reference to the script that had a change occur in its lifecycle.
int	getType() Returns the type of event.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

REGISTERED

public static final int REGISTERED

This script has been registered.

This event is synchronously delivered after the script has been registered with the Library.

See Also:

Constant Field Values

MODIFIED

public static final int MODIFIED

The properties of a registered script have been modified.

This event is synchronously delivered after the script properties have been modified.

See Also:

Constant Field Values

UNREGISTERING

public static final int UNREGISTERING

This script is in the process of being unregistered.

This event is synchronously delivered before the script has completed unregistering.

If a bundle is using a script that is UNREGISTERING, the bundle should release its use of the script when it receives this event. If the bundle does not release its use of the script when it receives this event, the Library will automatically release the bundle's use of the script while completing the script unregistration operation.

See Also:

Constant Field Values

Constructor Detail

ScriptEvent

public ScriptEvent(int type,
                   ScriptRegistry reference,
                   ScriptName name)

Creates a new script event object.

Parameters:

type - The event type.

reference - A ScriptLibraryEntry object to the script that had a lifecycle change.

name - The name of the script

Method Detail

getScriptLibraryEntry

public ScriptEntry getScriptLibraryEntry()
                                  throws ScriptException

Returns a reference to the script that had a change occur in its lifecycle.

This reference is the source of the event.

Returns:

Reference to the script that had a lifecycle change.

Throws:

ScriptException

getType

public int getType()

Returns the type of event. The event type values are:

• REGISTERED
• MODIFIED
• UNREGISTERING

Returns:

Type of script lifecycle change.