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, java.io.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:

Serialized Form

Field Summary

Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse

NO_CONTROLS

Constructor Summary

Constructors

Constructor and Description
GetConnectionIDExtendedResult(ExtendedResult extendedResult) Creates a new get connection ID extended result from the provided generic extended result.
GetConnectionIDExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.lang.Long connectionID, Control[] responseControls) Creates a get connection ID extended result with the provided information.

Method Summary

Modifier and Type	Method and Description
long	getConnectionID() Retrieves the connection ID from this response.
java.lang.String	getExtendedResultName() Retrieves the user-friendly name for the extended result, if available.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this extended response to the provided buffer.

Methods inherited from class com.unboundid.ldap.sdk.ExtendedResult

getOID, getValue, hasValue, toString

Methods inherited from class com.unboundid.ldap.sdk.LDAPResult

getDiagnosticMessage, getMatchedDN, getMessageID, getOperationType, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

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
                                     java.lang.String diagnosticMessage,
                                     @Nullable
                                     java.lang.String matchedDN,
                                     @Nullable
                                     java.lang.String[] referralURLs,
                                     @Nullable
                                     java.lang.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 Detail

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 java.lang.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
                     java.lang.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.