Class GetBackendSetIDResponseControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.unboundidds.controls.GetBackendSetIDResponseControl
-
- All Implemented Interfaces:
DecodeableControl
,java.io.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 theGetBackendSetIDRequestControl
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, ... }
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
GET_BACKEND_SET_ID_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.5.34) for the get backend set ID response control.
-
Constructor Summary
Constructors Constructor Description GetBackendSetIDResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value)
Creates a new get backend set ID response control decoded from the given generic control contents.GetBackendSetIDResponseControl(java.lang.String entryBalancingRequestProcessorID, java.lang.String backendSetID)
Creates a new get backend set ID response control with the provided information.GetBackendSetIDResponseControl(java.lang.String entryBalancingRequestProcessorID, java.util.Collection<java.lang.String> backendSetIDs)
Creates a new get backend set ID response control with the provided information.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description GetBackendSetIDResponseControl
decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value)
Creates a new instance of this decodeable control from the provided information.static java.util.List<GetBackendSetIDResponseControl>
get(ExtendedResult result)
Extracts any get backend set ID response controls from the provided extended result.static GetBackendSetIDResponseControl
get(LDAPResult result)
Extracts a get backend set ID response control from the provided result.static GetBackendSetIDResponseControl
get(SearchResultEntry entry)
Extracts a get backend set ID response control from the provided search result entry.java.util.Set<java.lang.String>
getBackendSetIDs()
Retrieves the backend set IDs for the backend sets used during processing.java.lang.String
getControlName()
Retrieves the user-friendly name for this control, if available.java.lang.String
getEntryBalancingRequestProcessorID()
Retrieves the identifier for the entry-balancing request processor with which the backend sets IDs are associated.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
-
-
-
-
Field Detail
-
GET_BACKEND_SET_ID_RESPONSE_OID
public static final java.lang.String GET_BACKEND_SET_ID_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.5.34) for the get backend set ID response control.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
GetBackendSetIDResponseControl
public GetBackendSetIDResponseControl(java.lang.String entryBalancingRequestProcessorID, java.lang.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 benull
.backendSetID
- The backend set ID for the backend set used during processing. It must not benull
.
-
GetBackendSetIDResponseControl
public GetBackendSetIDResponseControl(java.lang.String entryBalancingRequestProcessorID, java.util.Collection<java.lang.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 benull
.backendSetIDs
- The backend set IDs for backend sets used during processing. It must not benull
or empty.
-
GetBackendSetIDResponseControl
public GetBackendSetIDResponseControl(java.lang.String oid, boolean isCritical, 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 Detail
-
decodeControl
public GetBackendSetIDResponseControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
Creates a new instance of this decodeable control from the provided information.- Specified by:
decodeControl
in interfaceDecodeableControl
- 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 benull
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
public java.lang.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
public java.util.Set<java.lang.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
public static GetBackendSetIDResponseControl get(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
public static GetBackendSetIDResponseControl get(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
public static java.util.List<GetBackendSetIDResponseControl> get(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
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.
-
-