Package com.unboundid.ldap.sdk.unboundidds.controls

Class GetServerIDRequestControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.GetServerIDRequestControl
All Implemented Interfaces:
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 corresponding 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.

This control does not have a value. The criticality may be either true or false.
See Also:

  • Field Details

  • Constructor Details

    • 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 Details

    • getControlName

      @NotNull public 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 class Control
      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 the 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.
      Overrides:
      toJSONControl in class Control
      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 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.
      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.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this LDAP control to the provided buffer.
      Overrides:
      toString in class Control
      Parameters:
      buffer - The buffer to which to append the string representation of this buffer.