Package com.netscape.jndi.ldap.controls
Class LdapSortResponseControl
java.lang.Object
netscape.ldap.LDAPControl
netscape.ldap.controls.LDAPSortControl
com.netscape.jndi.ldap.controls.LdapSortResponseControl
- All Implemented Interfaces:
Serializable
,Cloneable
,Control
public class LdapSortResponseControl
extends netscape.ldap.controls.LDAPSortControl
implements Control
The LDAP server sends back a sort response control to indicate
the result of the sorting operation. (The OID for this control
is 1.2.840.113556.1.4.474.)
This control contains:
- the result code from the sorting operation
- optionally, the first attribute type in the sort key list that resulted in an error (for example, if the attribute does not exist)
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:
-
Field Summary
Fields inherited from class netscape.ldap.controls.LDAPSortControl
SORTREQUEST, SORTRESPONSE
Fields inherited from class netscape.ldap.LDAPControl
m_critical, m_value, MANAGEDSAIT, PWEXPIRED, PWEXPIRING
Fields inherited from interface javax.naming.ldap.Control
CRITICAL, NONCRITICAL
-
Method Summary
Modifier and TypeMethodDescriptionbyte[]
Retrieves the ASN.1 BER encoded value of the LDAP control.Get the first attribute type from the sort key list that resulted in an errorint
Return the sort result codeReturn corresponding NamingException for the sort error codeMethods inherited from class netscape.ldap.controls.LDAPSortControl
parseResponse, toString
Methods inherited from class netscape.ldap.LDAPControl
clone, createControl, flattenBER, getID, getValue, isCritical, lookupControlClass, newInstance, register
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface javax.naming.ldap.Control
getID, isCritical
-
Method Details
-
getFailedAttribute
Get the first attribute type from the sort key list that resulted in an error- Overrides:
getFailedAttribute
in classnetscape.ldap.controls.LDAPSortControl
- Returns:
- Attribute name that resulted in an error
-
getResultCode
public int getResultCode()Return the sort result code- Overrides:
getResultCode
in classnetscape.ldap.controls.LDAPSortControl
- Returns:
- The sort result code
-
getSortException
Return corresponding NamingException for the sort error code- Returns:
- NamingException for the sort error code
-
getEncodedValue
public byte[] getEncodedValue()Retrieves the ASN.1 BER encoded value of the LDAP control. Null is returned if the value is absent.- Specified by:
getEncodedValue
in interfaceControl
- Returns:
- A possibly null byte array representing the ASN.1 BER encoded value of the LDAP control.
-