|
|||||||||
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.extensions.StartTransactionExtendedResult
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class StartTransactionExtendedResult
This class implements a data structure for storing the information from an
extended result for the start transaction extended request, as defined in
RFC 5805. It is able to
decode a generic extended result to extract the transaction ID that it
contains, if the operation was successful.
See the documentation for the StartTransactionExtendedRequest
class
for an example that demonstrates the use of LDAP transactions.
Field Summary |
---|
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse |
---|
NO_CONTROLS |
Constructor Summary | |
---|---|
StartTransactionExtendedResult(ExtendedResult extendedResult)
Creates a new start transaction extended result from the provided extended result. |
|
StartTransactionExtendedResult(int messageID,
ResultCode resultCode,
java.lang.String diagnosticMessage,
java.lang.String matchedDN,
java.lang.String[] referralURLs,
ASN1OctetString transactionID,
Control[] responseControls)
Creates a new start transaction extended result with the provided information. |
Method Summary | |
---|---|
java.lang.String |
getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available. |
ASN1OctetString |
getTransactionID()
Retrieves the transaction ID for this start transaction extended result, if available. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this extended result 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, getResultString, hasResponseControl, hasResponseControl |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public StartTransactionExtendedResult(ExtendedResult extendedResult)
extendedResult
- The extended result to be decoded as a start
transaction extended result. It must not be
null
.public StartTransactionExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, ASN1OctetString transactionID, 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.transactionID
- The transaction ID for this response, if
available.responseControls
- The set of controls from the response, if
available.Method Detail |
---|
public ASN1OctetString getTransactionID()
null
if none was provided.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 result will be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |