org.apache.commons.compress.archivers.tar

Class TarArchiveInputStream

  • All Implemented Interfaces:
    Closeable, AutoCloseable


    public class TarArchiveInputStreamextends ArchiveInputStream
    The TarInputStream reads a UNIX tar archive as an InputStream. methods are provided to position at each successive entry in the archive, and the read each entry as a normal input stream using read().
    This class is not thread-safe
    • Constructor Detail

      • TarArchiveInputStream

        public TarArchiveInputStream(InputStream is,                     String encoding)
        Constructor for TarInputStream.
        Parameters:
        is - the input stream to use
        encoding - name of the encoding to use for file names
        Since:
        1.4
      • TarArchiveInputStream

        public TarArchiveInputStream(InputStream is,                     int blockSize)
        Constructor for TarInputStream.
        Parameters:
        is - the input stream to use
        blockSize - the block size to use
      • TarArchiveInputStream

        public TarArchiveInputStream(InputStream is,                     int blockSize,                     String encoding)
        Constructor for TarInputStream.
        Parameters:
        is - the input stream to use
        blockSize - the block size to use
        encoding - name of the encoding to use for file names
        Since:
        1.4
      • TarArchiveInputStream

        public TarArchiveInputStream(InputStream is,                     int blockSize,                     int recordSize)
        Constructor for TarInputStream.
        Parameters:
        is - the input stream to use
        blockSize - the block size to use
        recordSize - the record size to use
      • TarArchiveInputStream

        public TarArchiveInputStream(InputStream is,                     int blockSize,                     int recordSize,                     String encoding)
        Constructor for TarInputStream.
        Parameters:
        is - the input stream to use
        blockSize - the block size to use
        recordSize - the record size to use
        encoding - name of the encoding to use for file names
        Since:
        1.4
    • Method Detail

      • getRecordSize

        public int getRecordSize()
        Get the record size being used by this stream's buffer.
        Returns:
        The TarBuffer record size.
      • available

        public int available()              throws IOException
        Get the available data that can be read from the current entry in the archive. This does not indicate how much data is left in the entire archive, only in the current entry. This value is determined from the entry's size header field and the amount of data already read from the current entry. Integer.MAX_VALUE is returned in case more than Integer.MAX_VALUE bytes are left in the current entry in the archive.
        Overrides:
        available in class InputStream
        Returns:
        The number of available bytes for the current entry.
        Throws:
        IOException - for signature
      • skip

        public long skip(long n)          throws IOException
        Skips over and discards n bytes of data from this input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file or end of entry before n bytes have been skipped; are only two possibilities. The actual number of bytes skipped is returned. If n is negative, no bytes are skipped.
        Overrides:
        skip in class InputStream
        Parameters:
        n - the number of bytes to be skipped.
        Returns:
        the actual number of bytes skipped.
        Throws:
        IOException - if some other I/O error occurs.
      • mark

        public void mark(int markLimit)
        Since we do not support marking just yet, we do nothing.
        Overrides:
        mark in class InputStream
        Parameters:
        markLimit - The limit to mark.
      • reset

        public void reset()
        Since we do not support marking just yet, we do nothing.
        Overrides:
        reset in class InputStream
      • getNextTarEntry

        public TarArchiveEntry getNextTarEntry()                                throws IOException
        Get the next entry in this tar archive. This will skip over any remaining data in the current entry, if there is one, and place the input stream at the header of the next entry, and read the header and instantiate a new TarEntry from the header bytes and return that entry. If there are no more entries in the archive, null will be returned to indicate that the end of the archive has been reached.
        Returns:
        The next TarEntry in the archive, or null.
        Throws:
        IOException - on error
      • getLongNameData

        protected byte[] getLongNameData()                          throws IOException
        Get the next entry in this tar archive as longname data.
        Returns:
        The next entry in the archive as longname data, or null.
        Throws:
        IOException - on error
      • isEOFRecord

        protected boolean isEOFRecord(byte[] record)
        Determine if an archive record indicate End of Archive. End of archive is indicated by a record that consists entirely of null bytes.
        Parameters:
        record - The record data to check.
        Returns:
        true if the record data is an End of Archive
      • readRecord

        protected byte[] readRecord()                     throws IOException
        Read a record from the input stream and return the data.
        Returns:
        The record data or null if EOF has been hit.
        Throws:
        IOException - on error
      • read

        public int read(byte[] buf,       int offset,       int numToRead)         throws IOException
        Reads bytes from the current tar archive entry. This method is aware of the boundaries of the current entry in the archive and will deal with them as if they were this stream's start and EOF.
        Overrides:
        read in class InputStream
        Parameters:
        buf - The buffer into which to place bytes read.
        offset - The offset at which to place bytes read.
        numToRead - The number of bytes to read.
        Returns:
        The number of bytes read, or -1 at EOF.
        Throws:
        IOException - on error
      • canReadEntryData

        public boolean canReadEntryData(ArchiveEntry ae)
        Whether this class is able to read the given entry.

        May return false if the current entry is a sparse file.

        Overrides:
        canReadEntryData in class ArchiveInputStream
        Parameters:
        ae - the entry to test
        Returns:
        This implementation always returns true.
      • getCurrentEntry

        public TarArchiveEntry getCurrentEntry()
        Get the current TAR Archive Entry that this input stream is processing
        Returns:
        The current Archive Entry
      • isAtEOF

        protected final boolean isAtEOF()
      • setAtEOF

        protected final void setAtEOF(boolean b)
      • matches

        public static boolean matches(byte[] signature,              int length)
        Checks if the signature matches what is expected for a tar file.
        Parameters:
        signature - the bytes to check
        length - the number of bytes to check
        Returns:
        true, if this stream is a tar archive stream, false otherwise

Copyright © 2016 The Apache Software Foundation. All rights reserved.



NOTHING
NOTHING
Add the Maven Dependecy to your project: maven dependecy for com.amazonaws : aws-java-sdk : 1.3.14