|
|||||||||
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.StartInteractiveTransactionExtendedResult
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class StartInteractiveTransactionExtendedResult
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 start interactive transaction extended request. It is able to decode a generic extended result to extract the transaction ID and base DNs that it may contain, if the operation was successful.
StartInteractiveTransactionExtendedRequest
class for an example that
demonstrates the use of interactive transactions.
Field Summary |
---|
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse |
---|
NO_CONTROLS |
Constructor Summary | |
---|---|
StartInteractiveTransactionExtendedResult(ExtendedResult extendedResult)
Creates a new start interactive transaction extended result from the provided extended result. |
|
StartInteractiveTransactionExtendedResult(int messageID,
ResultCode resultCode,
java.lang.String diagnosticMessage,
java.lang.String matchedDN,
java.lang.String[] referralURLs,
ASN1OctetString transactionID,
java.util.List<java.lang.String> baseDNs,
Control[] responseControls)
Creates a new start interactive transaction extended result with the provided information. |
Method Summary | |
---|---|
java.util.List<java.lang.String> |
getBaseDNs()
Retrieves the list of base DNs for this start interactive transaction extended result, if available. |
java.lang.String |
getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available. |
ASN1OctetString |
getTransactionID()
Retrieves the transaction ID for this start interactive transaction 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 StartInteractiveTransactionExtendedResult(ExtendedResult extendedResult) throws LDAPException
extendedResult
- The extended result to be decoded as a start
interactive transaction extended result. It must
not be null
.
LDAPException
- If a problem occurs while attempting to decode the
provided extended result as a start interactive
transaction extended result.public StartInteractiveTransactionExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, ASN1OctetString transactionID, java.util.List<java.lang.String> baseDNs, 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.baseDNs
- The list of base DNs 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.util.List<java.lang.String> getBaseDNs()
null
if no base DN list 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 response will be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |