public final class SortResponseControl extends BasicControl
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 }
SortControl,
Serialized Form| Modifier and Type | Field and Description |
|---|---|
static String |
OID
The server-side sort response control's assigned object identifier
is 1.2.840.113556.1.4.474.
|
criticality, id, valueCRITICAL, NONCRITICAL| Constructor and Description |
|---|
SortResponseControl(String id,
boolean criticality,
byte[] value)
Constructs a control to indicate the outcome of a sort request.
|
| Modifier and Type | Method and Description |
|---|---|
String |
getAttributeID()
Retrieves the ID of the attribute that caused the sort to fail.
|
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.
|
getEncodedValue, getID, isCriticalpublic static final String OID
public SortResponseControl(String id, boolean criticality, byte[] value) throws IOException
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.IOException - if an error is encountered
while decoding the control's value.public boolean isSorted()
public int getResultCode()
public String getAttributeID()
public NamingException getException()
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2018, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.