Class TarArchiveInputStream
- java.lang.Object
-
- java.io.InputStream
-
- org.apache.commons.compress.archivers.ArchiveInputStream
-
- org.apache.commons.compress.archivers.tar.TarArchiveInputStream
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
public class TarArchiveInputStream extends 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().
-
-
Field Summary
Fields Modifier and Type Field Description private int
blockSize
The size of a blockprivate TarArchiveEntry
currEntry
The meta-data about the current entry(package private) java.lang.String
encoding
private long
entryOffset
How far into the entry the stream is atprivate long
entrySize
Size of the current entryprivate java.util.Map<java.lang.String,java.lang.String>
globalPaxHeaders
private boolean
hasHitEOF
True if file has hit EOFprivate java.io.InputStream
is
An input stream to read fromprivate boolean
lenient
private int
recordSize
The size the TAR headerprivate static int
SMALL_BUFFER_SIZE
private byte[]
smallBuf
private ZipEncoding
zipEncoding
The encoding of the file
-
Constructor Summary
Constructors Constructor Description TarArchiveInputStream(java.io.InputStream is)
Constructor for TarInputStream.TarArchiveInputStream(java.io.InputStream is, boolean lenient)
Constructor for TarInputStream.TarArchiveInputStream(java.io.InputStream is, int blockSize)
Constructor for TarInputStream.TarArchiveInputStream(java.io.InputStream is, int blockSize, int recordSize)
Constructor for TarInputStream.TarArchiveInputStream(java.io.InputStream is, int blockSize, int recordSize, java.lang.String encoding)
Constructor for TarInputStream.TarArchiveInputStream(java.io.InputStream is, int blockSize, int recordSize, java.lang.String encoding, boolean lenient)
Constructor for TarInputStream.TarArchiveInputStream(java.io.InputStream is, int blockSize, java.lang.String encoding)
Constructor for TarInputStream.TarArchiveInputStream(java.io.InputStream is, java.lang.String encoding)
Constructor for TarInputStream.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
applyPaxHeadersToCurrentEntry(java.util.Map<java.lang.String,java.lang.String> headers)
int
available()
Get the available data that can be read from the current entry in the archive.boolean
canReadEntryData(ArchiveEntry ae)
Whether this class is able to read the given entry.void
close()
Closes this stream.private void
consumeRemainderOfLastBlock()
This method is invoked once the end of the archive is hit, it tries to consume the remaining bytes under the assumption that the tool creating this archive has padded the last block.TarArchiveEntry
getCurrentEntry()
Get the current TAR Archive Entry that this input stream is processingprotected byte[]
getLongNameData()
Get the next entry in this tar archive as longname data.ArchiveEntry
getNextEntry()
Returns the next Archive Entry in this Stream.TarArchiveEntry
getNextTarEntry()
Get the next entry in this tar archive.private byte[]
getRecord()
Get the next record in this tar archive.int
getRecordSize()
Get the record size being used by this stream's buffer.protected boolean
isAtEOF()
private boolean
isDirectory()
protected boolean
isEOFRecord(byte[] record)
Determine if an archive record indicate End of Archive.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.(package private) java.util.Map<java.lang.String,java.lang.String>
parsePaxHeaders(java.io.InputStream i)
private void
paxHeaders()
int
read(byte[] buf, int offset, int numToRead)
Reads bytes from the current tar archive entry.private void
readGlobalPaxHeaders()
private void
readOldGNUSparse()
Adds the sparse chunks from the current entry to the sparse chunks, including any additional sparse entries following the current entry.protected byte[]
readRecord()
Read a record from the input stream and return the data.void
reset()
Since we do not support marking just yet, we do nothing.protected void
setAtEOF(boolean b)
protected void
setCurrentEntry(TarArchiveEntry e)
long
skip(long n)
Skips over and discardsn
bytes of data from this input stream.private void
skipRecordPadding()
The last record block should be written at the full size, so skip any additional space used to fill a record after an entryprivate void
tryToConsumeSecondEOFRecord()
Tries to read the next record rewinding the stream if it is not a EOF record.-
Methods inherited from class org.apache.commons.compress.archivers.ArchiveInputStream
count, count, getBytesRead, getCount, pushedBackBytes, read
-
-
-
-
Field Detail
-
SMALL_BUFFER_SIZE
private static final int SMALL_BUFFER_SIZE
- See Also:
- Constant Field Values
-
smallBuf
private final byte[] smallBuf
-
recordSize
private final int recordSize
The size the TAR header
-
blockSize
private final int blockSize
The size of a block
-
hasHitEOF
private boolean hasHitEOF
True if file has hit EOF
-
entrySize
private long entrySize
Size of the current entry
-
entryOffset
private long entryOffset
How far into the entry the stream is at
-
is
private final java.io.InputStream is
An input stream to read from
-
currEntry
private TarArchiveEntry currEntry
The meta-data about the current entry
-
zipEncoding
private final ZipEncoding zipEncoding
The encoding of the file
-
encoding
final java.lang.String encoding
-
globalPaxHeaders
private java.util.Map<java.lang.String,java.lang.String> globalPaxHeaders
-
lenient
private final boolean lenient
-
-
Constructor Detail
-
TarArchiveInputStream
public TarArchiveInputStream(java.io.InputStream is)
Constructor for TarInputStream.- Parameters:
is
- the input stream to use
-
TarArchiveInputStream
public TarArchiveInputStream(java.io.InputStream is, boolean lenient)
Constructor for TarInputStream.- Parameters:
is
- 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 is, java.lang.String encoding)
Constructor for TarInputStream.- Parameters:
is
- the input stream to useencoding
- name of the encoding to use for file names- Since:
- 1.4
-
TarArchiveInputStream
public TarArchiveInputStream(java.io.InputStream is, int blockSize)
Constructor for TarInputStream.- Parameters:
is
- the input stream to useblockSize
- the block size to use
-
TarArchiveInputStream
public TarArchiveInputStream(java.io.InputStream is, int blockSize, java.lang.String encoding)
Constructor for TarInputStream.- Parameters:
is
- 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 is, int blockSize, int recordSize)
Constructor for TarInputStream.- Parameters:
is
- the input stream to useblockSize
- the block size to userecordSize
- the record size to use
-
TarArchiveInputStream
public TarArchiveInputStream(java.io.InputStream is, int blockSize, int recordSize, java.lang.String encoding)
Constructor for TarInputStream.- Parameters:
is
- 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 is, int blockSize, int recordSize, java.lang.String encoding, boolean lenient)
Constructor for TarInputStream.- Parameters:
is
- 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
-
-
Method Detail
-
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.InputStream
- Throws:
java.io.IOException
- on error
-
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 java.io.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 classjava.io.InputStream
- Returns:
- The number of available bytes for the current entry.
- Throws:
java.io.IOException
- for signature
-
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.InputStream
- Parameters:
n
- the number of bytes to be skipped.- Returns:
- the actual number of bytes skipped.
- Throws:
java.io.IOException
- if some other I/O error occurs.
-
markSupported
public boolean markSupported()
Since we do not support marking just yet, we return false.- Overrides:
markSupported
in classjava.io.InputStream
- Returns:
- False.
-
mark
public void mark(int markLimit)
Since we do not support marking just yet, we do nothing.- Overrides:
mark
in classjava.io.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 classjava.io.InputStream
-
getNextTarEntry
public TarArchiveEntry getNextTarEntry() throws java.io.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:
java.io.IOException
- on error
-
skipRecordPadding
private void skipRecordPadding() throws java.io.IOException
The last record block should be written at the full size, so skip any additional space used to fill a record after an entry- Throws:
java.io.IOException
-
getLongNameData
protected byte[] getLongNameData() throws java.io.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:
java.io.IOException
- on error
-
getRecord
private byte[] getRecord() throws java.io.IOException
Get the next record 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.If there are no more entries in the archive, null will be returned to indicate that the end of the archive has been reached. At the same time the
hasHitEOF
marker will be set to true.- Returns:
- The next header in the archive, or null.
- Throws:
java.io.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 java.io.IOException
Read a record from the input stream and return the data.- Returns:
- The record data or null if EOF has been hit.
- Throws:
java.io.IOException
- on error
-
readGlobalPaxHeaders
private void readGlobalPaxHeaders() throws java.io.IOException
- Throws:
java.io.IOException
-
paxHeaders
private void paxHeaders() throws java.io.IOException
- Throws:
java.io.IOException
-
parsePaxHeaders
java.util.Map<java.lang.String,java.lang.String> parsePaxHeaders(java.io.InputStream i) throws java.io.IOException
- Throws:
java.io.IOException
-
applyPaxHeadersToCurrentEntry
private void applyPaxHeadersToCurrentEntry(java.util.Map<java.lang.String,java.lang.String> headers)
-
readOldGNUSparse
private void readOldGNUSparse() throws java.io.IOException
Adds the sparse chunks from the current entry to the sparse chunks, including any additional sparse entries following the current entry.- Throws:
java.io.IOException
- on error
-
isDirectory
private boolean isDirectory()
-
getNextEntry
public ArchiveEntry getNextEntry() throws java.io.IOException
Returns the next Archive Entry in this Stream.- Specified by:
getNextEntry
in classArchiveInputStream
- Returns:
- the next entry,
or
null
if there are no more entries - Throws:
java.io.IOException
- if the next entry could not be read
-
tryToConsumeSecondEOFRecord
private void tryToConsumeSecondEOFRecord() throws java.io.IOException
Tries to read the next record rewinding the stream if it is not a EOF record.This is meant to protect against cases where a tar implementation has written only one EOF record when two are expected. Actually this won't help since a non-conforming implementation likely won't fill full blocks consisting of - by default - ten records either so we probably have already read beyond the archive anyway.
- Throws:
java.io.IOException
-
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.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:
java.io.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 classArchiveInputStream
- 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
-
setCurrentEntry
protected final void setCurrentEntry(TarArchiveEntry e)
-
isAtEOF
protected final boolean isAtEOF()
-
setAtEOF
protected final void setAtEOF(boolean b)
-
consumeRemainderOfLastBlock
private void consumeRemainderOfLastBlock() throws java.io.IOException
This method is invoked once the end of the archive is hit, it tries to consume the remaining bytes under the assumption that the tool creating this archive has padded the last block.- Throws:
java.io.IOException
-
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
-
-