com.unboundid.ldap.sdk.unboundidds.extensions
Class InteractiveTransactionAbortedExtendedResult
java.lang.Object
com.unboundid.ldap.sdk.LDAPResult
com.unboundid.ldap.sdk.ExtendedResult
com.unboundid.ldap.sdk.unboundidds.extensions.InteractiveTransactionAbortedExtendedResult
- All Implemented Interfaces:
- LDAPResponse, java.io.Serializable
@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class InteractiveTransactionAbortedExtendedResult
- extends ExtendedResult
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 provides an implementation of the interactive transaction aborted
extended result, which is used as an unsolicited notification to indicate
that the server has aborted an interactive transaction without the client's
explicit request.
- See Also:
- Serialized Form
Method Summary |
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 result to the provided
buffer. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
INTERACTIVE_TRANSACTION_ABORTED_RESULT_OID
public static final java.lang.String INTERACTIVE_TRANSACTION_ABORTED_RESULT_OID
- The OID (1.3.6.1.4.1.30221.2.6.5) for the interactive transaction aborted
extended result.
- See Also:
- Constant Field Values
InteractiveTransactionAbortedExtendedResult
public InteractiveTransactionAbortedExtendedResult(ExtendedResult extendedResult)
- Creates a new instance of this interactive transaction aborted extended
result from the provided generic extended result.
- Parameters:
extendedResult
- The extended result to use to create this
interactive transaction aborted extended result.
InteractiveTransactionAbortedExtendedResult
public InteractiveTransactionAbortedExtendedResult(int messageID,
ResultCode resultCode,
java.lang.String diagnosticMessage,
java.lang.String matchedDN,
java.lang.String[] referralURLs,
Control[] responseControls)
- Creates a new instance of this interactive transaction aborted extended
result from 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.responseControls
- The set of controls from the response, if
available.
getExtendedResultName
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(java.lang.StringBuilder buffer)
- Appends a string representation of this extended result 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 result will be appended.