public class ServerSideSortResponseControl extends Control
SortResult ::= SEQUENCE { sortResult ENUMERATED { success (0), -- results are sorted operationsError (1), -- server internal failure timeLimitExceeded (3), -- timelimit reached before -- sorting was completed strongAuthRequired (8), -- refused to return sorted -- results via insecure -- protocol adminLimitExceeded (11), -- too many matching entries -- for the server to sort noSuchAttribute (16), -- unrecognized attribute -- type in sort key inappropriateMatching (18), -- unrecognized or -- inappropriate matching -- rule in sort key insufficientAccessRights (50), -- refused to return sorted -- results to this client busy (51), -- too busy to process unwillingToPerform (53), -- unable to sort other (80) }, attributeType [0] AttributeDescription OPTIONAL }
Modifier and Type | Field and Description |
---|---|
static ControlDecoder<ServerSideSortResponseControl> |
DECODER
The Control Decoder that can be used to decode this control.
|
Constructor and Description |
---|
ServerSideSortResponseControl(boolean isCritical,
int resultCode,
String attributeType)
Creates a new server-side sort response control with the provided information.
|
ServerSideSortResponseControl(int resultCode,
String attributeType)
Creates a new server-side sort response control based on the provided result code and attribute type.
|
Modifier and Type | Method and Description |
---|---|
String |
getAttributeType()
Retrieves the attribute type for this sort result.
|
int |
getResultCode()
Retrieves the result code for this sort result.
|
org.forgerock.opendj.ldap.ByteString |
getValue() |
boolean |
hasValue() |
void |
toString(StringBuilder buffer)
Appends a string representation of this 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, getValueAdapter, isCritical, toString, write
public static final ControlDecoder<ServerSideSortResponseControl> DECODER
public ServerSideSortResponseControl(int resultCode, String attributeType)
resultCode
- The result code for the sort result.attributeType
- The attribute type for the sort result (or null
if there is none).public ServerSideSortResponseControl(boolean isCritical, int resultCode, String attributeType)
isCritical
- Indicates whether support for this control should be considered a critical part of the server
processing.resultCode
- The result code for the sort result.attributeType
- The attribute type for the sort result.public int getResultCode()
public String getAttributeType()
null
if there is none.public boolean hasValue()
public org.forgerock.opendj.ldap.ByteString getValue()
protected void writeValue(org.forgerock.opendj.io.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–2017 ForgeRock AS. All rights reserved.