|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.jndi.ldap.BasicControl
com.sun.jndi.ldap.ctl.SortResponseControl
public final class SortResponseControl
This class implements the LDAPv3 Response Control for server-side sorting of search results as defined in RFC-2891. The control's value has the following ASN.1 definition:
SortResult ::= SEQUENCE { sortResult ENUMERATED { success (0), -- results are sorted operationsError (1), -- server internal failure timeLimitExceeded (3), -- timelimit reached before -- sorting was completed strongAuthRequired (8), -- refused to return sorted -- results via insecure -- protocol adminLimitExceeded (11), -- too many matching entries -- for the server to sort noSuchAttribute (16), -- unrecognized attribute -- type in sort key inappropriateMatching (18), -- unrecognized or inappro- -- priate matching rule in -- sort key insufficientAccessRights (50), -- refused to return sorted -- results to this client busy (51), -- too busy to process unwillingToPerform (53), -- unable to sort other (80) }, attributeType [0] AttributeType OPTIONAL }
SortControl
,
Serialized FormField Summary | |
---|---|
private java.lang.String |
badAttrId
The ID of the attribute that caused the sort to fail. |
static java.lang.String |
OID
The server-side sort response control's assigned object identifier is 1.2.840.113556.1.4.474. |
private int |
resultCode
The sort result code. |
private static long |
serialVersionUID
|
Fields inherited from class com.sun.jndi.ldap.BasicControl |
---|
criticality, id, value |
Fields inherited from interface javax.naming.ldap.Control |
---|
CRITICAL, NONCRITICAL |
Constructor Summary | |
---|---|
SortResponseControl(java.lang.String id,
boolean criticality,
byte[] value)
Constructs a new instance of SortResponseControl. |
Method Summary | |
---|---|
java.lang.String |
getAttributeID()
Retrieves the ID of the attribute that caused the sort to fail. |
javax.naming.NamingException |
getException()
Retrieves the NamingException appropriate for the result code. |
int |
getResultCode()
Retrieves the LDAP result code of the sort operation. |
boolean |
isSorted()
Determines if the search results have been successfully sorted. |
Methods inherited from class com.sun.jndi.ldap.BasicControl |
---|
getEncodedValue, getID, isCritical |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String OID
private int resultCode
private java.lang.String badAttrId
private static final long serialVersionUID
Constructor Detail |
---|
public SortResponseControl(java.lang.String id, boolean criticality, byte[] value) throws java.io.IOException
id
- The control's object identifier string.criticality
- The control's criticality.value
- The control's ASN.1 BER encoded value.
May be null.
java.io.IOException
- if an error is encountered
while decoding the control's value.Method Detail |
---|
public boolean isSorted()
public int getResultCode()
public java.lang.String getAttributeID()
public javax.naming.NamingException getException()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |