com.novell.ldap.controls
Class LDAPSortResponse
java.lang.Object
com.novell.ldap.LDAPControl
com.novell.ldap.controls.LDAPSortResponse
- All Implemented Interfaces:
- java.io.Externalizable, java.io.Serializable, java.lang.Cloneable
public class LDAPSortResponse
- extends LDAPControl
LDAPSortResponse - will be added in newer version of LDAP
Controls draft-- add descritption from draft here.
- See Also:
- Serialized Form
Constructor Summary |
LDAPSortResponse(java.lang.String oid,
boolean critical,
byte[] values)
This constructor is usually called by the SDK to instantiate an
a LDAPControl corresponding to the Server response to a LDAP
Sort Control request. |
Method Summary |
java.lang.String |
getFailedAttribute()
If not null, this returns the attribute that caused the sort
operation to fail. |
int |
getResultCode()
Returns the result code from the sort |
Methods inherited from class com.novell.ldap.LDAPControl |
clone, getID, getValue, isCritical, readDSML, readExternal, register, setValue, toString, writeDSML, writeExternal |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
failedAttribute
private java.lang.String failedAttribute
resultCode
private int resultCode
LDAPSortResponse
public LDAPSortResponse(java.lang.String oid,
boolean critical,
byte[] values)
throws java.io.IOException
- This constructor is usually called by the SDK to instantiate an
a LDAPControl corresponding to the Server response to a LDAP
Sort Control request. Application programmers should not have
any reason to call the constructor. This constructor besides
constructing a LDAPControl object parses the contents of the response
control.
RFC 2891 defines this response control as follows:
The controlValue is an OCTET STRING, whose
value is the BER encoding of a value of the following SEQUENCE:
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
-- inappropriate 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] AttributeDescription OPTIONAL }
- Parameters:
oid
- The OID of the control, as a dotted string.
critical
- True if the LDAP operation should be discarded if
the control is not supported. False if
the operation can be processed without the control.
values
- The control-specific data.
- Throws:
java.io.IOException
getFailedAttribute
public java.lang.String getFailedAttribute()
- If not null, this returns the attribute that caused the sort
operation to fail.
getResultCode
public int getResultCode()
- Returns the result code from the sort
Copyright ? 2002 Novell, Inc. All Rights Reserved.
Novell, Inc.
1800 South Novell Place
Provo, Ut 84606
Phone: (801) 861-5000