public class LdapSortResponseControl
extends netscape.ldap.controls.LDAPSortControl
implements javax.naming.ldap.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). |
|
LdapSortKey
,
LdapSortControl
,
Serialized FormModifier and Type | Method and Description |
---|---|
byte[] |
getEncodedValue()
Retrieves the ASN.1 BER encoded value of the LDAP control.
|
java.lang.String |
getFailedAttribute()
Get the first attribute type from the sort key list that
resulted in an error
|
int |
getResultCode()
Return the sort result code
|
javax.naming.NamingException |
getSortException()
Return corresponding NamingException for the sort error code
|
clone, createControl, flattenBER, getID, getValue, isCritical, lookupControlClass, newInstance, register
public java.lang.String getFailedAttribute()
getFailedAttribute
in class netscape.ldap.controls.LDAPSortControl
public int getResultCode()
getResultCode
in class netscape.ldap.controls.LDAPSortControl
public javax.naming.NamingException getSortException()
public byte[] getEncodedValue()
getEncodedValue
in interface javax.naming.ldap.Control