com.novell.ldap.events
Class LDAPEvent

java.lang.Object
  java.util.EventObject
      com.novell.ldap.events.LDAPEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

SearchReferralEvent, SearchResultEvent

public class LDAPEvent

extends java.util.EventObject

This class represents an generic event fired in response to an notification (LDAPResponse) sent by the LDAP Server. The LDAPEvent contains the following value:

• The Event classification: Any event can be classified into a no of group defined in EventConstant Interface.Currently it defines Two classification.
  • CLASSIFICATION_LDAP_PSEARCH -The Standard Events System as defined by LDAP Persistence Search Draft.
  • CLASSIFICATION_EDIR_EVENT - The Novell Edirectory specific extensions for event monitoring.
• The Event Type: Apart from the classification grouping, each event is also has a Type associate with it.
• The LDAPResponse Object which triggered this event.

The LDAPEvent is created by LDAPEventSource whenever a new LDAPResponse is obtained. The Notification for this event can be received from LDAPEventListener and PSearchEventListener.

See Also:

LDAPEventSource, LDAPEventListener, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

LDAPEvent(LDAPEventSource eventsource, LDAPMessage sourcemessage, int aclassification, int atype)
The default constructor used to construct the LDAPEvent.

Method Summary

int	getClassification() Returns the Classification for this Event.
LDAPMessage	getContainedEventInformation() Returns the LDAPResponse which generated this event.
int	getType() Returns the Type for this Event.
void	setEventclassification(int i) Set the classification of this Event.
void	setEventtype(int i) Set the Type of this event.
java.lang.String	toString() Returns an String Representaion of SearchResultEvent.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPEvent

public LDAPEvent(LDAPEventSource eventsource,
                 LDAPMessage sourcemessage,
                 int aclassification,
                 int atype)

The default constructor used to construct the LDAPEvent.

Parameters:

eventsource - The Source Object which generated this event.

sourcemessage - The LDAPResponse which generates this event.

aclassification - The Event Classification for this Event.

atype - The Event Type for this Event.

Method Detail

getClassification

public final int getClassification()

Returns the Classification for this Event.

Returns:

The event classification of this Event.

getType

public final int getType()

Returns the Type for this Event.

Returns:

The event type of this Event.

getContainedEventInformation

public final LDAPMessage getContainedEventInformation()

Returns the LDAPResponse which generated this event.

Returns:

The LDAPResponse which generated this event.

toString

public java.lang.String toString()

Returns an String Representaion of SearchResultEvent.

Returns:

String Representation.

setEventclassification

public final void setEventclassification(int i)

Set the classification of this Event.

Parameters:

i - The classification value.

setEventtype

public final void setEventtype(int i)

Set the Type of this event.

Parameters:

i - The Type value.