|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.ExtendedRequest
com.unboundid.ldap.sdk.unboundidds.extensions.GetConnectionIDExtendedRequest
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetConnectionIDExtendedRequest
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 an implementation of the get connection ID extended operation as used in the UnboundID Directory Server. It may be used to obtain the connection ID associated with the current connection. This is primarily useful for debugging purposes, and the
IntermediateClientRequestControl
may also be used to obtain this
(along with other information).
GetConnectionIDExtendedResult result = (GetConnectionIDExtendedResult) connection.processExtendedOperation( new GetConnectionIDExtendedRequest()); // NOTE: The processExtendedOperation method will generally only throw an // exception if a problem occurs while trying to send the request or read // the response. It will not throw an exception because of a non-success // response. if (result.getResultCode() == ResultCode.SUCCESS) { long connectionID = result.getConnectionID(); }
Field Summary | |
---|---|
static java.lang.String |
GET_CONNECTION_ID_REQUEST_OID
The OID (1.3.6.1.4.1.30221.1.6.2) for the get connection ID extended request. |
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE |
Constructor Summary | |
---|---|
GetConnectionIDExtendedRequest()
Creates a new get connection ID extended request with no controls. |
|
GetConnectionIDExtendedRequest(Control[] controls)
Creates a new get connection ID extended request with the provided set of controls. |
|
GetConnectionIDExtendedRequest(ExtendedRequest extendedRequest)
Creates a new get connection ID extended request from the provided generic extended request. |
Method Summary | |
---|---|
GetConnectionIDExtendedRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
GetConnectionIDExtendedRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. |
java.lang.String |
getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available. |
GetConnectionIDExtendedResult |
process(LDAPConnection connection,
int depth)
Sends this extended request to the directory server over the provided connection and returns the associated response. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer. |
Methods inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
encodeProtocolOp, getLastMessageID, getOID, getOperationType, getProtocolOpType, getValue, hasValue, responseReceived, writeTo |
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest |
---|
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setResponseTimeoutMillis, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String GET_CONNECTION_ID_REQUEST_OID
Constructor Detail |
---|
public GetConnectionIDExtendedRequest()
public GetConnectionIDExtendedRequest(Control[] controls)
controls
- The set of controls to include in the request.public GetConnectionIDExtendedRequest(ExtendedRequest extendedRequest) throws LDAPException
extendedRequest
- The generic extended request to use to create this
get connection ID extended request.
LDAPException
- If a problem occurs while decoding the request.Method Detail |
---|
public GetConnectionIDExtendedResult process(LDAPConnection connection, int depth) throws LDAPException
process
in class ExtendedRequest
connection
- The connection to use to communicate with the directory
server.depth
- The current referral depth for this request. It should
always be one for the initial request, and should only
be incremented when following referrals.
LDAPException
- If a problem occurs while sending the request or
reading the response.public GetConnectionIDExtendedRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
public GetConnectionIDExtendedRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
controls
- The set of controls to include in the duplicate request.
public java.lang.String getExtendedRequestName()
getExtendedRequestName
in class ExtendedRequest
public void toString(java.lang.StringBuilder buffer)
toString
in interface ProtocolOp
toString
in interface ReadOnlyLDAPRequest
toString
in class ExtendedRequest
buffer
- The buffer to which to append a string representation of
this request.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |