com.sun.jndi.ldap.ctl
Class SortResponseControl

java.lang.Object
  com.sun.jndi.ldap.BasicControl
      com.sun.jndi.ldap.ctl.SortResponseControl

All Implemented Interfaces:

java.io.Serializable, javax.naming.ldap.Control

public final class SortResponseControl
extends com.sun.jndi.ldap.BasicControl

This class implements the LDAPv3 Response Control for server-side sorting of search results as defined in RFC-2891. The control's value has the following ASN.1 definition:

     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 inappro-
                                           -- priate 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] AttributeType OPTIONAL }

 

Author:

Vincent Ryan

See Also:

SortControl, Serialized Form

Field Summary

private java.lang.String	badAttrId The ID of the attribute that caused the sort to fail.
static java.lang.String	OID The server-side sort response control's assigned object identifier is 1.2.840.113556.1.4.474.
private int	resultCode The sort result code.
private static long	serialVersionUID

Fields inherited from class com.sun.jndi.ldap.BasicControl

criticality, id, value

Fields inherited from interface javax.naming.ldap.Control

CRITICAL, NONCRITICAL

Constructor Summary

SortResponseControl(java.lang.String id, boolean criticality, byte[] value)
Constructs a new instance of SortResponseControl.

Method Summary

java.lang.String	getAttributeID() Retrieves the ID of the attribute that caused the sort to fail.
javax.naming.NamingException	getException() Retrieves the NamingException appropriate for the result code.
int	getResultCode() Retrieves the LDAP result code of the sort operation.
boolean	isSorted() Determines if the search results have been successfully sorted.

Methods inherited from class com.sun.jndi.ldap.BasicControl

getEncodedValue, getID, isCritical

Methods inherited from class java.lang.Object

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

Field Detail

OID

public static final java.lang.String OID

The server-side sort response control's assigned object identifier is 1.2.840.113556.1.4.474.

See Also:

Constant Field Values

resultCode

private int resultCode

The sort result code.

badAttrId

private java.lang.String badAttrId

The ID of the attribute that caused the sort to fail.

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

SortResponseControl

public SortResponseControl(java.lang.String id,
                           boolean criticality,
                           byte[] value)
                    throws java.io.IOException

Constructs a new instance of SortResponseControl.

Parameters:

id - The control's object identifier string.

criticality - The control's criticality.

value - The control's ASN.1 BER encoded value. May be null.

Throws:

java.io.IOException - if an error is encountered while decoding the control's value.

Method Detail

isSorted

public boolean isSorted()

Determines if the search results have been successfully sorted. If an error occurred during sorting a NamingException is thrown.

Returns:

true if the search results have been sorted.

getResultCode

public int getResultCode()

Retrieves the LDAP result code of the sort operation.

Returns:

The result code. A zero value indicates success.

getAttributeID

public java.lang.String getAttributeID()

Retrieves the ID of the attribute that caused the sort to fail. Returns null if no ID was returned by the server.

Returns:

The possibly null ID of the bad attribute.

getException

public javax.naming.NamingException getException()

Retrieves the NamingException appropriate for the result code.

Returns:

A NamingException or null if the result code indicates success.