com.netscape.jndi.ldap.controls

Class LdapEntryChangeControl

Implemented Interfaces:
Control

public class LdapEntryChangeControl
extends LDAPEntryChangeControl
implements Control

Represents an LDAP v3 server control that specifies information about a change to an entry in the directory. (The OID for this control is 2.16.840.1.113730.3.4.7.) You need to use this control in conjunction with a "persistent search" control (represented by LdapPersistentSearchControl object.

To use persistent searching for change notification, you create a "persistent search" control that specifies the types of changes that you want to track. When an entry is changed, the server sends that entry back to your client and may include an "entry change notification" control that specifies additional information about the change.

Once you retrieve an LdapEntryChangeControl object from the server, you can get the following additional information about the change made to the entry:

See Also:
LdapPersistSearchControl

Method Summary

int
getChangeNumber()
Gets the change number, which identifies the record of the change in the server's change log.
int
getChangeType()
Gets the change type, which identifies the type of change that occurred.
byte[]
getEncodedValue()
Retrieves the ASN.1 BER encoded value of the LDAP control.
String
getPreviousDN()
Gets the previous DN of the entry (if the entry was renamed).

Method Details

getChangeNumber

public int getChangeNumber()
Gets the change number, which identifies the record of the change in the server's change log.
Returns:
Change number identifying the change made.

getChangeType

public int getChangeType()
Gets the change type, which identifies the type of change that occurred.
Returns:
Change type identifying the type of change that occurred. This can be one of the following values:

  • LdapPersistSearchControl.ADD (a new entry was added to the directory)
  • LdapPersistSearchControl.DELETE (an entry was removed from the directory)
  • LdapPersistSearchControl.MODIFY (an entry was modified)
  • LdapPersistSearchControl.MODDN (an entry was renamed)


getEncodedValue

public byte[] getEncodedValue()
Retrieves the ASN.1 BER encoded value of the LDAP control. Null is returned if the value is absent.
Returns:
A possibly null byte array representing the ASN.1 BER encoded value of the LDAP control.

getPreviousDN

public String getPreviousDN()
Gets the previous DN of the entry (if the entry was renamed).
Returns:
The previous distinguished name of the entry.