Package com.unboundid.ldap.sdk.unboundidds.extensions

Class CollectSupportDataArchiveFragmentIntermediateResponse

    • Constructor Detail

      • CollectSupportDataArchiveFragmentIntermediateResponse

        public CollectSupportDataArchiveFragmentIntermediateResponse​(@NotNull
                                                             java.lang.String archiveFileName,
                                                             long totalArchiveSizeBytes,
                                                             boolean moreDataToReturn,
                                                             @NotNull
                                                             byte[] fragmentData,
                                                             @Nullable
                                                             Control... controls)
        Creates a new collect support data archive fragment intermediate response object with the provided information.
        Parameters:
        archiveFileName - The name (without any path information) that the server used for the support data archive file. It must not be null.
        totalArchiveSizeBytes - The size, in bytes, of the complete support data archive.
        moreDataToReturn - Indicates whether there are more fragments to be returned to as part of the complete support data archive.
        fragmentData - The data contained in this fragment of the support data archive. It must not be null.
        controls - The set of controls to include in this intermediate response. It may be null or empty if no controls should be included.

      • CollectSupportDataArchiveFragmentIntermediateResponse

        public CollectSupportDataArchiveFragmentIntermediateResponse​(@NotNull
                                                             IntermediateResponse intermediateResponse)
                                                      throws LDAPException
        Creates a new collect support data archive fragment intermediate response that is decoded from the provided generic intermediate response.
        Parameters:
        intermediateResponse - The generic intermediate response to be decoded as a collect support data archive fragment intermediate response. It must not be null.
        Throws:
        LDAPException - If the provided intermediate response object cannot be decoded as a collect support data archive fragment intermediate response.

    • Method Detail

      • getArchiveFileName

        @NotNull
public java.lang.String getArchiveFileName()
        Retrieves the name (without any path information) that the server used for the support data archive file.
        Returns:
        The name (without any path information) that the server used for the support data archive file.

      • getTotalArchiveSizeBytes

        public long getTotalArchiveSizeBytes()
        Retrieves the total number of bytes contained in the complete support data archive.
        Returns:
        The total number of bytes contained in the complete support data archive.

      • moreDataToReturn

        public boolean moreDataToReturn()
        Indicates whether there are one or more fragments still to be returned in the complete support data archive.
        Returns:
        true if there are still more fragments to be returned, or false if not.

      • getFragmentData

        @NotNull
public byte[] getFragmentData()
        Retrieves the data included in this fragment.
        Returns:
        The data included in this fragment.

      • getIntermediateResponseName

        @NotNull
public java.lang.String getIntermediateResponseName()
        Retrieves the user-friendly name for the intermediate response, 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:
        getIntermediateResponseName in class IntermediateResponse
        Returns:
        The user-friendly name for this intermediate response, 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.

      • valueToString

        @NotNull
public java.lang.String valueToString()
        Retrieves a human-readable string representation for the contents of the value for this intermediate response, if appropriate. If one is provided, then it should be a relatively compact single-line representation of the most important elements of the value.
        Overrides:
        valueToString in class IntermediateResponse
        Returns:
        A human-readable string representation for the contents of the value for this intermediate response, or null if there is no value or no string representation is available.

      • toString

        public void toString​(@NotNull
                     java.lang.StringBuilder buffer)
        Appends a string representation of this intermediate response to the provided buffer.
        Specified by:
        toString in interface LDAPResponse
        Overrides:
        toString in class IntermediateResponse
        Parameters:
        buffer - The buffer to which the string representation should be appended.