Class InteractiveTransactionAbortedExtendedResult

  • All Implemented Interfaces:
    LDAPResponse, java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class InteractiveTransactionAbortedExtendedResult
    extends ExtendedResult
    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.
    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.
    See Also:
    Serialized Form
    • Constructor Detail

      • 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.
    • Method Detail

      • 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.