Class TarArchiveInputStream
- java.lang.Object
-
- java.io.InputStream
-
- java.io.FilterInputStream
-
- org.apache.commons.compress.archivers.ArchiveInputStream<TarArchiveEntry>
-
- org.apache.commons.compress.archivers.tar.TarArchiveInputStream
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
public class TarArchiveInputStream extends ArchiveInputStream<TarArchiveEntry>
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().
-
-
Constructor Summary
Constructors Constructor Description TarArchiveInputStream(java.io.InputStream inputStream)
Constructs a new instance.TarArchiveInputStream(java.io.InputStream inputStream, boolean lenient)
Constructs a new instance.TarArchiveInputStream(java.io.InputStream inputStream, int blockSize)
Constructs a new instance.TarArchiveInputStream(java.io.InputStream inputStream, int blockSize, int recordSize)
Constructs a new instance.TarArchiveInputStream(java.io.InputStream inputStream, int blockSize, int recordSize, java.lang.String encoding)
Constructs a new instance.TarArchiveInputStream(java.io.InputStream inputStream, int blockSize, int recordSize, java.lang.String encoding, boolean lenient)
Constructs a new instance.TarArchiveInputStream(java.io.InputStream inputStream, int blockSize, java.lang.String encoding)
Constructs a new instance.TarArchiveInputStream(java.io.InputStream inputStream, java.lang.String encoding)
Constructs a new instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
available()
Gets the available data that can be read from the current entry in the archive.boolean
canReadEntryData(ArchiveEntry archiveEntry)
Whether this class is able to read the given entry.void
close()
Closes this stream.TarArchiveEntry
getCurrentEntry()
Gets the current TAR Archive Entry that this input stream is processingTarArchiveEntry
getNextEntry()
Gets the next TarArchiveEntry in this stream.TarArchiveEntry
getNextTarEntry()
Deprecated.UsegetNextEntry()
.int
getRecordSize()
Gets the record size being used by this stream's buffer.void
mark(int markLimit)
Since we do not support marking just yet, we do nothing.boolean
markSupported()
Since we do not support marking just yet, we return false.static boolean
matches(byte[] signature, int length)
Checks if the signature matches what is expected for a tar file.int
read(byte[] buf, int offset, int numToRead)
Reads bytes from the current tar archive entry.void
reset()
Since we do not support marking just yet, we do nothing.long
skip(long n)
Skips over and discardsn
bytes of data from this input stream.-
Methods inherited from class org.apache.commons.compress.archivers.ArchiveInputStream
getBytesRead, getCharset, getCount, read
-
-
-
-
Constructor Detail
-
TarArchiveInputStream
public TarArchiveInputStream(java.io.InputStream inputStream)
Constructs a new instance.- Parameters:
inputStream
- the input stream to use
-
TarArchiveInputStream
public TarArchiveInputStream(java.io.InputStream inputStream, boolean lenient)
Constructs a new instance.- Parameters:
inputStream
- the input stream to uselenient
- when set to true illegal values for group/userid, mode, device numbers and timestamp will be ignored and the fields set toTarArchiveEntry.UNKNOWN
. When set to false such illegal fields cause an exception instead.- Since:
- 1.19
-
TarArchiveInputStream
public TarArchiveInputStream(java.io.InputStream inputStream, int blockSize)
Constructs a new instance.- Parameters:
inputStream
- the input stream to useblockSize
- the block size to use
-
TarArchiveInputStream
public TarArchiveInputStream(java.io.InputStream inputStream, int blockSize, int recordSize)
Constructs a new instance.- Parameters:
inputStream
- the input stream to useblockSize
- the block size to userecordSize
- the record size to use
-
TarArchiveInputStream
public TarArchiveInputStream(java.io.InputStream inputStream, int blockSize, int recordSize, java.lang.String encoding)
Constructs a new instance.- Parameters:
inputStream
- the input stream to useblockSize
- the block size to userecordSize
- the record size to useencoding
- name of the encoding to use for file names- Since:
- 1.4
-
TarArchiveInputStream
public TarArchiveInputStream(java.io.InputStream inputStream, int blockSize, int recordSize, java.lang.String encoding, boolean lenient)
Constructs a new instance.- Parameters:
inputStream
- the input stream to useblockSize
- the block size to userecordSize
- the record size to useencoding
- name of the encoding to use for file nameslenient
- when set to true illegal values for group/userid, mode, device numbers and timestamp will be ignored and the fields set toTarArchiveEntry.UNKNOWN
. When set to false such illegal fields cause an exception instead.- Since:
- 1.19
-
TarArchiveInputStream
public TarArchiveInputStream(java.io.InputStream inputStream, int blockSize, java.lang.String encoding)
Constructs a new instance.- Parameters:
inputStream
- the input stream to useblockSize
- the block size to useencoding
- name of the encoding to use for file names- Since:
- 1.4
-
TarArchiveInputStream
public TarArchiveInputStream(java.io.InputStream inputStream, java.lang.String encoding)
Constructs a new instance.- Parameters:
inputStream
- the input stream to useencoding
- name of the encoding to use for file names- Since:
- 1.4
-
-
Method Detail
-
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 checklength
- the number of bytes to check- Returns:
- true, if this stream is a tar archive stream, false otherwise
-
available
public int available() throws java.io.IOException
Gets 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 classjava.io.FilterInputStream
- Returns:
- The number of available bytes for the current entry.
- Throws:
java.io.IOException
- for signature
-
canReadEntryData
public boolean canReadEntryData(ArchiveEntry archiveEntry)
Whether this class is able to read the given entry.- Overrides:
canReadEntryData
in classArchiveInputStream<TarArchiveEntry>
- Parameters:
archiveEntry
- the entry to test- Returns:
- The implementation will return true if the
ArchiveEntry
is an instance ofTarArchiveEntry
-
close
public void close() throws java.io.IOException
Closes this stream. Calls the TarBuffer's close() method.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Overrides:
close
in classjava.io.FilterInputStream
- Throws:
java.io.IOException
- on error
-
getCurrentEntry
public TarArchiveEntry getCurrentEntry()
Gets the current TAR Archive Entry that this input stream is processing- Returns:
- The current Archive Entry
-
getNextEntry
public TarArchiveEntry getNextEntry() throws java.io.IOException
Gets the next TarArchiveEntry in this stream.- Specified by:
getNextEntry
in classArchiveInputStream<TarArchiveEntry>
- Returns:
- the next entry, or
null
if there are no more entries - Throws:
java.io.IOException
- if the next entry could not be read
-
getNextTarEntry
@Deprecated public TarArchiveEntry getNextTarEntry() throws java.io.IOException
Deprecated.UsegetNextEntry()
.Gets 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:
java.io.IOException
- on error
-
getRecordSize
public int getRecordSize()
Gets the record size being used by this stream's buffer.- Returns:
- The TarBuffer record size.
-
mark
public void mark(int markLimit)
Since we do not support marking just yet, we do nothing.- Overrides:
mark
in classArchiveInputStream<TarArchiveEntry>
- Parameters:
markLimit
- The limit to mark.
-
markSupported
public boolean markSupported()
Since we do not support marking just yet, we return false.- Overrides:
markSupported
in classArchiveInputStream<TarArchiveEntry>
- Returns:
- false.
-
read
public int read(byte[] buf, int offset, int numToRead) throws java.io.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 classjava.io.FilterInputStream
- 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:
java.io.IOException
- on error
-
reset
public void reset()
Since we do not support marking just yet, we do nothing.- Overrides:
reset
in classArchiveInputStream<TarArchiveEntry>
-
skip
public long skip(long n) throws java.io.IOException
Skips over and discardsn
bytes of data from this input stream. Theskip
method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly0
. This may result from any of a number of conditions; reaching end of file or end of entry beforen
bytes have been skipped; are only two possibilities. The actual number of bytes skipped is returned. Ifn
is negative, no bytes are skipped.- Overrides:
skip
in classjava.io.FilterInputStream
- Parameters:
n
- the number of bytes to be skipped.- Returns:
- the actual number of bytes skipped.
- Throws:
java.io.IOException
- if a truncated tar archive is detected or some other I/O error occurs
-
-