Package org.ldaptive.control
Class PersistentSearchRequestControl
java.lang.Object
org.ldaptive.control.AbstractControl
org.ldaptive.control.PersistentSearchRequestControl
- All Implemented Interfaces:
Control
,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
FieldsModifier and TypeFieldDescriptionprivate boolean
whether to return only changed entries.private EnumSet<PersistentSearchChangeType>
persistent search change types.private static final int
hash code seed.static final String
OID of this control.private boolean
whether to return an Entry Change Notification control.Fields inherited from class org.ldaptive.control.AbstractControl
logger
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.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 TypeMethodDescriptionbyte[]
encode()
Provides the BER encoding of this control.boolean
boolean
Returns whether only changed entries are returned.Returns the persistent search change types.boolean
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
Sets the persistent search change types.void
setReturnEcs
(boolean b) Sets whether to return an Entry Change Notification control.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 Details
-
OID
OID of this control.- See Also:
-
HASH_CODE_SEED
private static final int HASH_CODE_SEEDhash code seed.- See Also:
-
changeTypes
persistent search change types. -
changesOnly
private boolean changesOnlywhether to return only changed entries. -
returnEcs
private boolean returnEcswhether to return an Entry Change Notification control.
-
-
Constructor Details
-
PersistentSearchRequestControl
public PersistentSearchRequestControl()Default constructor. -
PersistentSearchRequestControl
Creates a new persistent search request control.- Parameters:
types
- persistent search change types
-
PersistentSearchRequestControl
Creates a new persistent search request control.- Parameters:
types
- persistent search change typescritical
- 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 typesco
- whether only changed entries are returnedre
- 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 typesco
- whether only changed entries are returnedre
- return an Entry Change Notification controlcritical
- whether this control is critical
-
-
Method Details
-
hasValue
public boolean hasValue()Description copied from interface:RequestControl
Returns whether the control has a value associated with it.- Specified by:
hasValue
in interfaceRequestControl
- Returns:
- whether the control has a value
-
getChangeTypes
Returns the persistent search change types.- Returns:
- persistent search change types
-
setChangeTypes
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
- Overrides:
equals
in classAbstractControl
-
hashCode
public int hashCode()Description copied from class:AbstractControl
Returns the hash code for this object.- Specified by:
hashCode
in classAbstractControl
- Returns:
- hash code
-
toString
- Overrides:
toString
in classAbstractControl
-
encode
public byte[] encode()Description copied from interface:RequestControl
Provides the BER encoding of this control.- Specified by:
encode
in interfaceRequestControl
- Returns:
- BER encoded request control
-