Class CollectSupportDataExtendedResult

    • Constructor Detail

      • CollectSupportDataExtendedResult

        public CollectSupportDataExtendedResult​(int messageID,
                                                @NotNull
                                                ResultCode resultCode,
                                                @Nullable
                                                java.lang.String diagnosticMessage,
                                                @Nullable
                                                java.lang.String matchedDN,
                                                @Nullable
                                                java.lang.String[] referralURLs,
                                                @Nullable
                                                java.lang.Integer exitCode,
                                                @Nullable
                                                Control... controls)
        Creates a new collect support data extended result with the provided information.
        Parameters:
        messageID - The LDAP message ID for this extended result.
        resultCode - The result code for this extended result. It must not be null.
        diagnosticMessage - The diagnostic message for this extended result. It may be null if no diagnostic message should be included.
        matchedDN - The matched DN for this extended result. It may be null if no matched DN should be included.
        referralURLs - The set of referral URLs for this extended result. It may be null or empty if no referral URLs should be included.
        exitCode - The exit code returned when the collect-support-data tool completed. This may be null if extended operation processing failed before the collect-support-data tool could complete.
        controls - The set of controls to include in the extended result. It may be [@code null} or empty if no controls should be included.
      • CollectSupportDataExtendedResult

        public CollectSupportDataExtendedResult​(@NotNull
                                                ExtendedResult extendedResult)
                                         throws LDAPException
        Creates a new collect support data extended result that is decoded from the provided generic extended result.
        Parameters:
        extendedResult - The generic extended result to be decoded as a collect support data extended result. It must not be null.
        Throws:
        LDAPException - If the provided generic extended result cannot be decoded as a collect support data extended result.
    • Method Detail

      • getExitCode

        @Nullable
        public java.lang.Integer getExitCode()
        Retrieves the exit code returned when the collect-support-data tool completed.
        Returns:
        The exit code returned when the collect-support-data tool completed, or null if extended operation processing failed before the collect-support-data tool could complete.
      • 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 response 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 response will be appended.