Class TarArchiveOutputStream
java.lang.Object
java.io.OutputStream
java.io.FilterOutputStream
org.apache.commons.compress.archivers.ArchiveOutputStream<TarArchiveEntry>
org.apache.commons.compress.archivers.tar.TarArchiveOutputStream
- All Implemented Interfaces:
Closeable,Flushable,AutoCloseable
The TarOutputStream writes a UNIX tar archive as an OutputStream. Methods are provided to put entries, and then write their contents by writing to this
stream using write().
tar archives consist of a sequence of records of 512 bytes each that are grouped into blocks. Prior to Apache Commons Compress 1.14 it has been possible to configure a record size different from 512 bytes and arbitrary block sizes. Starting with Compress 1.15 512 is the only valid option for the record size and the block size must be a multiple of 512. Also the default block size changed from 10240 bytes prior to Compress 1.15 to 512 bytes with Compress 1.15.
- This class is not thread-safe
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intFail if a big number (e.g. size > 8GiB) is required in the archive.static final intPOSIX/PAX extensions are used to store big numbers in the archive.static final intstar/GNU tar/BSD tar extensions are used to store big number in the archive.static final intFail if a long file name is required in the archive.static final intGNU tar extensions are used to store long file names in the archive.static final intPOSIX/PAX extensions are used to store long file names in the archive.static final intLong paths will be truncated in the archive.Fields inherited from class java.io.FilterOutputStream
out -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new instance.TarArchiveOutputStream(OutputStream os, int blockSize) Constructs a new instance.TarArchiveOutputStream(OutputStream os, int blockSize, int recordSize) Deprecated.recordSize must always be 512 bytes.TarArchiveOutputStream(OutputStream os, int blockSize, int recordSize, String encoding) Deprecated.recordSize must always be 512 bytes.TarArchiveOutputStream(OutputStream os, int blockSize, String encoding) Constructs a new instance.TarArchiveOutputStream(OutputStream os, String encoding) Constructs a new instance. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Closes the underlying OutputStream.voidCloses an entry.createArchiveEntry(File inputFile, String entryName) Creates an archive entry using the inputFile and entryName provided.createArchiveEntry(Path inputPath, String entryName, LinkOption... options) Creates an archive entry using the inputPath and entryName provided.voidfinish()Finishes the TAR archive without closing the underlying OutputStream.longGets the current number of bytes written to this stream.intgetCount()Deprecated.intDeprecated.voidputArchiveEntry(TarArchiveEntry archiveEntry) Puts an entry on the output stream.voidsetAddPaxHeadersForNonAsciiNames(boolean b) Sets whether to add a PAX extension header for non-ASCII file names.voidsetBigNumberMode(int bigNumberMode) Sets the big number mode.voidsetLongFileMode(int longFileMode) Sets the long file mode.voidwrite(byte[] wBuf, int wOffset, int numToWrite) Writes bytes to the current tar archive entry.Methods inherited from class org.apache.commons.compress.archivers.ArchiveOutputStream
canWriteEntryData, checkFinished, checkOpen, count, count, isClosed, isFinished, writeMethods inherited from class java.io.FilterOutputStream
flush, write
-
Field Details
-
LONGFILE_ERROR
Fail if a long file name is required in the archive.- See Also:
-
LONGFILE_TRUNCATE
Long paths will be truncated in the archive.- See Also:
-
LONGFILE_GNU
GNU tar extensions are used to store long file names in the archive.- See Also:
-
LONGFILE_POSIX
POSIX/PAX extensions are used to store long file names in the archive.- See Also:
-
BIGNUMBER_ERROR
Fail if a big number (e.g. size > 8GiB) is required in the archive.- See Also:
-
BIGNUMBER_STAR
star/GNU tar/BSD tar extensions are used to store big number in the archive.- See Also:
-
BIGNUMBER_POSIX
POSIX/PAX extensions are used to store big numbers in the archive.- See Also:
-
-
Constructor Details
-
TarArchiveOutputStream
Constructs a new instance.Uses a block size of 512 bytes.
- Parameters:
os- the output stream to use
-
TarArchiveOutputStream
Constructs a new instance.- Parameters:
os- the output stream to useblockSize- the block size to use. Must be a multiple of 512 bytes.
-
TarArchiveOutputStream
Deprecated.recordSize must always be 512 bytes. An IllegalArgumentException will be thrown if any other value is usedConstructs a new instance.- Parameters:
os- the output stream to useblockSize- the block size to userecordSize- the record size to use. Must be 512 bytes.
-
TarArchiveOutputStream
@Deprecated public TarArchiveOutputStream(OutputStream os, int blockSize, int recordSize, String encoding) Deprecated.recordSize must always be 512 bytes. An IllegalArgumentException will be thrown if any other value is used.Constructs a new instance.- Parameters:
os- the output stream to useblockSize- the block size to use . Must be a multiple of 512 bytes.recordSize- the record size to use. Must be 512 bytes.encoding- name of the encoding to use for file names- Since:
- 1.4
-
TarArchiveOutputStream
Constructs a new instance.- Parameters:
os- the output stream to useblockSize- the block size to use. Must be a multiple of 512 bytes.encoding- name of the encoding to use for file names- Since:
- 1.4
-
TarArchiveOutputStream
Constructs a new instance.Uses a block size of 512 bytes.
- Parameters:
os- the output stream to useencoding- name of the encoding to use for file names- Since:
- 1.4
-
-
Method Details
-
close
Closes the underlying OutputStream.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classArchiveOutputStream<TarArchiveEntry>- Throws:
IOException- on error
-
closeArchiveEntry
Closes an entry. This method MUST be called for all file entries that contain data. The reason is that we must buffer data written to the stream in order to satisfy the buffer's record based writes. Thus, there may be data fragments still being assembled that must be written to the output stream before this entry is closed and the next entry written.- Specified by:
closeArchiveEntryin classArchiveOutputStream<TarArchiveEntry>- Throws:
IOException- on error
-
createArchiveEntry
Description copied from class:ArchiveOutputStreamCreates an archive entry using the inputFile and entryName provided.- Specified by:
createArchiveEntryin classArchiveOutputStream<TarArchiveEntry>- Parameters:
inputFile- the file to create the entry fromentryName- name to use for the entry- Returns:
- the ArchiveEntry set up with details from the file
- Throws:
IOException- if an I/O error occurs
-
createArchiveEntry
public TarArchiveEntry createArchiveEntry(Path inputPath, String entryName, LinkOption... options) throws IOException Description copied from class:ArchiveOutputStreamCreates an archive entry using the inputPath and entryName provided.The default implementation calls simply delegates as:
return createArchiveEntry(inputFile.toFile(), entryName);
Subclasses should override this method.
- Overrides:
createArchiveEntryin classArchiveOutputStream<TarArchiveEntry>- Parameters:
inputPath- the file to create the entry fromentryName- name to use for the entryoptions- options indicating how symbolic links are handled.- Returns:
- the ArchiveEntry set up with details from the file
- Throws:
IOException- if an I/O error occurs
-
finish
Finishes the TAR archive without closing the underlying OutputStream. An archive consists of a series of file entries terminated by an end-of-archive entry, which consists of two 512 blocks of zero bytes. POSIX.1 requires two EOF records, like some other implementations.- Overrides:
finishin classArchiveOutputStream<TarArchiveEntry>- Throws:
IOException- on error
-
getBytesWritten
Description copied from class:ArchiveOutputStreamGets the current number of bytes written to this stream.- Overrides:
getBytesWrittenin classArchiveOutputStream<TarArchiveEntry>- Returns:
- the number of written bytes
-
getCount
Deprecated.Description copied from class:ArchiveOutputStreamGets the current number of bytes written to this stream.- Overrides:
getCountin classArchiveOutputStream<TarArchiveEntry>- Returns:
- the number of written bytes
-
getRecordSize
Deprecated.Gets the record size being used by this stream's TarBuffer.- Returns:
- The TarBuffer record size.
-
putArchiveEntry
Puts an entry on the output stream. This writes the entry's header record and positions the output stream for writing the contents of the entry. Once this method is called, the stream is ready for calls to write() to write the entry's contents. Once the contents are written, closeArchiveEntry() MUST be called to ensure that all buffered data is completely written to the output stream.- Specified by:
putArchiveEntryin classArchiveOutputStream<TarArchiveEntry>- Parameters:
archiveEntry- The TarEntry to be written to the archive.- Throws:
IOException- on errorClassCastException- if archiveEntry is not an instance of TarArchiveEntryIllegalArgumentException- if thelongFileModeequalsLONGFILE_ERRORand the file name is too longIllegalArgumentException- if thebigNumberModeequalsBIGNUMBER_ERRORand one of the numeric values exceeds the limits of a traditional tar header.
-
setAddPaxHeadersForNonAsciiNames
Sets whether to add a PAX extension header for non-ASCII file names.- Parameters:
b- whether to add a PAX extension header for non-ASCII file names.- Since:
- 1.4
-
setBigNumberMode
Sets the big number mode. This can be BIGNUMBER_ERROR(0), BIGNUMBER_STAR(1) or BIGNUMBER_POSIX(2). This specifies the treatment of big files (sizes > TarConstants.MAXSIZE) and other numeric values too big to fit into a traditional tar header. Default is BIGNUMBER_ERROR.- Parameters:
bigNumberMode- the mode to use- Since:
- 1.4
-
setLongFileMode
Sets the long file mode. This can be LONGFILE_ERROR(0), LONGFILE_TRUNCATE(1), LONGFILE_GNU(2) or LONGFILE_POSIX(3). This specifies the treatment of long file names (names >= TarConstants.NAMELEN). Default is LONGFILE_ERROR.- Parameters:
longFileMode- the mode to use
-
write
Writes bytes to the current tar archive entry. This method is aware of the current entry and will throw an exception if you attempt to write bytes past the length specified for the current entry.- Overrides:
writein classFilterOutputStream- Parameters:
wBuf- The buffer to write to the archive.wOffset- The offset in the buffer from which to get bytes.numToWrite- The number of bytes to write.- Throws:
IOException- on error
-