Novell Doc: NDK: LDAP Classes for Java

4.3.1 Entry Events

This section explains the entry events.

EntryEventData Class

The response data for entry events is returned as an EntryEventData class. This class consists of the read-only properties as explained in the table below.

Table 4-13 EntryEventData Class

Property	Type	Description
perpetratorDN	LDAPDN	Specifies the DN of the entry that caused the event.
entry	LDAPDN	Specifies the DN of the entry that was acted upon.
class	OCTET STRING	Specifies the class OID of the object that was acted upon.
creationTime	DSETimestamp	Specifies the Time of Creation of this entry.
verb	INTEGER	Specifies the action that caused the event to occur.
flags	INTEGER
newDN	OCTET STRING	Specifies the new DN of the entry that was acted upon.

DSETimestamp Class

The class represents the time stamp data structure for eDirectory Events Notification. It contains the time (in seconds), replica number and event type.

Table 4-14 DSETimestamp Class

Property	Type	Description
seconds	INTEGER	Specifies in seconds when the event occurred. Zero equals 12:00 midnight, January 1, 1970,
replicaNumber	INTEGER	Specifies the number of the replica on which the change or event occurred.
event	INTEGER	Specifies an integer that further orders events occurring within the same whole-second interval.

Remarks

Two time stamp values are compared by comparing the seconds fields first and the event fields second. If the seconds fields are unequal, order is determined by the seconds field alone. If the seconds fields are equal, and the event fields are unequal, order is determined by the event fields. If the seconds and the event fields are equal, the time stamps are equal.

4.3.2 Value Events

This section details the value events.

ValueEventData Class

The response data for value events is returned as an ValueEventData class. This class consists of the read-only properties as explained in the table below.

Table 4-15 ValueEventData Class

Property	Type	Description
perpetratorDN	LDAPDN	Specifies the DN of the entry that caused the event.
entry	LDAPDN	Specifies the DN of the entry that was acted upon.
attribute	OCTET STRING	Specifies the attribute OID of the attribute that was acted upon.
syntax	OCTET STRING	Specifies the Syntax OID of the entry that was acted upon.
class	OCTET STRING	Specifies the class OID of the object that was acted upon.
timeStamp	DSETimestamp	Specifies a TimeStamp.
data	OCTET STRING	Specifies the information that further identifies the changes that were made.
verb	INTEGER	Specifies the action that caused the event to occur.

4.3.3 Debug Events

This section details about the debug events.

DebugEventData Class

The response data for debug event is returned as a DebugEventData class. This class consists of the read-only properties as explained in the table below.

Table 4-16 DebugEventData Class

Property	Type	Description
dsTime	INTEGER	Specifies the time the event occurred as the number of seconds elapsed since midnight (00:00:00), January 1, 1970, coordinated universal time, according to the system clock.
milliseconds	INTEGER	The millisecond portion of the time the event occurred.
perpetratorDN	LDAPDN	The DN of the object that caused this event.
formatString	String	The format string used to create the string printed in the DS Trace utility. The format string describes the string that is displayed by the DS Trace utility. It contains literal characters as well as format characters that serve as place holder for parameter values. See the remarks for a list of valid format characters.
verb	INTEGER	The ID of the ds verb that was executing when the event occurred.
Parametercount	INTEGER	Number of elements in the parameters array.
Parameters	Array of DebugParameter	A list of DebugParameter class. The parameters are in the same order as the parameter characters in the format string.

DebugParameter Class

This class contains the debug parameters associated with debug events.

Table 4-17 DebugParameter Class

Property	Type	Design
Type	INTEGER	An integer that indicates the type of the parameter. See the Table Below.
Data	Object	Specifies different type of Object depending on Type.

Table 4-18 Value of Type

Value of Type	Data Class contained as Data property	Description
DB_PARAM_TYPE_ENTRYID	INTEGER	Contains an Integer Object.
DB_PARAM_TYPE_STRING	String	Contains an UTF-8 encoded string value of the parameter
DB_PARAM_TYPE_BINARY	byte[]	Contains a byte array as data.
DB_PARAM_TYPE_INTEGER	INTEGER	Contains an Integer Object.
DB_PARAM_TYPE_ADDRESS	ReferralAddress	Contains the Network Address contained in a ReferralAddress class.
DB_PARAM_TYPE_TIMESTAMP	DSETimeStamp	Specifies a TimeStamp as a DSETimeStamp class.
DB_PARAM_TYPE_TIMEVECTOR	List of DSETimeStamp	Specifies a list of DSETimeStamps.

Remarks

The formatString parameter is formatted according to the following:

 %[flags][width][.precision][L,l,h,!]type

Table 4-19 Details of the formatString Parameter

Element	Description
flags	-, +, #, 0
width	An optional integer indicating the width of the displayed value
precision	An optional integer indicating the precision of the displayed value
L, l, h, !	A character indication the size of the parameter, one of the following values: L: DOUBLE_FLAG l: LONG_FLAG h: SHORT_FLAG !: I64_FLAG
type	A character indicating the data type of the parameter, one of the following values: C: color (no associated parameter) t: current time (no associated parameter) s: string, EVT_TAG_DB_STRING a: network address U: string, EVT_TAG_DB_STRING T: time stamp V: time stamp vector S: string, EVT_TAG_DB_STRING D: binary data x: hex integer, EVT_TAG_DB_INTEGER v: verb number, EVT_TAG_DB_INTEGER o: octal integer, EVT_TAG_DB_INTEGER e: error code value, EVT_TAG_DB_INTEGER d: normal decimal integer, EVT_TAG_DB_INTEGER c: single character, EVT_TAG_DB_INTEGER p: raw memory pointer, EVT_TAG_DB_INTEGER X: HEX integer, EVT_TAG_DB_INTEGER E: error code value, EVT_TAG_DB_INTEGER

ReferralAddress Class

This class is used to store the network address.

Table 4-20 ReferralAddress Class

Property	Type	Description
Type	INTEGER	An integer value indicating the address type.
Address	String	The actual address value.

4.3.4 General DS Events

This section details the general DS events.

GeneralDSEventData Class

The response data for general DS events is returned as a GeneralDSEventData class. This class consists of the read-only properties as explained in the table below.

Table 4-21 GeneralDSEventData Class

Property	Type	Description
dsTime	INTEGER	Specifies the time in milliseconds when the event occurred.
milliseconds	INTEGER
verb	INTEGER	Specifies the action that caused the event to occur.
currentProcess	INTEGER	Specifies the process that was running when the event occurred.
perpetratorDN	LDAPDN	Specifies the DN of the entry that caused the event.
integerValues	Array of integer	Contains event data determined by the event type
Stringvalues	Array of string	Contains event data determined by the event type.

Events Without Data

In the case of events without data, the response data is returned as a null object.

4.3.5 Bindery Events

This section details the bindery events.

BinderyObjectEventData Class

The response data for bindery events is returned as a BinderyObjectEventData class. This class consists of the read-only properties as explained in the table below.

Table 4-22 Details of the BinderyObjectEventData Class

Property	Type	Description
entry	LDAPDN	Specifies the DN of the Directory entry that is being created to represent the bindery object.
type	INTEGER	Specifies the bindery object type.
emuObjFlags	INTEGER	Specifies the bindery object flags.
security	INTEGER	Specifies the bindery object security.
name	LDAPString	Specifies the name of the bindery object.

4.3.6 SecurityEquivalence Event

This section details the SecurityEquivalence event.

SecurityEquivalenceEventData Class

The response data for SecurityEquivalence events is returned as a SecurityEquivalenceEventData class. This class consists of the read-only properties as explained in the table below.

Table 4-23 Details of the SecurityEquivalenceEventData Class

Property	Type	Description
entry	LDAPDN	Specifies the DN of the Directory object whose Security Equivalence Vector (SEV) is being checked.
retryCount	INTEGER	Specifies the number of retries.
valueDN	LDAPDN	Specifies the DN of an object or group being checked.
referral	List of ReferralAddress	Specifies the List of referrals.
referralCount	INTEGER	Specifies the number of referrals in the referrals parameter.

4.3.7 Module State Events

This section details the module state events.

ModuleStateEventData Class

The response data for module state events is returned as a ModuleStateEventData class. This class consists of the read-only properties explained in the table below.

Table 4-24 Details of the Read-only Properties

Property	Type	Design
ConnectionDN	LDAPDN	Specifies the DN of the entry associated with the connection.
Flags	INTEGER	The least significant byte of the flags field contains module attribute flags. The next byte contains event subtype flags. They indicate the type of module event in progress. See the Table below for details.
Name	LDAPSTRING	Specifies the affected module name.
Description	LDAPSTRING	Specifies the name and description of the target module.
Source	LDAPSTRING	Specifies the affecting module.

The values for flags field are contained in the following table:

Table 4-25 Values for Flags Field

0x0001	DSE_MOD_HIDDEN
0x0002	DSE_MOD_SYSTEM
0x0004	DSE_MOD_ENGINE
0x0008	DSE_MOD_AUTOMATIC
0x00FF	DSE_MOD_FILE_MASK
0x0100	DSE_MOD_POSTEVENT
0x0200	DSE_MOD_AVAILABLE
0x0400	DSE_MOD_LOADING
0x0800	DSE_MOD_MODIFY
0x8000	DSE_MOD_NEGATE_BIT
0xFF00	DSE_MOD_EVENT_MASK

4.3.8 Network Address Event

This section details the network address event.

NetworkAddressEventData Class

The response data for network address events is returned as a NetworkAddressEventData class. This class consists of the read-only properties as explained in the table below.

Table 4-26 Details of the NetworkAddressEventData Class

Property	Type	Description
type	INTEGER	Specifies the type of the address. Can be one of the following values: NT_IPX NT_IP NT_SDLC NT_TOKENRING_ETHERNET NT_OSI NT_APPLETALK NT_COUNT
data	OCTET STRING	A character array containing address.

Remarks

The address is stored as a binary string. This string is the literal value of the address. To display as a hexadecimal value, you must convert each 4-bit nibble to the correct character (0,1,2,3,...) For two net addresses to match, the type, length, and value of the addresses must match.

4.3.9 Connection Change Event

This section explains the properties of the ConnectionStateEventData class and flags.

ConnectionStateEventData Class

The response data for connection change events is returned as a ConnectionStateEventData class. This class consists of the read-only properties as explained in the table below.

Table 4-27 Read-Only Properties

Property	Type	Design
ConnectionDN	LDAPDN	Specifies the DN of the entry associated with the connection.
OldFlags	INTEGER	Specifies the flag associated with the previous connection state, and is one of the flag Specified in Table below.
NewFlags	INTEGER	Specifies the flag that indicates the new connection state. Uses the same flags as oldFlags.
SourceModule	LDAPSTRING	Specifies the module that caused the connection state to change.

Flags

Table 4-28 Values for Flag Field

0x00000001	DSE_CONN_VALID
0x00000002	DSE_CONN_AUTHENTIC
0x00000004	DSE_CONN_SUPERVISOR
0x00000008	DSE_CONN_OPERATOR
0x00000010	DSE_CONN_LICENSED
0x00000020	DSE_CONN_SEV_IS_STALE
0x000000FF	DSE_CONN_OPERATIONAL_FLAGS
0x00010000	DSE_CONN_CLEAR_ON_UNLOCK
0x00020000	DSE_CONN_LOCKED
0x00040000	DSE_CONN_CLEAR_ON_EVENT
0x000F0000	DSE_CONN_SECURITY_FLAGS

4.3 Classes

4.3.1 Entry Events

EntryEventData Class

DSETimestamp Class

Remarks

4.3.2 Value Events

ValueEventData Class

4.3.3 Debug Events

DebugEventData Class

DebugParameter Class

Remarks

ReferralAddress Class

4.3.4 General DS Events

GeneralDSEventData Class

Events Without Data

4.3.5 Bindery Events

BinderyObjectEventData Class

4.3.6 SecurityEquivalence Event

SecurityEquivalenceEventData Class

4.3.7 Module State Events

ModuleStateEventData Class

4.3.8 Network Address Event

NetworkAddressEventData Class

Remarks

4.3.9 Connection Change Event

ConnectionStateEventData Class

Flags