Package org.apache.jackrabbit.spi
Interface Event
- All Known Implementing Classes:
EventImpl
public interface Event
Event
is similar to the regular JCR Event and adds additional
information about the affected item.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Constant for observation listener interested in all types of events.static final int
An event of this type is generated when a node is added.static final int
An event of this type is generated when a node is moved.static final int
An event of this type is generated when a node is removed.static final int
If event bundling is supported, this event is used to indicate a bundle boundary within the event journal.static final int
An event of this type is generated when a property is added.static final int
An event of this type is generated when a property is changed.static final int
An event of this type is generated when a property is removed. -
Method Summary
Modifier and TypeMethodDescriptionlong
getDate()
Returns the date when the change was persisted that caused this event.getInfo()
Returns the information map associated with this event.Name[]
getPath()
int
getType()
Returns the type of this event: a constant defined by this interface.Returns the user data.Returns the user ID connected with this event.
-
Field Details
-
NODE_ADDED
static final int NODE_ADDEDAn event of this type is generated when a node is added.- See Also:
-
NODE_REMOVED
static final int NODE_REMOVEDAn event of this type is generated when a node is removed.- See Also:
-
PROPERTY_ADDED
static final int PROPERTY_ADDEDAn event of this type is generated when a property is added.- See Also:
-
PROPERTY_REMOVED
static final int PROPERTY_REMOVEDAn event of this type is generated when a property is removed.- See Also:
-
PROPERTY_CHANGED
static final int PROPERTY_CHANGEDAn event of this type is generated when a property is changed.- See Also:
-
NODE_MOVED
static final int NODE_MOVEDAn event of this type is generated when a node is moved.- Since:
- JCR 2.0
- See Also:
-
PERSIST
static final int PERSISTIf event bundling is supported, this event is used to indicate a bundle boundary within the event journal.- Since:
- JCR 2.0
- See Also:
-
ALL_TYPES
static final int ALL_TYPESConstant for observation listener interested in all types of events.- See Also:
-
-
Method Details
-
getType
int getType()Returns the type of this event: a constant defined by this interface. One of:- 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:
-
getMixinTypeNames
Name[] getMixinTypeNames()- Returns:
- the names of the mixin types of the 'associated' node of this event.
- See Also:
-
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
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:
-
getUserData
String getUserData()Returns the user data.- Returns:
- the user data
- Since:
- JCR 2.0
- See Also:
-
getDate
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:
-