javax.jcr.observation
Interface Event

All Known Implementing Classes:

SessionEvent

public interface Event

An event fired by the observation mechanism. Also includes constants representing the event types defined by the JCR standard. Each constant is a power of 2 so that sets of event types can be encoded as a bitmask in a int value.

Author:

Tim Anderson, Peeter Piegaze

Field Summary

static int	NODE_ADDED An event of this type is generated when a node is added.
static int	NODE_REMOVED An event of this type is generated when a node is removed.
static int	PROPERTY_ADDED An event of this type is generated when a property is added.
static int	PROPERTY_CHANGED An event of this type is generated when a property is changed.
static int	PROPERTY_REMOVED An event of this type is generated when a property is removed.

Method Summary

java.lang.String	getPath() Returns the absolute path of the parent node connected with this event.
int	getType() Returns the type of this event: a constant defined by this interface.
java.lang.String	getUserID() Returns the user ID connected with this event.

Field Detail

NODE_ADDED

public static final int NODE_ADDED

An event of this type is generated when a node is added.

See Also:

Constant Field Values

NODE_REMOVED

public static final int NODE_REMOVED

An event of this type is generated when a node is removed.

See Also:

Constant Field Values

PROPERTY_ADDED

public static final int PROPERTY_ADDED

An event of this type is generated when a property is added.

See Also:

Constant Field Values

PROPERTY_REMOVED

public static final int PROPERTY_REMOVED

An event of this type is generated when a property is removed.

See Also:

Constant Field Values

PROPERTY_CHANGED

public static final int PROPERTY_CHANGED

An event of this type is generated when a property is changed.

See Also:

Constant Field Values

Method Detail

getType

public int getType()

Returns the type of this event: a constant defined by this interface. One of:

• NODE_ADDED
• NODE_REMOVED
• PROPERTY_ADDED
• PROPERTY_REMOVED
• PROPERTY_CHANGED

Returns:

the type of this event.

getPath

public java.lang.String getPath()
                         throws RepositoryException

Returns the absolute path of the parent node connected with this event. The interpretation given to the returned path depends upon the type of the event:

• If the event type is NODE_ADDED then this method returns the absolute path of the node that was added.
• If the event type is NODE_REMOVED then this method returns the absolute path of the node that was removed.
• If the event type is PROPERTY_ADDED then this method returns the absolute path of the property that was added.
• If the event type is PROPERTY_REMOVED then this method returns the absolute path of the property that was removed.
• If the event type is PROPERTY_CHANGED then this method returns the absolute path of of the changed property.

Returns:

the absolute path of the parent node connected with this event.

Throws:

RepositoryException - if an error occurs.

getUserID

public java.lang.String getUserID()

Returns the user ID connected with this event. This is the string returned by getUserID of the session that caused the event.

Returns:

a String.