com.sun.jndi.ldap
Class PersistentSearchControl

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

All Implemented Interfaces:

Serializable, Control

public final class PersistentSearchControl
extends BasicControl

This class implements the LDAPv3 Request Control for the persistent search mechanism as defined in draft-ietf-ldapext-psearch-02.txt. The control's value has the following ASN.1 definition:

     PersistentSearch ::= SEQUENCE {
         changeTypes INTEGER,
         changesOnly BOOLEAN,
         returnECs BOOLEAN
     }

 

See Also:

EntryChangeResponseControl, Serialized Form

Field Summary

static int	ADD Indicates interest in entries which have been added.
static int	ANY Indicates interest in entries which have been added, deleted, modified or renamed.
static int	DELETE Indicates interest in entries which have been deleted.
static int	MODIFY Indicates interest in entries which have been modified.
static String	OID The persistent search control's assigned object identifier is 2.16.840.1.113730.3.4.3.
static int	RENAME Indicates interest in entries which have 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

PersistentSearchControl()
Constructs a persistent search non-critical control.

PersistentSearchControl(int changeTypes, boolean changesOnly, boolean returnControls, boolean criticality)
Constructs a persistent search control.

Method Summary

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 persistent search control's assigned object identifier is 2.16.840.1.113730.3.4.3.

See Also:

Constant Field Values

ADD

public static final int ADD

Indicates interest in entries which have been added.

See Also:

Constant Field Values

DELETE

public static final int DELETE

Indicates interest in entries which have been deleted.

See Also:

Constant Field Values

MODIFY

public static final int MODIFY

Indicates interest in entries which have been modified.

See Also:

Constant Field Values

RENAME

public static final int RENAME

Indicates interest in entries which have been renamed.

See Also:

Constant Field Values

ANY

public static final int ANY

Indicates interest in entries which have been added, deleted, modified or renamed.

See Also:

Constant Field Values

Constructor Detail

PersistentSearchControl

public PersistentSearchControl()
                        throws IOException

Constructs a persistent search non-critical control. The original entries, any changed entries (additions, deletions, modifications or renames) and entry change controls are requested.

Throws:

IOException - If a BER encoding error occurs.

PersistentSearchControl

public PersistentSearchControl(int changeTypes,
                               boolean changesOnly,
                               boolean returnControls,
                               boolean criticality)
                        throws IOException

Constructs a persistent search control.

Parameters:

changeTypes - The change types of interest.

changesOnly - Return original entries and changed entries or only the changed entries.

returnControls - Return entry change controls.

criticality - The control's criticality.

Throws:

IOException - If a BER encoding error occurs.