public final class

EntryChangeResponseControl

extends BasicControl
java.lang.Object
   ↳ com.sun.jndi.ldap.BasicControl
     ↳ com.sun.jndi.ldap.EntryChangeResponseControl

Class Overview

This class implements the LDAPv3 Response Control for entry-change notification as defined in draft-ietf-ldapext-psearch-02.txt. The control's value has the following ASN.1 definition: 


     EntryChangeNotification ::= SEQUENCE {
         changeType ENUMERATED {
             add              (1),
             delete           (2),
             modify           (4),
             modDN            (8)
         },
         previousDN   LDAPDN OPTIONAL,        -- modifyDN ops. only
         changeNumber INTEGER OPTIONAL,       -- if supported
    }

See Also

Summary

Constants
int ADD Indicates an entry which has been added.
int DELETE Indicates an entry which has been deleted.
int MODIFY Indicates an entry which has been modified.
String OID The entry-change response control's assigned object identifier is 2.16.840.1.113730.3.4.7.
int RENAME Indicates an entry which has been renamed.
[Expand]
Inherited Constants
From interface javax.naming.ldap.Control
[Expand]
Inherited Fields
From class com.sun.jndi.ldap.BasicControl
Public Constructors
EntryChangeResponseControl(String id, boolean criticality, byte[] value)
Constructs a new instance of EntryChangeResponseControl.
Public Methods
long getChangeNumber()
Retrieves the change number assigned by the server for this change.
int getChangeType()
Retrieves the type of change that occurred.
String getPreviousDN()
Retrieves the previous distinguished name of the entry before it was renamed and/or moved.
[Expand]
Inherited Methods
From class com.sun.jndi.ldap.BasicControl
From class java.lang.Object
From interface javax.naming.ldap.Control

Constants

public static final int ADD

Indicates an entry which has been added.

Constant Value: 1 (0x00000001)

public static final int DELETE

Indicates an entry which has been deleted.

Constant Value: 2 (0x00000002)

public static final int MODIFY

Indicates an entry which has been modified.

Constant Value: 4 (0x00000004)

public static final String OID

The entry-change response control's assigned object identifier is 2.16.840.1.113730.3.4.7.

Constant Value: "2.16.840.1.113730.3.4.7"

public static final int RENAME

Indicates an entry which has been renamed.

Constant Value: 8 (0x00000008)

Public Constructors

public EntryChangeResponseControl (String id, boolean criticality, byte[] value)

Constructs a new instance of EntryChangeResponseControl.

Parameters
id The control's object identifier string.
criticality The control's criticality.
value The control's ASN.1 BER encoded value. May be null.
Throws
IOException if an error is encountered while decoding the control's value.

Public Methods

public long getChangeNumber ()

Retrieves the change number assigned by the server for this change. Returns -1 if this feature is not supported by the server.

Returns
  • The change number or -1 if unsupported.

public int getChangeType ()

Retrieves the type of change that occurred.

Returns
  • The type of change.

public String getPreviousDN ()

Retrieves the previous distinguished name of the entry before it was renamed and/or moved. This method applies only to RENAME changes.

Returns
  • The previous distinguished name or null if not applicable.