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,
SortOrder sortOrder)
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(SortOrder sortOrder)
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.
|
SortOrder |
getSortOrder()
Retrieves the sort order for this server-side sort request control.
|
void |
toString(StringBuilder buffer)
Appends a string representation of this server-side sort request control
to the provided buffer.
|
protected void |
writeValue(org.forgerock.opendj.io.ASN1Writer writer)
Writes this control's value to an ASN.1 writer.
|
getOID, isCritical, toString, writepublic 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(SortOrder sortOrder)
sortOrder - The sort order to use for this control.public ServerSideSortRequestControl(boolean isCritical, SortOrder sortOrder)
isCritical - Indicates whether support for this control should be
considered a critical part of the server processing.sortOrder - sort order associated with this server-side sort
control.public SortOrder getSortOrder() throws DirectoryException
DirectoryException - if an error occurs while retriving 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.protected void writeValue(org.forgerock.opendj.io.ASN1Writer writer) throws IOException
writeValue in class Controlwriter - The ASN.1 writer to use.IOException - If a problem occurs while writing to the stream.public void toString(StringBuilder buffer)
Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.