|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.controls.ServerSideSortResponseControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ServerSideSortResponseControl
This class provides an implementation of the server-side sort response
control, as defined in
RFC 2891. It may be used
to provide information about the result of server-side sort processing. If
the corresponding search request included the
ServerSideSortRequestControl
, then the search result done message
may include this response control to provide information about the state of
the sorting.
Field Summary | |
---|---|
static java.lang.String |
SERVER_SIDE_SORT_RESPONSE_OID
The OID (1.2.840.113556.1.4.474) for the server-side sort response control. |
Constructor Summary | |
---|---|
ServerSideSortResponseControl(ResultCode resultCode,
java.lang.String attributeName,
boolean isCritical)
Creates a new server-side sort response control with the provided information. |
|
ServerSideSortResponseControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new server-side sort response control from the information contained in the provided control. |
Method Summary | |
---|---|
ServerSideSortResponseControl |
decodeControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new instance of this decodeable control from the provided information. |
static ServerSideSortResponseControl |
get(SearchResult result)
Extracts a server-side sort response control from the provided result. |
java.lang.String |
getAttributeName()
Retrieves the attribute name for this server-side sort response control, if available. |
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available. |
ResultCode |
getResultCode()
Retrieves the result code for this server-side sort response control. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided buffer. |
Methods inherited from class com.unboundid.ldap.sdk.Control |
---|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SERVER_SIDE_SORT_RESPONSE_OID
Constructor Detail |
---|
public ServerSideSortResponseControl(ResultCode resultCode, java.lang.String attributeName, boolean isCritical)
resultCode
- The result code for this server-side sort response.attributeName
- The name of the attribute associated with this
result. It may be null
if there is no
associated attribute name.isCritical
- Indicates whether this control should be marked
critical.public ServerSideSortResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.
LDAPException
- If a problem occurs while attempting to decode the
provided control as a server-side sort response
control.Method Detail |
---|
public ServerSideSortResponseControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.
LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.public static ServerSideSortResponseControl get(SearchResult result) throws LDAPException
result
- The result from which to retrieve the server-side sort
response control.
null
if the result did not contain a
server-side sort response control.
LDAPException
- If a problem is encountered while attempting to
decode the server-side sort response control
contained in the provided result.public ResultCode getResultCode()
public java.lang.String getAttributeName()
null
if none was provided.public java.lang.String getControlName()
getControlName
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which to append the string representation of
this buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |