org.apache.jackrabbit.spi.commons

Class EventImpl

java.lang.Object

org.apache.jackrabbit.spi.commons.EventImpl

All Implemented Interfaces:

Serializable, Event

Direct Known Subclasses:

EventImpl

public class EventImpl
extends Object
implements Event, Serializable

EventImpl implements a serializable SPI Event.

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.jackrabbit.spi.Event

ALL_TYPES, NODE_ADDED, NODE_MOVED, NODE_REMOVED, PERSIST, PROPERTY_ADDED, PROPERTY_CHANGED, PROPERTY_REMOVED

Constructor Summary

Constructors

Constructor and Description
EventImpl(int type, Path path, ItemId itemId, NodeId parentId, Name primaryNodeTypeName, Name[] mixinTypeNames, String userId) Deprecated.
EventImpl(int type, Path path, ItemId itemId, NodeId parentId, Name primaryNodeTypeName, Name[] mixinTypeNames, String userId, String userData, long timestamp, Map<Name,QValue> info) Creates a new serializable event.

Method Summary

Methods

Modifier and Type	Method and Description
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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EventImpl

public EventImpl(int type,
         Path path,
         ItemId itemId,
         NodeId parentId,
         Name primaryNodeTypeName,
         Name[] mixinTypeNames,
         String userId)

Deprecated.

Creates a new serializable event.

EventImpl

public EventImpl(int type,
         Path path,
         ItemId itemId,
         NodeId parentId,
         Name primaryNodeTypeName,
         Name[] mixinTypeNames,
         String userId,
         String userData,
         long timestamp,
         Map<Name,QValue> info)

Creates a new serializable event.

Method Detail

getType

public int getType()

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

• Event.NODE_ADDED
• Event.NODE_REMOVED
• Event.PROPERTY_ADDED
• Event.PROPERTY_REMOVED
• Event.PROPERTY_CHANGED
• Event.NODE_MOVED
• Event.PERSIST

Specified by:

getType in interface Event

Returns:

the type of this event.

getPath

public Path getPath()

Specified by:

getPath in interface Event

Returns:

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

getItemId

public ItemId getItemId()

Specified by:

getItemId in interface Event

Returns:

the id of the affected item.

getParentId

public NodeId getParentId()

Specified by:

getParentId in interface Event

Returns:

the id of the parent node of the affected item.

getPrimaryNodeTypeName

public Name getPrimaryNodeTypeName()

Specified by:

getPrimaryNodeTypeName in interface Event

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

public Name[] getMixinTypeNames()

Specified by:

getMixinTypeNames in interface Event

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

public String getUserID()

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

Specified by:

getUserID in interface Event

Returns:

a String.

getInfo

public Map<Name,QValue> getInfo()
                         throws javax.jcr.RepositoryException

Returns the information map associated with this event.

Specified by:

getInfo in interface Event

Returns:

A Map containing parameter information.

Throws:

javax.jcr.RepositoryException - if an error occurs.

See Also:

Event.getInfo()

getUserData

public String getUserData()

Returns the user data.

Specified by:

getUserData in interface Event

Returns:

the user data

See Also:

Event.getUserData()

getDate

public long getDate()
             throws javax.jcr.RepositoryException

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

Specified by:

getDate in interface Event

Returns:

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

Throws:

javax.jcr.RepositoryException - if an error occurs.

See Also:

Event.getDate()

toString

public String toString()

Overrides:

toString in class Object