public class ServerSideSortRequestControl extends Control
SortKeyList ::= SEQUENCE OF SEQUENCE { attributeType AttributeDescription, orderingRule [0] MatchingRuleId OPTIONAL, reverseOrder [1] BOOLEAN DEFAULT FALSE }
Modifier and Type | Field and Description |
---|---|
static ControlDecoder<ServerSideSortRequestControl> |
DECODER
The Control Decoder that can be used to decode this control.
|
Constructor and Description |
---|
ServerSideSortRequestControl(boolean isCritical,
List<SortKey> sortKeys)
Creates a new server-side sort request control with the provided information.
|
ServerSideSortRequestControl(boolean isCritical,
String sortOrderString)
Creates a new server-side sort request control based on the definition in the provided sort order string.
|
ServerSideSortRequestControl(List<SortKey> sortKeys)
Creates a new server-side sort request control based on the provided sort order.
|
ServerSideSortRequestControl(String sortOrderString)
Creates a new server-side sort request control based on the definition in the provided sort order string.
|
Modifier and Type | Method and Description |
---|---|
boolean |
containsSortKeys()
Indicates whether the sort control contains Sort keys.
|
List<SortKey> |
getSortKeys()
Retrieves the sort order for this server-side sort request control.
|
ByteString |
getValue()
Returns the value, if any, associated with this control.
|
boolean |
hasValue()
Returns
true if this control has a value. |
void |
toString(StringBuilder buffer)
Appends a string representation of this control to the provided buffer.
|
protected void |
writeValue(Asn1Writer writer)
Writes this control's value to an ASN.1 writer.
|
getOid, getValueAdapter, isCritical, toString, write
public static final ControlDecoder<ServerSideSortRequestControl> DECODER
public ServerSideSortRequestControl(String sortOrderString) throws LDAPException
sortOrderString
- The string representation of the sort order to use for the control.LDAPException
- If the provided sort order string could not be decoded.public ServerSideSortRequestControl(boolean isCritical, String sortOrderString) throws LDAPException
isCritical
- Indicates whether support for this control should be considered a critical part of the server
processing.sortOrderString
- The string representation of the sort order to use for the control.LDAPException
- If the provided sort order string could not be decoded.public ServerSideSortRequestControl(List<SortKey> sortKeys)
sortKeys
- The sort order to use for this control.public ServerSideSortRequestControl(boolean isCritical, List<SortKey> sortKeys)
isCritical
- Indicates whether support for this control should be considered a critical part of the server
processing.sortKeys
- sort order associated with this server-side sort control.public List<SortKey> getSortKeys() throws DirectoryException
DirectoryException
- if an error occurs while retrieving the sort order.public boolean containsSortKeys() throws DirectoryException
A Sort control may not contain sort keys if the attribute type is not recognized by the server
true
if the control contains sort keys or false
if it does not.DirectoryException
- If a problem occurs while trying to make the determination.public boolean hasValue()
Control
true
if this control has a value. In some circumstances
it may be useful to determine if a control has a value, without actually
calculating the value and incurring any performance costs.true
if this control has a value, or false
if
there is no value.public ByteString getValue()
Control
protected void writeValue(Asn1Writer writer) throws IOException
Control
writeValue
in class Control
writer
- The ASN.1 writer to use.IOException
- If a problem occurs while writing to the stream.public void toString(StringBuilder buffer)
Control
Copyright 2010-2020 ForgeRock AS.