Package com.unboundid.ldap.sdk.unboundidds.extensions

Class GetConnectionIDExtendedResult

java.lang.Object
com.unboundid.ldap.sdk.LDAPResult
com.unboundid.ldap.sdk.ExtendedResult
com.unboundid.ldap.sdk.unboundidds.extensions.GetConnectionIDExtendedResult
All Implemented Interfaces:
LDAPResponse, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetConnectionIDExtendedResult extends ExtendedResult
This class implements a data structure for storing the information from an extended result for the get connection ID extended request. It is able to decode a generic extended result to obtain the associated connection ID.
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.

This extended result does not have an OID. If the request was processed successfully by the server, then the response should have a value that is the BER-encoded integer representation of the connection ID.
See Also:

  • Constructor Details

    • GetConnectionIDExtendedResult

      public GetConnectionIDExtendedResult(@NotNull ExtendedResult extendedResult) throws LDAPException
      Creates a new get connection ID extended result from the provided generic extended result.
      Parameters:
      extendedResult - The generic extended result to be decoded.
      Throws:
      LDAPException - If a problem occurs while attempting to decode the provided extended result as a get connection ID result.

    • GetConnectionIDExtendedResult

      public GetConnectionIDExtendedResult(int messageID, @NotNull ResultCode resultCode, @Nullable String diagnosticMessage, @Nullable String matchedDN, @Nullable String[] referralURLs, @Nullable Long connectionID, @Nullable Control[] responseControls)
      Creates a get connection ID extended result with the provided information.
      Parameters:
      messageID - The message ID for the LDAP message that is associated with this LDAP result.
      resultCode - The result code from the response.
      diagnosticMessage - The diagnostic message from the response, if available.
      matchedDN - The matched DN from the response, if available.
      referralURLs - The set of referral URLs from the response, if available.
      connectionID - The connection ID for the response.
      responseControls - The set of controls from the response, if available.

  • Method Details

    • getConnectionID

      public long getConnectionID()
      Retrieves the connection ID from this response.
      Returns:
      The connection ID from this response, or -1 if the connection ID is not available for some reason (e.g., because this is an error response).

    • getExtendedResultName

      @NotNull public String getExtendedResultName()
      Retrieves the user-friendly name for the extended result, if available. If no user-friendly name has been defined, but a response OID is available, then that will be returned. If neither a user-friendly name nor a response OID are available, then null will be returned.
      Overrides:
      getExtendedResultName in class ExtendedResult
      Returns:
      The user-friendly name for this extended request, the response OID if a user-friendly name is not available but a response OID is, or null if neither a user-friendly name nor a response OID are available.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this extended response to the provided buffer.
      Specified by:
      toString in interface LDAPResponse
      Overrides:
      toString in class ExtendedResult
      Parameters:
      buffer - The buffer to which a string representation of this extended response will be appended.