Package org.opends.server.controls

Class ServerSideSortResponseControl

java.lang.Object

org.opends.server.types.Control

org.opends.server.controls.ServerSideSortResponseControl

public class ServerSideSortResponseControl
extends Control

This class implements the server-side sort response control as defined in RFC 2891 section 1.2. The ASN.1 description for the control value is:

 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 }
 

Field Summary

Fields

Modifier and Type	Field	Description
static ControlDecoder<ServerSideSortResponseControl>	DECODER	The Control Decoder that can be used to decode this control.

Constructor Summary

Constructors

Constructor	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.

Method Summary

Modifier and Type	Method	Description
String	getAttributeType()	Retrieves the attribute type for this sort result.
int	getResultCode()	Retrieves the result code for this sort result.
void	toString(StringBuilder buffer)	Appends a string representation of this server-side sort response control to the provided buffer.
protected void	writeValue(ASN1Writer writer)	Writes this control's value to an ASN.1 writer.

Methods inherited from class org.opends.server.types.Control

getOID, isCritical, toString, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DECODER

public static final ControlDecoder<ServerSideSortResponseControl> DECODER

The Control Decoder that can be used to decode this control.

Constructor Detail

ServerSideSortResponseControl

public ServerSideSortResponseControl(int resultCode,
                                     String attributeType)

Creates a new server-side sort response control based on the provided result code and attribute type.

Parameters:

resultCode - The result code for the sort result.

attributeType - The attribute type for the sort result (or null if there is none).

ServerSideSortResponseControl

public ServerSideSortResponseControl(boolean isCritical,
                                     int resultCode,
                                     String attributeType)

Creates a new server-side sort response control with the provided information.

Parameters:

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.

Method Detail

getResultCode

public int getResultCode()

Retrieves the result code for this sort result.

Returns:

The result code for this sort result.

getAttributeType

public String getAttributeType()

Retrieves the attribute type for this sort result.

Returns:

The attribute type for this sort result, or null if there is none.

writeValue

protected void writeValue(ASN1Writer writer)
                   throws IOException

Writes this control's value to an ASN.1 writer. The value (if any) must be written as an ASN1OctetString.

Specified by:

writeValue in class Control

Parameters:

writer - The ASN.1 writer to use.

Throws:

IOException - If a problem occurs while writing to the stream.

toString

public void toString(StringBuilder buffer)

Appends a string representation of this server-side sort response control to the provided buffer.

Overrides:

toString in class Control

Parameters:

buffer - The buffer to which the information should be appended.