Package org.ldaptive.control
Class SortRequestControl
java.lang.Object
org.ldaptive.control.AbstractControl
org.ldaptive.control.SortRequestControl
- All Implemented Interfaces:
Control
,RequestControl
Request control for server side sorting. See RFC 2891. Control is defined as:
SortKeyList ::= SEQUENCE OF SEQUENCE { attributeType AttributeDescription, orderingRule [0] MatchingRuleId OPTIONAL, reverseOrder [1] BOOLEAN DEFAULT FALSE }
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
hash code seed.static final String
OID of this control.private SortKey[]
sort keys.Fields inherited from class org.ldaptive.control.AbstractControl
logger
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.SortRequestControl
(SortKey[] keys) Creates a new sort request control.SortRequestControl
(SortKey[] keys, boolean critical) Creates a new sort request control. -
Method Summary
Modifier and TypeMethodDescriptionbyte[]
encode()
Provides the BER encoding of this control.boolean
SortKey[]
Returns the sort keys.int
hashCode()
Returns the hash code for this object.boolean
hasValue()
Returns whether the control has a value associated with it.void
setSortKeys
(SortKey[] keys) Sets the sort keys.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:
-
sortKeys
sort keys.
-
-
Constructor Details
-
SortRequestControl
public SortRequestControl()Default constructor. -
SortRequestControl
Creates a new sort request control.- Parameters:
keys
- sort keys
-
SortRequestControl
Creates a new sort request control.- Parameters:
keys
- sort keyscritical
- 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
-
getSortKeys
Returns the sort keys.- Returns:
- sort keys
-
setSortKeys
Sets the sort keys.- Parameters:
keys
- sort keys
-
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
-