@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetServerIDRequestControl extends Control
GetServerIDResponseControl
will provide the server
ID of the backend server used to process the request. This server ID may be
used in a RouteToServerRequestControl
instance to request that
subsequent operations be processed by the same server. See the documentation
for the RouteToServerRequestControl
for an example that demonstrates
this.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only
supported for use against Ping Identity, UnboundID, and
Nokia/Alcatel-Lucent 8661 server products. These classes provide support
for proprietary functionality or for external specifications that are not
considered stable or mature enough to be guaranteed to work in an
interoperable way with other types of LDAP servers.
true
or false
.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
GET_SERVER_ID_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.14) for the get server ID request control.
|
Constructor and Description |
---|
GetServerIDRequestControl()
Creates a new get server ID request control.
|
GetServerIDRequestControl(boolean isCritical)
Creates a new get server ID request control with the specified
criticality.
|
GetServerIDRequestControl(Control control)
Creates a new get server ID request control which is decoded from the
provided generic control.
|
Modifier and Type | Method and Description |
---|---|
static GetServerIDRequestControl |
decodeJSONControl(JSONObject controlObject,
boolean strict)
Attempts to decode the provided object as a JSON representation of a get
server ID request control.
|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available.
|
JSONObject |
toJSONControl()
Retrieves a representation of this get server ID request control as a JSON
object.
|
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided
buffer.
|
decode, decode, decodeControls, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
@NotNull public static final java.lang.String GET_SERVER_ID_REQUEST_OID
public GetServerIDRequestControl()
public GetServerIDRequestControl(boolean isCritical)
isCritical
- Indicates whether this control should be marked
critical.public GetServerIDRequestControl(@NotNull Control control) throws LDAPException
control
- The generic control to be decoded as a get server ID
request control.LDAPException
- If the provided control cannot be decoded as a get
server ID request control.@NotNull public java.lang.String getControlName()
getControlName
in class Control
@NotNull public JSONObject toJSONControl()
value-base64
nor
value-json
fields may be present):
oid
-- A mandatory string field whose value is the object
identifier for this control. For the get server ID request control,
the OID is "1.3.6.1.4.1.30221.2.5.14".
control-name
-- An optional string field whose value is a
human-readable name for this control. This field is only intended for
descriptive purposes, and when decoding a control, the oid
field should be used to identify the type of control.
criticality
-- A mandatory Boolean field used to indicate
whether this control is considered critical.
toJSONControl
in class Control
@NotNull public static GetServerIDRequestControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
controlObject
- The JSON object to be decoded. It must not be
null
.strict
- Indicates whether to use strict mode when decoding
the provided JSON object. If this is true
,
then this method will throw an exception if the
provided JSON object contains any unrecognized
fields. If this is false
, then unrecognized
fields will be ignored.LDAPException
- If the provided JSON object cannot be parsed as a
valid get server ID request control.