Class GetServerIDRequestControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.unboundidds.controls.GetServerIDRequestControl
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetServerIDRequestControl extends Control
This class provides a request control which may be used to request the server ID of the server that actually processed the associated request. It may be used for requests sent directly to a Directory Server, but it is more useful when the request will pass through a Directory Proxy Server instance because the correspondingGetServerIDResponseControl
will provide the server ID of the backend server used to process the request. This server ID may be used in aRouteToServerRequestControl
instance to request that subsequent operations be processed by the same server. See the documentation for theRouteToServerRequestControl
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.
This control does not have a value. The criticality may be eithertrue
orfalse
.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field 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 Summary
Constructors Constructor 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.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.-
Methods inherited from class com.unboundid.ldap.sdk.Control
decode, decode, decodeControls, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
-
-
-
-
Field Detail
-
GET_SERVER_ID_REQUEST_OID
@NotNull public static final 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.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
GetServerIDRequestControl
public GetServerIDRequestControl()
Creates a new get server ID request control. It will not be marked critical.
-
GetServerIDRequestControl
public GetServerIDRequestControl(boolean isCritical)
Creates a new get server ID request control with the specified criticality.- Parameters:
isCritical
- Indicates whether this control should be marked critical.
-
GetServerIDRequestControl
public GetServerIDRequestControl(@NotNull Control control) throws LDAPException
Creates a new get server ID request control which is decoded from the provided generic control.- Parameters:
control
- The generic control to be decoded as a get server ID request control.- Throws:
LDAPException
- If the provided control cannot be decoded as a get server ID request control.
-
-
Method Detail
-
getControlName
@NotNull public java.lang.String getControlName()
Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.- Overrides:
getControlName
in classControl
- Returns:
- The user-friendly name for this control, or the OID if no user-friendly name is available.
-
toJSONControl
@NotNull public JSONObject toJSONControl()
Retrieves a representation of this get server ID request control as a JSON object. The JSON object uses the following fields (note that since this control does not have a value, neither thevalue-base64
norvalue-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, theoid
field should be used to identify the type of control. -
criticality
-- A mandatory Boolean field used to indicate whether this control is considered critical.
- Overrides:
toJSONControl
in classControl
- Returns:
- A JSON object that contains a representation of this control.
-
-
decodeJSONControl
@NotNull public static GetServerIDRequestControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
Attempts to decode the provided object as a JSON representation of a get server ID request control.- Parameters:
controlObject
- The JSON object to be decoded. It must not benull
.strict
- Indicates whether to use strict mode when decoding the provided JSON object. If this istrue
, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this isfalse
, then unrecognized fields will be ignored.- Returns:
- The get server ID request control that was decoded from the provided JSON object.
- Throws:
LDAPException
- If the provided JSON object cannot be parsed as a valid get server ID request control.
-
-