Package org.ldaptive.control

Class PersistentSearchRequestControl

java.lang.Object

org.ldaptive.control.AbstractControl

org.ldaptive.control.PersistentSearchRequestControl

All Implemented Interfaces:

Control, RequestControl

public class PersistentSearchRequestControl
extends AbstractControl
implements RequestControl

Request control for persistent search. See http://tools.ietf.org/id/draft-ietf-ldapext-psearch-03.txt. Control is defined as:

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

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	changesOnly	whether to return only changed entries.
private EnumSet<PersistentSearchChangeType>	changeTypes	persistent search change types.
private static int	HASH_CODE_SEED	hash code seed.
static String	OID	OID of this control.
private boolean	returnEcs	whether to return an Entry Change Notification control.

Fields inherited from class org.ldaptive.control.AbstractControl

logger

Constructor Summary

Constructors

Constructor	Description
PersistentSearchRequestControl()	Default constructor.
PersistentSearchRequestControl(EnumSet<PersistentSearchChangeType> types)	Creates a new persistent search request control.
PersistentSearchRequestControl(EnumSet<PersistentSearchChangeType> types, boolean critical)	Creates a new persistent search request control.
PersistentSearchRequestControl(EnumSet<PersistentSearchChangeType> types, boolean co, boolean re)	Creates a new persistent search request control.
PersistentSearchRequestControl(EnumSet<PersistentSearchChangeType> types, boolean co, boolean re, boolean critical)	Creates a new persistent search request control.

Method Summary

Modifier and Type	Method	Description
byte[]	encode()	Provides the BER encoding of this control.
boolean	equals(Object o)
boolean	getChangesOnly()	Returns whether only changed entries are returned.
EnumSet<PersistentSearchChangeType>	getChangeTypes()	Returns the persistent search change types.
boolean	getReturnEcs()	Returns whether to return an Entry Change Notification control.
int	hashCode()	Returns the hash code for this object.
boolean	hasValue()	Returns whether the control has a value associated with it.
void	setChangesOnly(boolean b)	Sets whether only changed entries are returned.
void	setChangeTypes(EnumSet<PersistentSearchChangeType> types)	Sets the persistent search change types.
void	setReturnEcs(boolean b)	Sets whether to return an Entry Change Notification control.
String	toString()

Methods inherited from class org.ldaptive.control.AbstractControl

getCriticality, getOID

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ldaptive.control.Control

getCriticality, getOID

Field Detail

OID

public static final String OID

OID of this control.

See Also:

Constant Field Values

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

Constant Field Values

changeTypes

private EnumSet<PersistentSearchChangeType> changeTypes

persistent search change types.

changesOnly

private boolean changesOnly

whether to return only changed entries.

returnEcs

private boolean returnEcs

whether to return an Entry Change Notification control.

Constructor Detail

PersistentSearchRequestControl

public PersistentSearchRequestControl()

Default constructor.

PersistentSearchRequestControl

public PersistentSearchRequestControl(EnumSet<PersistentSearchChangeType> types)

Creates a new persistent search request control.

Parameters:

types - persistent search change types

PersistentSearchRequestControl

public PersistentSearchRequestControl(EnumSet<PersistentSearchChangeType> types,
                                      boolean critical)

Creates a new persistent search request control.

Parameters:

types - persistent search change types

critical - whether this control is critical

PersistentSearchRequestControl

public PersistentSearchRequestControl(EnumSet<PersistentSearchChangeType> types,
                                      boolean co,
                                      boolean re)

Creates a new persistent search request control.

Parameters:

types - persistent search change types

co - whether only changed entries are returned

re - return an Entry Change Notification control

PersistentSearchRequestControl

public PersistentSearchRequestControl(EnumSet<PersistentSearchChangeType> types,
                                      boolean co,
                                      boolean re,
                                      boolean critical)

Creates a new persistent search request control.

Parameters:

types - persistent search change types

co - whether only changed entries are returned

re - return an Entry Change Notification control

critical - whether this control is critical

Method Detail

hasValue

public boolean hasValue()

Description copied from interface: RequestControl

Returns whether the control has a value associated with it.

Specified by:

hasValue in interface RequestControl

Returns:

whether the control has a value

getChangeTypes

public EnumSet<PersistentSearchChangeType> getChangeTypes()

Returns the persistent search change types.

Returns:

persistent search change types

setChangeTypes

public void setChangeTypes(EnumSet<PersistentSearchChangeType> types)

Sets the persistent search change types.

Parameters:

types - persistent search change types

getChangesOnly

public boolean getChangesOnly()

Returns whether only changed entries are returned.

Returns:

whether only changed entries are returned

setChangesOnly

public void setChangesOnly(boolean b)

Sets whether only changed entries are returned.

Parameters:

b - whether only changed entries are returned

getReturnEcs

public boolean getReturnEcs()

Returns whether to return an Entry Change Notification control.

Returns:

whether to return an Entry Change Notification control

setReturnEcs

public void setReturnEcs(boolean b)

Sets whether to return an Entry Change Notification control.

Parameters:

b - return an Entry Change Notification control

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractControl

hashCode

public int hashCode()

Description copied from class: AbstractControl

Returns the hash code for this object.

Specified by:

hashCode in class AbstractControl

Returns:

hash code

toString

public String toString()

Overrides:

toString in class AbstractControl

encode

public byte[] encode()

Description copied from interface: RequestControl

Provides the BER encoding of this control.

Specified by:

encode in interface RequestControl

Returns:

BER encoded request control