Serializable
, Control
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 }
Modifier and Type | Field | Description |
---|---|---|
static final String |
OID |
The server-side sort response control's assigned object identifier is 1.2.840.113556.1.4.474. |
criticality, id, value
CRITICAL, NONCRITICAL
Constructor | Description |
---|---|
SortResponseControl |
Constructs a control to indicate the outcome of a sort request. |
Modifier and Type | Method | 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, isCritical
public 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()
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.naming/javax/naming/ldap/SortResponseControl.html