@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ServerSideSortResponseControl extends Control implements DecodeableControl
ServerSideSortRequestControl
, then the search result done message
may include this response control to provide information about the state of
the sorting.Modifier and Type | Field and Description |
---|---|
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 and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo
public static final java.lang.String SERVER_SIDE_SORT_RESPONSE_OID
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.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