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
| Modifier and Type | Field and Description |
|---|---|
| private String | badAttrId
The ID of the attribute that caused the sort to fail. |
| public static final 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 final long |
| Access | Constructor and Description |
|---|---|
| public | SortResponseControl(String
The control's object identifier string. id, boolean The control's criticality. criticality, byte[] The control's ASN.1 BER encoded value.
It is not cloned - any changes to value
will affect the contents of the control. value)Constructs a control to indicate the outcome of a sort request. |
| Modifier and Type | Method and Description |
|---|---|
| public String | Returns: The possibly null ID of the bad attribute.Retrieves the ID of the attribute that caused the sort to fail. |
| public NamingException | Returns: A NamingException or null if the result code indicates success.Retrieves the NamingException appropriate for the result code. |
| public int | Returns: The result code. A zero value indicates success.Retrieves the LDAP result code of the sort operation. |
| public boolean | Returns: true if the search results have been sorted.Determines if the search results have been successfully sorted. |
| badAttrId | back to summary |
|---|---|
| private String badAttrId The ID of the attribute that caused the sort to fail. | |
| OID | back to summary |
|---|---|
| public static final String OID The server-side sort response control's assigned object identifier is 1.2.840.113556.1.4.474. | |
| resultCode | back to summary |
|---|---|
| private int resultCode The sort result code. | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| SortResponseControl | back to summary |
|---|---|
| public SortResponseControl(String id, boolean criticality, byte[] value) throws IOException Constructs a control to indicate the outcome of a sort request.
| |
| getAttributeID | back to summary |
|---|---|
| public String getAttributeID() Retrieves the ID of the attribute that caused the sort to fail. Returns null if no ID was returned by the server.
| |
| getException | back to summary |
|---|---|
| public NamingException getException() Retrieves the NamingException appropriate for the result code.
| |
| getResultCode | back to summary |
|---|---|
| public int getResultCode() Retrieves the LDAP result code of the sort operation.
| |
| isSorted | back to summary |
|---|---|
| public boolean isSorted() Determines if the search results have been successfully sorted. If an error occurred during sorting a NamingException is thrown.
| |