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:
java.io.Serializable
,java.lang.Cloneable
,javax.naming.ldap.Control
public class LdapSortResponseControl extends netscape.ldap.controls.LDAPSortControl implements javax.naming.ldap.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 - The server does not send back any entries.
- An LDAPException.UNAVAILABLE_CRITICAL_EXTENSION exception is thrown.
No None - The server ignores the sorting control and returns the entries unsorted.
Yes Yes The server cannot sort the results using the specified sort key list. - The server does not send back any entries.
- An LDAPException.UNAVAILABLE_CRITICAL_EXTENSION exception is thrown.
- The server sends back the sorting response control, which specifies the result code of the sort attempt and (optionally) the attribute type that caused the error.
No - The server returns the entries unsorted.
- The server sends back the sorting response control, which specifies the result code of the sort attempt and (optionally) the attribute type that caused the error.
N/A (could either be marked as critical or not) The server successfully sorted the entries. - The server sends back the sorted entries.
- The server sends back the sorting response control, which specifies the result code of the sort attempt (LDAPException.SUCCESS).
The search itself failed (for any reason). - The server sends back a result code for the search operation.
- The server does not send back the sorting response control.
- See Also:
LdapSortKey
,LdapSortControl
, Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 errorint
getResultCode()
Return the sort result codejavax.naming.NamingException
getSortException()
Return corresponding NamingException for the sort error code-
Methods inherited from class netscape.ldap.LDAPControl
clone, createControl, flattenBER, getID, getValue, isCritical, lookupControlClass, newInstance, register
-
-
-
-
Method Detail
-
getFailedAttribute
public java.lang.String 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
public javax.naming.NamingException 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 interfacejavax.naming.ldap.Control
- Returns:
- A possibly null byte array representing the ASN.1 BER encoded value of the LDAP control.
-
-