|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPResult
com.unboundid.ldap.sdk.ExtendedResult
com.unboundid.ldap.sdk.unboundidds.extensions.GetConnectionIDExtendedResult
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetConnectionIDExtendedResult
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 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.
Field Summary |
---|
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse |
---|
NO_CONTROLS |
Constructor Summary | |
---|---|
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 | |
---|---|
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, getReferralURLs, getResponseControl, getResponseControls, getResultCode, hasResponseControl, hasResponseControl |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public GetConnectionIDExtendedResult(ExtendedResult extendedResult) throws LDAPException
extendedResult
- The generic extended result to be decoded.
LDAPException
- If a problem occurs while attempting to decode the
provided extended result as a get connection ID
result.public GetConnectionIDExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.lang.Long connectionID, Control[] responseControls)
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 |
---|
public long getConnectionID()
public java.lang.String getExtendedResultName()
null
will be returned.
getExtendedResultName
in class ExtendedResult
null
if neither a user-friendly name nor a response OID
are available.public void toString(java.lang.StringBuilder buffer)
toString
in interface LDAPResponse
toString
in class ExtendedResult
buffer
- The buffer to which a string representation of this
extended response will be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |