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:
Closeable,AutoCloseable
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
-
Field Summary
Fields inherited from class java.io.FilterInputStream
in -
Constructor Summary
ConstructorsConstructorDescriptionTarArchiveInputStream(InputStream inputStream) Constructs a new instance.TarArchiveInputStream(InputStream inputStream, boolean lenient) Constructs a new instance.TarArchiveInputStream(InputStream inputStream, int blockSize) Constructs a new instance.TarArchiveInputStream(InputStream inputStream, int blockSize, int recordSize) Constructs a new instance.TarArchiveInputStream(InputStream inputStream, int blockSize, int recordSize, String encoding) Constructs a new instance.TarArchiveInputStream(InputStream inputStream, int blockSize, int recordSize, String encoding, boolean lenient) Constructs a new instance.TarArchiveInputStream(InputStream inputStream, int blockSize, String encoding) Constructs a new instance.TarArchiveInputStream(InputStream inputStream, String encoding) Constructs a new instance. -
Method Summary
Modifier and TypeMethodDescriptionintGets the available data that can be read from the current entry in the archive.booleancanReadEntryData(ArchiveEntry archiveEntry) Whether this class is able to read the given entry.voidclose()Closes this stream.Gets the current TAR Archive Entry that this input stream is processingprotected byte[]Gets the next entry in this tar archive as long name data.Gets the next TarArchiveEntry in this stream.Deprecated.intGets the record size being used by this stream's buffer.protected final booleanisAtEOF()protected booleanisEOFRecord(byte[] record) Tests if an archive record indicate End of Archive.voidmark(int markLimit) Since we do not support marking just yet, we do nothing.booleanSince we do not support marking just yet, we return false.static booleanmatches(byte[] signature, int length) Checks if the signature matches what is expected for a tar file.intread(byte[] buf, int offset, int numToRead) Reads bytes from the current tar archive entry.protected byte[]Read a record from the input stream and return the data.voidreset()Since we do not support marking just yet, we do nothing.protected final voidsetAtEOF(boolean atEof) protected final voidsetCurrentEntry(TarArchiveEntry currEntry) longskip(long n) Skips over and discardsnbytes of data from this input stream.Methods inherited from class org.apache.commons.compress.archivers.ArchiveInputStream
count, count, forEach, getBytesRead, getCharset, getCount, iterator, pushedBackBytes, readMethods inherited from class java.io.FilterInputStream
read
-
Constructor Details
-
TarArchiveInputStream
Constructs a new instance.- Parameters:
inputStream- the input stream to use
-
TarArchiveInputStream
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
Constructs a new instance.- Parameters:
inputStream- the input stream to useblockSize- the block size to use
-
TarArchiveInputStream
Constructs a new instance.- Parameters:
inputStream- the input stream to useblockSize- the block size to userecordSize- the record size to use
-
TarArchiveInputStream
public TarArchiveInputStream(InputStream inputStream, int blockSize, int recordSize, 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(InputStream inputStream, int blockSize, int recordSize, 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
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
Constructs a new instance.- Parameters:
inputStream- the input stream to useencoding- name of the encoding to use for file names- Since:
- 1.4
-
-
Method Details
-
matches
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
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:
availablein classFilterInputStream- Returns:
- The number of available bytes for the current entry.
- Throws:
IOException- for signature
-
canReadEntryData
Whether this class is able to read the given entry.- Overrides:
canReadEntryDatain classArchiveInputStream<TarArchiveEntry>- Parameters:
archiveEntry- the entry to test- Returns:
- The implementation will return true if the
ArchiveEntryis an instance ofTarArchiveEntry
-
close
Closes this stream. Calls the TarBuffer's close() method.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classFilterInputStream- Throws:
IOException- on error
-
getCurrentEntry
Gets the current TAR Archive Entry that this input stream is processing- Returns:
- The current Archive Entry
-
getLongNameData
Gets the next entry in this tar archive as long name data.- Returns:
- The next entry in the archive as long name data, or null.
- Throws:
IOException- on error
-
getNextEntry
Gets the next TarArchiveEntry in this stream.- Specified by:
getNextEntryin classArchiveInputStream<TarArchiveEntry>- Returns:
- the next entry, or
nullif there are no more entries - Throws:
IOException- if the next entry could not be read
-
getNextTarEntry
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:
IOException- on error
-
getRecordSize
Gets the record size being used by this stream's buffer.- Returns:
- The TarBuffer record size.
-
isAtEOF
-
isEOFRecord
Tests 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
-
mark
Since we do not support marking just yet, we do nothing.- Overrides:
markin classArchiveInputStream<TarArchiveEntry>- Parameters:
markLimit- The limit to mark.
-
markSupported
Since we do not support marking just yet, we return false.- Overrides:
markSupportedin classArchiveInputStream<TarArchiveEntry>- Returns:
- false.
-
read
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:
readin classFilterInputStream- 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
-
readRecord
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
-
reset
Since we do not support marking just yet, we do nothing.- Overrides:
resetin classArchiveInputStream<TarArchiveEntry>
-
setAtEOF
-
setCurrentEntry
-
skip
Skips over and discardsnbytes of data from this input stream. Theskipmethod 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 beforenbytes have been skipped; are only two possibilities. The actual number of bytes skipped is returned. Ifnis negative, no bytes are skipped.- Overrides:
skipin classFilterInputStream- Parameters:
n- the number of bytes to be skipped.- Returns:
- the actual number of bytes skipped.
- Throws:
IOException- if a truncated tar archive is detected or some other I/O error occurs
-
getNextEntry().