Interface PayloadProvider

  • All Known Implementing Classes:
    PayloadRecorder

    public interface PayloadProvider
    • Method Detail

      • openChannel

        java.nio.channels.ReadableByteChannel openChannel()
                                                   throws java.io.IOException
        Open a new channel to the payload data

        The caller is responsible for closing the resource

        Returns:
        the newly created channel
        Throws:
        java.io.IOException - if opening the channels fails
      • getPayloadSize

        long getPayloadSize()
                     throws java.io.IOException
        The number of bytes of the compressed archive file
        Returns:
        the number of bytes of the compressed archive file
        Throws:
        java.io.IOException - if anything goes wrong
      • getArchiveSize

        long getArchiveSize()
                     throws java.io.IOException
        Get the number of bytes of the uncompressed payload archive
        Returns:
        the number of bytes of the uncompressed payload archive
        Throws:
        java.io.IOException - if anything goes wrong
      • getPayloadCoding

        PayloadCoding getPayloadCoding()
        The compression method for this compressed archive file
        Returns:
        the compression method for this compressed archive file
      • getPayloadFlags

        java.util.Optional<java.lang.String> getPayloadFlags()
        The compression flags for this compressed archive file, if any
        Returns:
        the compression flags for this compressed archive file, if any
      • getFileDigestAlgorithm

        DigestAlgorithm getFileDigestAlgorithm()
        The algorithm used for generating file checksum digests whose ordinal is defined in HashAlgorithmTags
        Returns:
        the algorithm used for generating file checksum digests whose ordinal is defined in HashAlgorithmTags