org.apache.jackrabbit.api.jsr283.observation
Interface Event

All Superinterfaces:

Event

public interface Event
extends Event

Event is a preliminary interface that contains the new methods introduce in JSR 283.

This interface will be removed once JSR 283 is final.

Field Summary

static int	NODE_MOVED Generated on persist when a node is moved.
static int	PERSIST If event bundling is supported, this event is used to indicate a bundle boundary within the event journal.

Fields inherited from interface javax.jcr.observation.Event

NODE_ADDED, NODE_REMOVED, PROPERTY_ADDED, PROPERTY_CHANGED, PROPERTY_REMOVED

Method Summary

long	getDate() Returns the date when the change was persisted that caused this event.
String	getIdentifier() Returns the identifier associated with this event or null if this event has no associated identifier.
Map	getInfo() Returns the information map associated with this event.
String	getUserData() Returns the user data set through ObservationManager.setUserData() on the ObservationManager bound to the Session that caused the event.

Methods inherited from interface javax.jcr.observation.Event

getPath, getType, getUserID

Field Detail

NODE_MOVED

static final int NODE_MOVED

Generated on persist when a node is moved.

• Event.getPath() returns the absolute path of the destination of the move.
• getIdentifier() returns the identifier of the moved node.
• getInfo() If the method that caused this event was a Session.move or Workspace.move then the returned Map has keys srcAbsPath and destAbsPath with values corresponding to the parameters passed to the move method.

  If the method that caused this event was a Node.orderBefore then the returned Map has keys srcChildRelPath and destChildRelPath with values corresponding to the parameters passed to the orderBefore method.

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.

• Event.getPath() returns null.
• getIdentifier() returns null.
• getInfo() returns an empty Map object.

Since:

JCR 2.0

See Also:

Constant Field Values

Method Detail

getIdentifier

String getIdentifier()
                     throws RepositoryException

Returns the identifier associated with this event or null if this event has no associated identifier. The meaning of the associated identifier depends upon the type of the event. See event type constants above.

Returns:

the identifier associated with this event or null.

Throws:

RepositoryException - if an error occurs.

Since:

JCR 2.0

getInfo

Map getInfo()
            throws RepositoryException

Returns the information map associated with this event. The meaning of the map depends upon the type of the event. See event type constants above.

Returns:

A Map containing parameter information for instances of a NODE_MOVED event.

Throws:

RepositoryException - if an error occurs.

Since:

JCR 2.0

getUserData

String getUserData()
                   throws RepositoryException

Returns the user data set through ObservationManager.setUserData() on the ObservationManager bound to the Session that caused the event.

Returns:

String

Throws:

RepositoryException - if an error occurs.

Since:

JCR 2.0

getDate

long getDate()
             throws RepositoryException

Returns the date when the change was persisted that caused this event. The date is represented as a millisecond value that is an offset from the Epoch, January 1, 1970 00:00:00.000 GMT (Gregorian). The granularity of the returned value is implementation dependent.

Returns:

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

Throws:

RepositoryException - if an error occurs.

Since:

JCR 2.0