public final class

PersistentSearchControl

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

Class Overview

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

Summary

Constants
int ADD Indicates interest in entries which have been added.
int ANY Indicates interest in entries which have been added, deleted, modified or renamed.
int DELETE Indicates interest in entries which have been deleted.
int MODIFY Indicates interest in entries which have been modified.
String OID The persistent search control's assigned object identifier is 2.16.840.1.113730.3.4.3.
int RENAME Indicates interest in entries which have been renamed.
[Expand]
Inherited Constants
From interface javax.naming.ldap.Control
[Expand]
Inherited Fields
From class com.sun.jndi.ldap.BasicControl
Public Constructors
PersistentSearchControl()
Constructs a persistent search non-critical control.
PersistentSearchControl(int changeTypes, boolean changesOnly, boolean returnControls, boolean criticality)
Constructs a persistent search control.
[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 interest in entries which have been added.

Constant Value: 1 (0x00000001)

public static final int ANY

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

Constant Value: 15 (0x0000000f)

public static final int DELETE

Indicates interest in entries which have been deleted.

Constant Value: 2 (0x00000002)

public static final int MODIFY

Indicates interest in entries which have been modified.

Constant Value: 4 (0x00000004)

public static final String OID

The persistent search control's assigned object identifier is 2.16.840.1.113730.3.4.3.

Constant Value: "2.16.840.1.113730.3.4.3"

public static final int RENAME

Indicates interest in entries which have been renamed.

Constant Value: 8 (0x00000008)

Public Constructors

public PersistentSearchControl ()

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.

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

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.