java.lang.Object
javax.naming.ldap.BasicControl
javax.naming.ldap.SortResponseControl
- All Implemented Interfaces:
- Serializable,- Control
Indicates whether the requested sort of search results was successful or not.
 When the result code indicates success then the results have been sorted as
 requested. Otherwise the sort was unsuccessful and additional details
 regarding the cause of the error may have been provided by the server.
 
 The code sample in SortControl shows how this class may be used.
 
This class implements the LDAPv3 Response Control for server-side sorting 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 }
 - Since:
- 1.5
- See Also:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringThe server-side sort response control's assigned object identifier is 1.2.840.113556.1.4.474.Fields declared in class javax.naming.ldap.BasicControlcriticality, id, valueFields declared in interface javax.naming.ldap.ControlCRITICAL, NONCRITICAL
- 
Constructor SummaryConstructorsConstructorDescriptionSortResponseControl(String id, boolean criticality, byte[] value) Constructs a control to indicate the outcome of a sort request.
- 
Method SummaryModifier and TypeMethodDescriptionRetrieves the ID of the attribute that caused the sort to fail.Retrieves the NamingException appropriate for the result code.intRetrieves the LDAP result code of the sort operation.booleanisSorted()Determines if the search results have been successfully sorted.Methods declared in class javax.naming.ldap.BasicControlgetEncodedValue, getID, isCritical
- 
Field Details- 
OIDThe server-side sort response control's assigned object identifier is 1.2.840.113556.1.4.474.- See Also:
 
 
- 
- 
Constructor Details- 
SortResponseControlConstructs a control to indicate the outcome of a sort request.- Parameters:
- id- The control's object identifier string.
- criticality- The control's criticality.
- value- The control's ASN.1 BER encoded value. It is not cloned - any changes to value will affect the contents of the control.
- Throws:
- IOException- if an error is encountered while decoding the control's value.
 
 
- 
- 
Method Details- 
isSortedpublic 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.
 
- 
getResultCodepublic int getResultCode()Retrieves the LDAP result code of the sort operation.- Returns:
- The result code. A zero value indicates success.
 
- 
getAttributeIDRetrieves 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.
 
- 
getExceptionRetrieves the NamingException appropriate for the result code.- Returns:
- A NamingException or null if the result code indicates success.
 
 
-