OpenJDK 27 · com.sun.jndi.ldap.PersistentSearchControl

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
    }

Field Summary

Modifier and Type	Field and Description
public static final int	ADD Indicates interest in entries which have been added.
public static final int	ANY Indicates interest in entries which have been added, deleted, modified or renamed.
private boolean	changesOnly Return original entries and changed entries or only changed entries.
private int	changeTypes The change types of interest.
public static final int	DELETE Indicates interest in entries which have been deleted.
public static final int	MODIFY Indicates interest in entries which have been modified.
public static final String	OID The persistent search control's assigned object identifier is 2.16.840.1.113730.3.4.3.
public static final int	RENAME Indicates interest in entries which have been renamed.
private boolean	returnControls Return entry change controls.
private static final long	serialVersionUID Hides com.sun.jndi.ldap.BasicControl.serialVersionUID.

Inherited from com.sun.jndi.ldap.BasicControl:: criticality id value

Constructor Summary

Access	Constructor and Description
public	PersistentSearchControl() Constructs a persistent search non-critical control.
public	PersistentSearchControl(int The change types of interest. changeTypes, boolean Return original entries and changed entries or only the changed entries. changesOnly, boolean Return entry change controls. returnControls, boolean The control's criticality. criticality) Constructs a persistent search control.

Method Summary

Modifier and Type	Method and Description
private byte[]	setEncodedValue()

Inherited from com.sun.jndi.ldap.BasicControl:: getEncodedValue getID isCritical

Field Detail

ADD	back to summary
public static final int ADD Indicates interest in entries which have been added.

ANY	back to summary
public static final int ANY Indicates interest in entries which have been added, deleted, modified or renamed.

changesOnly	back to summary
private boolean changesOnly Return original entries and changed entries or only changed entries.

changeTypes	back to summary
private int changeTypes The change types of interest. All changes, by default.

DELETE	back to summary
public static final int DELETE Indicates interest in entries which have been deleted.

MODIFY	back to summary
public static final int MODIFY Indicates interest in entries which have been modified.

OID	back to summary
public static final String OID The persistent search control's assigned object identifier is 2.16.840.1.113730.3.4.3.

RENAME	back to summary
public static final int RENAME Indicates interest in entries which have been renamed.

returnControls	back to summary
private boolean returnControls Return entry change controls.

serialVersionUID	back to summary
private static final long serialVersionUID Hides com.sun.jndi.ldap.BasicControl.serialVersionUID.

Constructor Detail

PersistentSearchControl	back to summary
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. Exceptions IOException: If a BER encoding error occurs.

PersistentSearchControl

back to summary

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.

Exceptions

IOException:: If a BER encoding error occurs.

PersistentSearchControl	back to summary
public PersistentSearchControl(int changeTypes, boolean changesOnly, boolean returnControls, boolean criticality) throws IOException Constructs a persistent search control. Parameters changeTypes:int The change types of interest. changesOnly:boolean Return original entries and changed entries or only the changed entries. returnControls:boolean Return entry change controls. criticality:boolean The control's criticality. Exceptions IOException: If a BER encoding error occurs.

PersistentSearchControl

back to summary

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

Constructs a persistent search control.

Parameters

changeTypes:int: The change types of interest.
changesOnly:boolean: Return original entries and changed entries or only the changed entries.
returnControls:boolean: Return entry change controls.
criticality:boolean: The control's criticality.