|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.GetBackendSetIDResponseControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetBackendSetIDResponseControl
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 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.
GET_BACKEND_SET_ID_RESPONSE_VALUE ::= SEQUENCE { entryBalancingRequestProcessorID OCTET STRING, backendSetIDs SET SIZE (1..MAX) OF OCTET STRING, ... }
GetBackendSetIDRequestControl
,
RouteToBackendSetRequestControl
,
Serialized FormField Summary | |
---|---|
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 | |
---|---|
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.util.Collection<java.lang.String> backendSetIDs)
Creates a new get backend set ID response control with the provided information. |
|
GetBackendSetIDResponseControl(java.lang.String entryBalancingRequestProcessorID,
java.lang.String backendSetID)
Creates a new get backend set ID response control with the provided information. |
Method Summary | |
---|---|
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 |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String GET_BACKEND_SET_ID_RESPONSE_OID
Constructor Detail |
---|
public GetBackendSetIDResponseControl(java.lang.String entryBalancingRequestProcessorID, java.lang.String backendSetID)
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
.public GetBackendSetIDResponseControl(java.lang.String entryBalancingRequestProcessorID, java.util.Collection<java.lang.String> backendSetIDs)
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.public GetBackendSetIDResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
oid
- The OID for the control.isCritical
- Indicates whether this control should be marked
critical.value
- The encoded value for the control.
LDAPException
- If a problem occurs while attempting to decode the
generic control as a get backend set ID response
control.Method Detail |
---|
public GetBackendSetIDResponseControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
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.
LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.public java.lang.String getEntryBalancingRequestProcessorID()
public java.util.Set<java.lang.String> getBackendSetIDs()
public static GetBackendSetIDResponseControl get(LDAPResult result) throws LDAPException
result
- The result from which to retrieve the get backend set ID
response control.
null
if the result did not contain a get
backend set ID response control.
LDAPException
- If a problem is encountered while attempting to
decode the get backend set ID response control
contained in the provided result.public static GetBackendSetIDResponseControl get(SearchResultEntry entry) throws LDAPException
entry
- The entry from which to retrieve the get backend set ID
response control.
null
if the entry did not contain a get backend
set ID response control.
LDAPException
- If a problem is encountered while attempting to
decode the get backend set ID response control
contained in the provided result.public static java.util.List<GetBackendSetIDResponseControl> get(ExtendedResult result) throws LDAPException
result
- The extended result from which to retrieve the get backend
set ID response control(s).
LDAPException
- If a problem is encountered while attempting to
decode the any backend set ID response control
contained in the provided result.public java.lang.String getControlName()
getControlName
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which to append the string representation of
this buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |