|
|||||||||
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.GetServerIDRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetServerIDRequestControl
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 the server ID of the server that actually processed the associated request. It may be used for requests sent directly to a Directory Server, but it is more useful when the request will pass through a Directory Proxy Server instance because the corresponding
GetServerIDResponseControl
will provide the server
ID of the backend server used to process the request. This server ID may be
used in a RouteToServerRequestControl
instance to request that
subsequent operations be processed by the same server. See the documentation
for the RouteToServerRequestControl
for an example that demonstrates
this.
true
or false
.
Field Summary | |
---|---|
static java.lang.String |
GET_SERVER_ID_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.14) for the get server ID request control. |
Constructor Summary | |
---|---|
GetServerIDRequestControl()
Creates a new get server ID request control. |
|
GetServerIDRequestControl(boolean isCritical)
Creates a new get server ID request control with the specified criticality. |
|
GetServerIDRequestControl(Control control)
Creates a new get server 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 |
---|
public static final java.lang.String GET_SERVER_ID_REQUEST_OID
Constructor Detail |
---|
public GetServerIDRequestControl()
public GetServerIDRequestControl(boolean isCritical)
isCritical
- Indicates whether this control should be marked
critical.public GetServerIDRequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as a get server ID
request control.
LDAPException
- If the provided control cannot be decoded as a get
server ID request control.Method Detail |
---|
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 |