com.netscape.jndi.ldap.controls
public class LdapSortResponseControl extends LDAPSortControl implements Control
This control contains:
To parse this control, use the parseResponse
method.
The following table lists what kinds of results to expect from the LDAP server under different situations:
Does the Server Support the Sorting Control? | Is the Sorting Control Marked As Critical? | Other Conditions | Results from LDAP Server |
---|---|---|---|
No | Yes | None |
|
No | None |
|
|
Yes | Yes | The server cannot sort the results using the specified sort key list. |
|
No |
|
||
N/A (could either be marked as critical or not) | The server successfully sorted the entries. |
|
|
The search itself failed (for any reason). |
|
See Also: LdapSortKey LdapSortControl
Method Summary | |
---|---|
byte[] | getEncodedValue()
Retrieves the ASN.1 BER encoded value of the LDAP control.
|
String | getFailedAttribute()
Get the first attribute type from the sort key list that
resulted in an error |
int | getResultCode()
Return the sort result code |
NamingException | getSortException()
Return corresponding NamingException for the sort error code |
Returns: A possibly null byte array representing the ASN.1 BER encoded value of the LDAP control.
Returns: Attribute name that resulted in an error
Returns: The sort result code
Returns: NamingException for the sort error code