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

Class GetBackendSetIDRequestControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.GetBackendSetIDRequestControl
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetBackendSetIDRequestControl extends Control
This class provides a request control which may be used to request that the Directory Proxy Server return the backend set IDs for the entry-balancing backend set(s) in which an operation was processed successfully. It may be used in conjunction with the route to backend set request control in order to specify which backend set(s) should be used to process an operation.
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 may be used for a number of different kinds of requests, including:
  • If an add request includes a get backend set ID request control, the add response will include a get backend set ID response control if the entry was successfully added to an entry-balanced data set.
  • If a simple bind request includes a get backend set ID request control, the bind response will include a get backend set ID response control if the authentication was successful and the entry for the authenticated user exists in an entry-balanced data set. This control is currently not supported for use with SASL bind operations.
  • If a compare request includes a get backend set ID request control, the compare response will include a get backend set ID response control if the result code is either COMPARE_TRUE or COMPARE_FALSE and the target entry exists in an entry-balanced data set.
  • If a delete request includes a get backend set ID request control, the delete response will include a get backend set ID response control if the entry was successfully removed from an entry-balanced data set.
  • If an atomic multi-update extended request includes a get backend set ID request control and the request is successfully processed through an entry-balancing request processor, then the extended response will include a get backend set ID response control. A non-atomic multi-update extended request should not include the get backend set ID request control in the extended operation itself, but may be attached to any or all of the requests inside the multi-update operation, in which case the server will return a multi-update response control attached to the corresponding successful responses.
  • If an extended request includes a get backend set ID request control and that request is successfully processed by a proxied extended operation handler, then the extended response will include a get backend set ID response control indicating the backend set(s) that returned a success result during internal processing. Note that if the same extended request was processed by multiple entry-balancing request processors (i.e., if the deployment includes multiple entry-balanced subtrees), then the extended response may include a separate get backend set ID response control for each entry-balancing request processor used to process the request.
  • If a modify request includes a get backend set ID request control, the modify response will include a get backend set ID response control if the entry was successfully modified in an entry-balanced data set.
  • If a modify DN request includes a get backend set ID request control, the modify DN response will include a get backend set ID response control if the entry was successfully moved and/or renamed in an entry-balanced data set.
  • If a modify DN request includes a get backend set ID request control, the modify DN response will include a get backend set ID response control if the entry was successfully moved and/or renamed in an entry-balanced data set.
  • If a search request includes a get backend set ID request control, any search result entries retrieved from an entry-balanced data set will include a get backend set ID response control. The search result done message will not include a get backend set ID response control.
Note the response for any operation involving an entry that exists outside of an entry-balanced dat set will not include a get backend set ID response control. Similarly, the response for any non-successful operation may not include a get backend set ID response control even if it involved processing in one or more backend sets. Also note that even if an entry exists in multiple backend sets (i.e., because it is at or above the balancing point), the get backend set ID response control may only include one backend set ID if only one backend set was accessed during the course of processing the operation.

The get backend set ID request control has an OID of "1.3.6.1.4.1.30221.2.5.33" and no value. It is recommended that the control be non-critical so that the associated operation may still be processed even if the target server does not support this control (and note that even if the server supports the control, the server may not return a response control if the operation was not successful or did not access entry-balanced data).
See Also:

  • Field Details

  • Constructor Details

    • GetBackendSetIDRequestControl

      public GetBackendSetIDRequestControl()
      Creates a new get backend set ID request control. It will not be marked critical.

    • GetBackendSetIDRequestControl

      public GetBackendSetIDRequestControl(boolean isCritical)
      Creates a new get backend set ID request control with the specified criticality.
      Parameters:
      isCritical - Indicates whether this control should be marked critical.

    • GetBackendSetIDRequestControl

      public GetBackendSetIDRequestControl(@NotNull Control control) throws LDAPException
      Creates a new get backend set ID request control which is decoded from the provided generic control.
      Parameters:
      control - The generic control to be decoded as a get backend set ID request control.
      Throws:
      LDAPException - If the provided control cannot be decoded as a get backend set 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 backend set 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 backend set ID request control, the OID is "1.3.6.1.4.1.30221.2.5.33".
      • 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 GetBackendSetIDRequestControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
      Attempts to decode the provided object as a JSON representation of a get backend set 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 backend set 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 backend set 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.