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

Class GetBackendSetIDResponseControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.GetBackendSetIDResponseControl
All Implemented Interfaces:
DecodeableControl, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetBackendSetIDResponseControl extends Control implements DecodeableControl
This class provides a response control that may be used to provide the backend set ID(s) for any relevant backend sets accessed during the course of processing an operation. It may be returned in response to a request containing either the get backend set ID request control or the route to backend set request control. For add, simple bind, compare, delete, modify, and modify DN operations, the LDAP result message for the operation may contain zero or one get backend set ID response control. For extended operations, the extended result message may contain zero, one, or multiple get backend set ID response controls. For search operations, each search result entry may contain zero or one get backend set ID response control, while the search result done message will not contain any such control. See the GetBackendSetIDRequestControl class documentation for a more complete description of the usage for these controls.
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.

The get backend set ID response control has an OID of "1.3.6.1.4.1.30221.2.5.34", a criticality of false, and a value with the following encoding: 
   GET_BACKEND_SET_ID_RESPONSE_VALUE ::= SEQUENCE {
     entryBalancingRequestProcessorID     OCTET STRING,
     backendSetIDs                        SET SIZE (1..MAX) OF OCTET STRING,
     ... }
See Also:

  • Field Details

  • Constructor Details

    • GetBackendSetIDResponseControl

      public GetBackendSetIDResponseControl(@NotNull String entryBalancingRequestProcessorID, @NotNull String backendSetID)
      Creates a new get backend set ID response control with the provided information.
      Parameters:
      entryBalancingRequestProcessorID - The identifier for the entry-balancing request processor with which the backend set IDs are associated. It must not be null.
      backendSetID - The backend set ID for the backend set used during processing. It must not be null.

    • GetBackendSetIDResponseControl

      public GetBackendSetIDResponseControl(@NotNull String entryBalancingRequestProcessorID, @NotNull Collection<String> backendSetIDs)
      Creates a new get backend set ID response control with the provided information.
      Parameters:
      entryBalancingRequestProcessorID - The identifier for the entry-balancing request processor with which the backend set IDs are associated. It must not be null.
      backendSetIDs - The backend set IDs for backend sets used during processing. It must not be null or empty.

    • GetBackendSetIDResponseControl

      public GetBackendSetIDResponseControl(@NotNull String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
      Creates a new get backend set ID response control decoded from the given generic control contents.
      Parameters:
      oid - The OID for the control.
      isCritical - Indicates whether this control should be marked critical.
      value - The encoded value for the control.
      Throws:
      LDAPException - If a problem occurs while attempting to decode the generic control as a get backend set ID response control.

  • Method Details

    • decodeControl

      @NotNull public GetBackendSetIDResponseControl decodeControl(@NotNull String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
      Creates a new instance of this decodeable control from the provided information.
      Specified by:
      decodeControl in interface DecodeableControl
      Parameters:
      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.
      Returns:
      The decoded representation of this control.
      Throws:
      LDAPException - If the provided information cannot be decoded as a valid instance of this decodeable control.

    • getEntryBalancingRequestProcessorID

      @NotNull public String getEntryBalancingRequestProcessorID()
      Retrieves the identifier for the entry-balancing request processor with which the backend sets IDs are associated.
      Returns:
      The identifier for the entry-balancing request processor with which the backend set IDs are associated.

    • getBackendSetIDs

      @NotNull public Set<String> getBackendSetIDs()
      Retrieves the backend set IDs for the backend sets used during processing.
      Returns:
      The backend set IDs for the backend sets used during processing.

    • get

      @Nullable public static GetBackendSetIDResponseControl get(@NotNull LDAPResult result) throws LDAPException
      Extracts a get backend set ID response control from the provided result.
      Parameters:
      result - The result from which to retrieve the get backend set ID response control.
      Returns:
      The get backend set ID response control contained in the provided result, or null if the result did not contain a get backend set ID response control.
      Throws:
      LDAPException - If a problem is encountered while attempting to decode the get backend set ID response control contained in the provided result.

    • get

      @Nullable public static GetBackendSetIDResponseControl get(@NotNull SearchResultEntry entry) throws LDAPException
      Extracts a get backend set ID response control from the provided search result entry.
      Parameters:
      entry - The entry from which to retrieve the get backend set ID response control.
      Returns:
      The get backend set ID response control contained in the provided entry, or null if the entry did not contain a get backend set ID response control.
      Throws:
      LDAPException - If a problem is encountered while attempting to decode the get backend set ID response control contained in the provided result.

    • get

      @NotNull public static List<GetBackendSetIDResponseControl> get(@NotNull ExtendedResult result) throws LDAPException
      Extracts any get backend set ID response controls from the provided extended result.
      Parameters:
      result - The extended result from which to retrieve the get backend set ID response control(s).
      Returns:
      A list of get backend set ID response controls contained in the provided extended result, or an empty list if the result did not contain a get any backend set ID response controls.
      Throws:
      LDAPException - If a problem is encountered while attempting to decode the any backend set ID response control contained in the provided result.

    • 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 response control as a JSON object. The JSON object uses the following fields:
      • oid -- A mandatory string field whose value is the object identifier for this control. For the get backend set ID response control, the OID is "1.3.6.1.4.1.30221.2.5.34".
      • 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.
      • value-base64 -- An optional string field whose value is a base64-encoded representation of the raw value for this get backend set ID response control. Exactly one of the value-base64 and value-json fields must be present.
      • value-json -- An optional JSON object field whose value is a user-friendly representation of the value for this get backend set ID response control. Exactly one of the value-base64 and value-json fields must be present, and if the value-json field is used, then it will use the following fields:
        • request-processor-id -- A string field whose value is the name of the entry-balancing request processor with which the control is associated.
        • backend-set-ids -- An array field whose values are the string identifiers for the backend sets in which processing was performed for the associated entry.
      Overrides:
      toJSONControl in class Control
      Returns:
      A JSON object that contains a representation of this control.

    • decodeJSONControl

      @NotNull public static GetBackendSetIDResponseControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
      Attempts to decode the provided object as a JSON representation of a get backend set ID response 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 response 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 response 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.