|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnetscape.ldap.LDAPControl
netscape.ldap.controls.LDAPSortControl
com.netscape.jndi.ldap.controls.LdapSortResponseControl
public class LdapSortResponseControl
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:
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 FormField 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 |
Constructor Summary | |
---|---|
LdapSortResponseControl(boolean critical,
byte[] value)
Constructs a new LdapEntryChangeControl object. |
Method Summary | |
---|---|
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 |
Methods 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 |
Constructor Detail |
---|
LdapSortResponseControl(boolean critical, byte[] value) throws java.lang.Exception
LdapEntryChangeControl
object.
This constructor is used by the NetscapeControlFactory
java.lang.Exception
Method Detail |
---|
public java.lang.String getFailedAttribute()
getFailedAttribute
in class LDAPSortControl
public int getResultCode()
getResultCode
in class LDAPSortControl
public javax.naming.NamingException getSortException()
public byte[] getEncodedValue()
getEncodedValue
in interface javax.naming.ldap.Control
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |