com.unboundid.ldap.sdk.unboundidds.extensions
Class GetConnectionIDExtendedRequest

java.lang.Object
  extended by com.unboundid.ldap.sdk.LDAPRequest
      extended by com.unboundid.ldap.sdk.ExtendedRequest
          extended by com.unboundid.ldap.sdk.unboundidds.extensions.GetConnectionIDExtendedRequest
All Implemented Interfaces:
ProtocolOp, ReadOnlyLDAPRequest, java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class GetConnectionIDExtendedRequest
extends ExtendedRequest

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).

Example

The following example demonstrates the process for using the get connection ID extended operation:
 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();
 }
 

See Also:
Serialized Form

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

GET_CONNECTION_ID_REQUEST_OID

public static final 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.

See Also:
Constant Field Values
Constructor Detail

GetConnectionIDExtendedRequest

public GetConnectionIDExtendedRequest()
Creates a new get connection ID extended request with no controls.


GetConnectionIDExtendedRequest

public GetConnectionIDExtendedRequest(Control[] controls)
Creates a new get connection ID extended request with the provided set of controls.

Parameters:
controls - The set of controls to include in the request.

GetConnectionIDExtendedRequest

public GetConnectionIDExtendedRequest(ExtendedRequest extendedRequest)
                               throws LDAPException
Creates a new get connection ID extended request from the provided generic extended request.

Parameters:
extendedRequest - The generic extended request to use to create this get connection ID extended request.
Throws:
LDAPException - If a problem occurs while decoding the request.
Method Detail

process

public GetConnectionIDExtendedResult process(LDAPConnection connection,
                                             int depth)
                                      throws LDAPException
Sends this extended request to the directory server over the provided connection and returns the associated response.

Overrides:
process in class ExtendedRequest
Parameters:
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.
Returns:
An LDAP result object that provides information about the result of the extended operation processing.
Throws:
LDAPException - If a problem occurs while sending the request or reading the response.

duplicate

public GetConnectionIDExtendedRequest duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.. Subclasses should override this method to return a duplicate of the appropriate type.

Specified by:
duplicate in interface ReadOnlyLDAPRequest
Overrides:
duplicate in class ExtendedRequest
Returns:
A new instance of this LDAP request that may be modified without impacting this request.

duplicate

public GetConnectionIDExtendedRequest duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. The provided controls will be used for the new request instead of duplicating the controls from this request.. Subclasses should override this method to return a duplicate of the appropriate type.

Specified by:
duplicate in interface ReadOnlyLDAPRequest
Overrides:
duplicate in class ExtendedRequest
Parameters:
controls - The set of controls to include in the duplicate request.
Returns:
A new instance of this LDAP request that may be modified without impacting this request.

getExtendedRequestName

public java.lang.String getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available. If no user-friendly name has been defined, then the OID will be returned.

Overrides:
getExtendedRequestName in class ExtendedRequest
Returns:
The user-friendly name for this extended request, or the OID if no user-friendly name is available.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.

Specified by:
toString in interface ProtocolOp
Specified by:
toString in interface ReadOnlyLDAPRequest
Overrides:
toString in class ExtendedRequest
Parameters:
buffer - The buffer to which to append a string representation of this request.