org.apache.jackrabbit.spi
Interface Event

All Known Implementing Classes:

EventImpl, EventImpl

public interface Event

Event is similar to the regular JCR Event and adds additional information about the affected item.

Field Summary

static int	ALL_TYPES Constant for observation listener interested in all types of events.
static int	NODE_ADDED An event of this type is generated when a node is added.
static int	NODE_MOVED An event of this type is generated when a node is moved.
static int	NODE_REMOVED An event of this type is generated when a node is removed.
static int	PERSIST If event bundling is supported, this event is used to indicate a bundle boundary within the event journal.
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

long	getDate() Returns the date when the change was persisted that caused this event.
Map<Name,QValue>	getInfo() Returns the information map associated with this event.
ItemId	getItemId()
Name[]	getMixinTypeNames()
NodeId	getParentId()
Path	getPath()
Name	getPrimaryNodeTypeName()
int	getType() Returns the type of this event: a constant defined by this interface.
String	getUserData() Returns the user data.
String	getUserID() Returns the user ID connected with this event.

Field Detail

NODE_ADDED

static final int NODE_ADDED

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

See Also:

Constant Field Values

NODE_REMOVED

static final int NODE_REMOVED

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

See Also:

Constant Field Values

PROPERTY_ADDED

static final int PROPERTY_ADDED

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

See Also:

Constant Field Values

PROPERTY_REMOVED

static final int PROPERTY_REMOVED

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

See Also:

Constant Field Values

PROPERTY_CHANGED

static final int PROPERTY_CHANGED

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

See Also:

Constant Field Values

NODE_MOVED

static final int NODE_MOVED

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

Since:

JCR 2.0

See Also:

Constant Field Values

PERSIST

static final int PERSIST

If event bundling is supported, this event is used to indicate a bundle boundary within the event journal.

Since:

JCR 2.0

See Also:

Constant Field Values

ALL_TYPES

static final int ALL_TYPES

Constant for observation listener interested in all types of events.

See Also:

Constant Field Values

Method Detail

getType

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
• NODE_MOVED
• PERSIST

Returns:

the type of this event.

getPath

Path getPath()

Returns:

the path of the affected item. E.g. the added/removed node or the property that was added/removed/changed.

getItemId

ItemId getItemId()

Returns:

the id of the affected item.

getParentId

NodeId getParentId()

Returns:

the id of the parent node of the affected item.

getPrimaryNodeTypeName

Name getPrimaryNodeTypeName()

Returns:

the name of the primary node type of the 'associated' node of this event.

See Also:

ObservationManager.addEventListener(javax.jcr.observation.EventListener, int, java.lang.String, boolean, java.lang.String[], java.lang.String[], boolean)

getMixinTypeNames

Name[] getMixinTypeNames()

Returns:

the names of the mixin types of the 'associated' node of this event.

See Also:

ObservationManager.addEventListener(javax.jcr.observation.EventListener, int, java.lang.String, boolean, java.lang.String[], java.lang.String[], boolean)

getUserID

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.

getInfo

Map<Name,QValue> getInfo()
                         throws RepositoryException

Returns the information map associated with this event.

Returns:

A Map containing parameter information.

Throws:

RepositoryException - if an error occurs.

Since:

JCR 2.0

See Also:

Event.getInfo()

getUserData

String getUserData()

Returns the user data.

Returns:

the user data

Since:

JCR 2.0

See Also:

Event.getUserData()

getDate

long getDate()
             throws RepositoryException

Returns the date when the change was persisted that caused this event.

Returns:

the date when the change was persisted that caused this event.

Throws:

RepositoryException - if an error occurs.

Since:

JCR 2.0

See Also:

Event.getDate()