Class AbortedTransactionExtendedResult

    • Constructor Detail

      • AbortedTransactionExtendedResult

        public AbortedTransactionExtendedResult​(@NotNull
                                                ASN1OctetString transactionID,
                                                @NotNull
                                                ResultCode resultCode,
                                                @Nullable
                                                java.lang.String diagnosticMessage,
                                                @Nullable
                                                java.lang.String matchedDN,
                                                @Nullable
                                                java.lang.String[] referralURLs,
                                                @Nullable
                                                Control[] controls)
        Creates a new instance of this aborted transaction extended result with the provided information.
        Parameters:
        transactionID - The transaction ID of the transaction that has been aborted. It must not be null.
        resultCode - The result code for this aborted transaction result. It must not be null.
        diagnosticMessage - The diagnostic message for this aborted transaction result. It may be null if there is no diagnostic message.
        matchedDN - The matched DN for this aborted transaction result. It may be null if there is no matched DN.
        referralURLs - The referral URLs for this aborted transaction result. It may be null or empty if there are no referral URLs.
        controls - The controls for this aborted transaction result. It may be null or empty if there are no controls.
      • AbortedTransactionExtendedResult

        public AbortedTransactionExtendedResult​(@NotNull
                                                ExtendedResult extendedResult)
                                         throws LDAPException
        Creates a new instance of this aborted transaction extended result from the provided generic extended result.
        Parameters:
        extendedResult - The extended result to use to create this aborted transaction extended result.
        Throws:
        LDAPException - If the provided extended result cannot be decoded as an aborted transaction extended result.
    • Method Detail

      • getTransactionID

        @NotNull
        public ASN1OctetString getTransactionID()
        Retrieves the transaction ID of the transaction that has been aborted.
        Returns:
        The transaction ID of the transaction that has been aborted.
      • getExtendedResultName

        @NotNull
        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​(@NotNull
                             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.