com.sun.jndi.ldap
Class EntryChangeResponseControl

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

All Implemented Interfaces:

Serializable, Control

public final class EntryChangeResponseControl
extends BasicControl

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:

PersistentSearchControl, ResponseControlFactory, Serialized Form

Field Summary

static int	ADD Indicates an entry which has been added.
static int	DELETE Indicates an entry which has been deleted.
static int	MODIFY Indicates an entry which has been modified.
static String	OID The entry-change response control's assigned object identifier is 2.16.840.1.113730.3.4.7.
static int	RENAME Indicates an entry which has been renamed.

Fields inherited from class com.sun.jndi.ldap.BasicControl

criticality, id, value

Fields inherited from interface javax.naming.ldap.Control

CRITICAL, NONCRITICAL

Constructor Summary

EntryChangeResponseControl(String id, boolean criticality, byte[] value)
Constructs a new instance of EntryChangeResponseControl.

Method Summary

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.

Methods inherited from class com.sun.jndi.ldap.BasicControl

getEncodedValue, getID, isCritical

Methods inherited from class java.lang.Object

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

Field Detail

OID

public static final String OID

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

See Also:

Constant Field Values

ADD

public static final int ADD

Indicates an entry which has been added.

See Also:

Constant Field Values

DELETE

public static final int DELETE

Indicates an entry which has been deleted.

See Also:

Constant Field Values

MODIFY

public static final int MODIFY

Indicates an entry which has been modified.

See Also:

Constant Field Values

RENAME

public static final int RENAME

Indicates an entry which has been renamed.

See Also:

Constant Field Values

Constructor Detail

EntryChangeResponseControl

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

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.

Method Detail

getChangeType

public int getChangeType()

Retrieves the type of change that occurred.

Returns:

The type of change.

getPreviousDN

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.

getChangeNumber

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.