org.ldaptive.control

Class SortResponseControl

java.lang.Object

org.ldaptive.control.AbstractControl

org.ldaptive.control.SortResponseControl

All Implemented Interfaces:

Control, ResponseControl

public class SortResponseControl
extends AbstractControl
implements ResponseControl

Response control for server side sorting. See RFC 2891. Control is defined as:

       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 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SortResponseControl.AttributeTypeHandler Parse handler implementation for the attribute type.
private static class	SortResponseControl.SortResultHandler Parse handler implementation for the sort result.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	attributeName Failed attribute name.
private static int	HASH_CODE_SEED hash code seed.
static java.lang.String	OID OID of this control.
private ResultCode	sortResult Result of the server side sorting.

Fields inherited from class org.ldaptive.control.AbstractControl

logger

Constructor Summary

Constructors

Constructor and Description
SortResponseControl() Default constructor.
SortResponseControl(boolean critical) Creates a new sort response control.
SortResponseControl(ResultCode code, boolean critical) Creates a new sort response control.
SortResponseControl(ResultCode code, java.lang.String attrName, boolean critical) Creates a new sort response control.

Method Summary

Modifier and Type	Method and Description
void	decode(byte[] berValue) Initializes this response control with the supplied BER encoded data.
java.lang.String	getAttributeName() Returns the attribute name that caused the sort to fail.
ResultCode	getSortResult() Returns the result code of the server side sort.
int	hashCode() Returns the hash code for this object.
void	setAttributeName(java.lang.String name) Sets the attribute name that caused the sort to fail.
void	setSortResult(ResultCode code) Sets the result code of the server side sort.
java.lang.String	toString()

Methods inherited from class org.ldaptive.control.AbstractControl

equals, 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 Detail

OID

public static final java.lang.String OID

OID of this control.

See Also:

Constant Field Values

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

Constant Field Values

sortResult

private ResultCode sortResult

Result of the server side sorting.

attributeName

private java.lang.String attributeName

Failed attribute name.

Constructor Detail

SortResponseControl

public SortResponseControl()

Default constructor.

SortResponseControl

public SortResponseControl(boolean critical)

Creates a new sort response control.

Parameters:

critical - whether this control is critical

SortResponseControl

public SortResponseControl(ResultCode code,
                           boolean critical)

Creates a new sort response control.

Parameters:

code - result of the sort

critical - whether this control is critical

SortResponseControl

public SortResponseControl(ResultCode code,
                           java.lang.String attrName,
                           boolean critical)

Creates a new sort response control.

Parameters:

code - result of the sort

attrName - name of the failed attribute

critical - whether this control is critical

Method Detail

getSortResult

public ResultCode getSortResult()

Returns the result code of the server side sort.

Returns:

result code

setSortResult

public void setSortResult(ResultCode code)

Sets the result code of the server side sort.

Parameters:

code - result code

getAttributeName

public java.lang.String getAttributeName()

Returns the attribute name that caused the sort to fail.

Returns:

attribute name

setAttributeName

public void setAttributeName(java.lang.String name)

Sets the attribute name that caused the sort to fail.

Parameters:

name - of an attribute

hashCode

public int hashCode()

Description copied from class: AbstractControl

Returns the hash code for this object.

Specified by:

hashCode in class AbstractControl

Returns:

hash code

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

decode

public void decode(byte[] berValue)

Description copied from interface: ResponseControl

Initializes this response control with the supplied BER encoded data.

Specified by:

decode in interface ResponseControl

Parameters:

berValue - BER encoded response control