com.unboundid.ldap.sdk.unboundidds.controls
Class GetBackendSetIDRequestControl

java.lang.Object
  extended by com.unboundid.ldap.sdk.Control
      extended by com.unboundid.ldap.sdk.unboundidds.controls.GetBackendSetIDRequestControl
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class GetBackendSetIDRequestControl
extends Control

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
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.

This control may be used for a number of different kinds of requests, including: 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:
GetBackendSetIDResponseControl, RouteToBackendSetRequestControl, Serialized Form

Field Summary
static java.lang.String GET_BACKEND_SET_ID_REQUEST_OID
          The OID (1.3.6.1.4.1.30221.2.5.33) for the get backend set ID request control.
 
Constructor Summary
GetBackendSetIDRequestControl()
          Creates a new get backend set ID request control.
GetBackendSetIDRequestControl(boolean isCritical)
          Creates a new get backend set ID request control with the specified criticality.
GetBackendSetIDRequestControl(Control control)
          Creates a new get backend set ID request control which is decoded from the provided generic control.
 
Method Summary
 java.lang.String getControlName()
          Retrieves the user-friendly name for this control, if available.
 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, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

GET_BACKEND_SET_ID_REQUEST_OID

public static final java.lang.String GET_BACKEND_SET_ID_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.33) for the get backend set ID request control.

See Also:
Constant Field Values
Constructor Detail

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(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 Detail

getControlName

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 class Control
Returns:
The user-friendly name for this control, or the OID if no user-friendly name is available.

toString

public void toString(java.lang.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.