org.apache.directory.shared.ldap.message.control
Class PersistentSearchControl

java.lang.Object
  org.apache.directory.shared.ldap.message.control.InternalAbstractControl
      org.apache.directory.shared.ldap.message.control.PersistentSearchControl

All Implemented Interfaces:

java.io.Serializable, javax.naming.ldap.Control, InternalControl

public class PersistentSearchControl
extends InternalAbstractControl

The control for a persistent search operation, as defined in http://www.ietf.org/proceedings/01mar/I-D/ldapext-psearch-03.txt. The data structure is defined by the following ASN.1 description : PersistentSearch ::= SEQUENCE { changeTypes INTEGER, changesOnly BOOLEAN, returnECs BOOLEAN } The associated OID is : "2.16.840.1.113730.3.4.3"

Version:

$Rev: 764131 $

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary

static int	ALL_CHANGES A combinaison of all the possible changes.
static java.lang.String	CONTROL_OID This control OID

Fields inherited from interface javax.naming.ldap.Control

CRITICAL, NONCRITICAL

Constructor Summary

PersistentSearchControl()

Method Summary

void	enableNotification(ChangeType changeType)
int	getChangeTypes()
byte[]	getEncodedValue()
boolean	isChangesOnly()
boolean	isNotificationEnabled(ChangeType changeType)
boolean	isReturnECs()
void	setChangesOnly(boolean changesOnly)
void	setChangeTypes(int changeTypes)
void	setReturnECs(boolean returnECs)

Methods inherited from class org.apache.directory.shared.ldap.message.control.InternalAbstractControl

getID, isCritical, setCritical, setID

Methods inherited from class java.lang.Object

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

Field Detail

CONTROL_OID

public static final java.lang.String CONTROL_OID

This control OID

See Also:

Constant Field Values

ALL_CHANGES

public static final int ALL_CHANGES

A combinaison of all the possible changes. Resolves to 0x0F

See Also:

Constant Field Values

Constructor Detail

PersistentSearchControl

public PersistentSearchControl()

Method Detail

setChangesOnly

public void setChangesOnly(boolean changesOnly)

isChangesOnly

public boolean isChangesOnly()

setReturnECs

public void setReturnECs(boolean returnECs)

isReturnECs

public boolean isReturnECs()

setChangeTypes

public void setChangeTypes(int changeTypes)

getChangeTypes

public int getChangeTypes()

isNotificationEnabled

public boolean isNotificationEnabled(ChangeType changeType)

enableNotification

public void enableNotification(ChangeType changeType)

getEncodedValue

public byte[] getEncodedValue()

Returns:

The encoded byte[] for this persistentSearch control