Package org.apache.commons.compress.archivers.tar

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
public class TarArchiveOutputStream extends ArchiveOutputStream<TarArchiveEntry>
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.

  • Field Details

    • LONGFILE_ERROR

      public static final int LONGFILE_ERROR
      Fail if a long file name is required in the archive.
      See Also:

    • LONGFILE_TRUNCATE

      public static final int LONGFILE_TRUNCATE
      Long paths will be truncated in the archive.
      See Also:

    • LONGFILE_GNU

      public static final int LONGFILE_GNU
      GNU tar extensions are used to store long file names in the archive.
      See Also:

    • LONGFILE_POSIX

      public static final int LONGFILE_POSIX
      POSIX/PAX extensions are used to store long file names in the archive.
      See Also:

    • BIGNUMBER_ERROR

      public static final int BIGNUMBER_ERROR
      Fail if a big number (e.g. size > 8GiB) is required in the archive.
      See Also:

    • BIGNUMBER_STAR

      public static final int BIGNUMBER_STAR
      star/GNU tar/BSD tar extensions are used to store big number in the archive.
      See Also:

    • BIGNUMBER_POSIX

      public static final int BIGNUMBER_POSIX
      POSIX/PAX extensions are used to store big numbers in the archive.
      See Also:

    • RECORD_SIZE

      private static final int RECORD_SIZE
      See Also:

    • ASCII

      private static final ZipEncoding ASCII

    • BLOCK_SIZE_UNSPECIFIED

      private static final int BLOCK_SIZE_UNSPECIFIED
      See Also:

    • currSize

      private long currSize

    • currName

      private String currName

    • currBytes

      private long currBytes

    • recordBuf

      private final byte[] recordBuf

    • longFileMode

      private int longFileMode

    • bigNumberMode

      private int bigNumberMode

    • recordsWritten

      private long recordsWritten

    • recordsPerBlock

      private final int recordsPerBlock

    • haveUnclosedEntry

      private boolean haveUnclosedEntry
      Indicates if putArchiveEntry has been called without closeArchiveEntry

    • countingOut

      private final org.apache.commons.io.output.CountingOutputStream countingOut

    • zipEncoding

      private final ZipEncoding zipEncoding

    • charsetName

      final String charsetName
      The provided encoding (for unit tests).

    • addPaxHeadersForNonAsciiNames

      private boolean addPaxHeadersForNonAsciiNames

  • Constructor Details

    • TarArchiveOutputStream

      public TarArchiveOutputStream(OutputStream os)
      Constructs a new instance.

      Uses a block size of 512 bytes.

      Parameters:
      os - the output stream to use

    • TarArchiveOutputStream

      public TarArchiveOutputStream(OutputStream os, int blockSize)
      Constructs a new instance.
      Parameters:
      os - the output stream to use
      blockSize - the block size to use. Must be a multiple of 512 bytes.

    • TarArchiveOutputStream

      @Deprecated public TarArchiveOutputStream(OutputStream os, int blockSize, int recordSize)
      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 use
      blockSize - the block size to use
      recordSize - 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 use
      blockSize - 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

      public TarArchiveOutputStream(OutputStream os, int blockSize, String encoding)
      Constructs a new instance.
      Parameters:
      os - the output stream to use
      blockSize - 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

      public TarArchiveOutputStream(OutputStream os, String encoding)
      Constructs a new instance.

      Uses a block size of 512 bytes.

      Parameters:
      os - the output stream to use
      encoding - name of the encoding to use for file names
      Since:
      1.4

  • Method Details

    • addFileTimePaxHeader

      private void addFileTimePaxHeader(Map<String,String> paxHeaders, String header, FileTime value)

    • addFileTimePaxHeaderForBigNumber

      private void addFileTimePaxHeaderForBigNumber(Map<String,String> paxHeaders, String header, FileTime value, long maxValue)

    • addInstantPaxHeader

      private void addInstantPaxHeader(Map<String,String> paxHeaders, String header, long seconds, int nanos)

    • addPaxHeaderForBigNumber

      private void addPaxHeaderForBigNumber(Map<String,String> paxHeaders, String header, long value, long maxValue)

    • addPaxHeadersForBigNumbers

      private void addPaxHeadersForBigNumbers(Map<String,String> paxHeaders, TarArchiveEntry entry)

    • close

      public void close() throws IOException
      Closes the underlying OutputStream.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Overrides:
      close in class ArchiveOutputStream<TarArchiveEntry>
      Throws:
      IOException - on error

    • closeArchiveEntry

      public void closeArchiveEntry() throws IOException
      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:
      closeArchiveEntry in class ArchiveOutputStream<TarArchiveEntry>
      Throws:
      IOException - on error

    • createArchiveEntry

      public TarArchiveEntry createArchiveEntry(File inputFile, String entryName) throws IOException
      Description copied from class: ArchiveOutputStream
      Creates an archive entry using the inputFile and entryName provided.
      Specified by:
      createArchiveEntry in class ArchiveOutputStream<TarArchiveEntry>
      Parameters:
      inputFile - the file to create the entry from
      entryName - 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: ArchiveOutputStream
      Creates 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:
      createArchiveEntry in class ArchiveOutputStream<TarArchiveEntry>
      Parameters:
      inputPath - the file to create the entry from
      entryName - name to use for the entry
      options - 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

    • encodeExtendedPaxHeadersContents

      private byte[] encodeExtendedPaxHeadersContents(Map<String,String> headers)

    • failForBigNumber

      private void failForBigNumber(String field, long value, long maxValue)

    • failForBigNumber

      private void failForBigNumber(String field, long value, long maxValue, String additionalMsg)

    • failForBigNumbers

      private void failForBigNumbers(TarArchiveEntry entry)

    • failForBigNumberWithPosixMessage

      private void failForBigNumberWithPosixMessage(String field, long value, long maxValue)

    • finish

      public void finish() throws IOException
      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:
      finish in class ArchiveOutputStream<TarArchiveEntry>
      Throws:
      IOException - on error

    • getBytesWritten

      public long getBytesWritten()
      Description copied from class: ArchiveOutputStream
      Gets the current number of bytes written to this stream.
      Overrides:
      getBytesWritten in class ArchiveOutputStream<TarArchiveEntry>
      Returns:
      the number of written bytes

    • getCount

      @Deprecated public int getCount()
      Deprecated.
      Description copied from class: ArchiveOutputStream
      Gets the current number of bytes written to this stream.
      Overrides:
      getCount in class ArchiveOutputStream<TarArchiveEntry>
      Returns:
      the number of written bytes

    • getRecordSize

      @Deprecated public int getRecordSize()
      Deprecated.
      Gets the record size being used by this stream's TarBuffer.
      Returns:
      The TarBuffer record size.

    • handleLongName

      private boolean handleLongName(TarArchiveEntry entry, String name, Map<String,String> paxHeaders, String paxHeaderName, byte linkType, String fieldName) throws IOException
      Handles long file or link names according to the longFileMode setting.

      I.e. if the given name is too long to be written to a plain tar header then

      • it creates a pax header who's name is given by the paxHeaderName parameter if longFileMode is POSIX
      • it creates a GNU longlink entry who's type is given by the linkType parameter if longFileMode is GNU
      • it throws an exception if longFileMode is ERROR
      • it truncates the name if longFileMode is TRUNCATE

      Parameters:
      entry - entry the name belongs to
      name - the name to write
      paxHeaders - current map of pax headers
      paxHeaderName - name of the pax header to write
      linkType - type of the GNU entry to write
      fieldName - the name of the field
      Returns:
      whether a pax header has been written.
      Throws:
      IllegalArgumentException - if the longFileMode equals LONGFILE_ERROR and the file name is too long
      IOException

    • padAsNeeded

      private void padAsNeeded() throws IOException
      Throws:
      IOException

    • putArchiveEntry

      public void putArchiveEntry(TarArchiveEntry archiveEntry) throws IOException
      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:
      putArchiveEntry in class ArchiveOutputStream<TarArchiveEntry>
      Parameters:
      archiveEntry - The TarEntry to be written to the archive.
      Throws:
      IOException - on error
      ClassCastException - if archiveEntry is not an instance of TarArchiveEntry
      IllegalArgumentException - if the longFileMode equals LONGFILE_ERROR and the file name is too long
      IllegalArgumentException - if the bigNumberMode equals BIGNUMBER_ERROR and one of the numeric values exceeds the limits of a traditional tar header.

    • setAddPaxHeadersForNonAsciiNames

      public void setAddPaxHeadersForNonAsciiNames(boolean b)
      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

      public void setBigNumberMode(int bigNumberMode)
      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

      public void setLongFileMode(int longFileMode)
      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

    • shouldBeReplaced

      private boolean shouldBeReplaced(char c)
      Tests whether the character could lead to problems when used inside a TarArchiveEntry name for a PAX header.
      Returns:
      true if the character could lead to problems when used inside a TarArchiveEntry name for a PAX header.

    • stripTo7Bits

      private String stripTo7Bits(String name)

    • transferModTime

      private void transferModTime(TarArchiveEntry from, TarArchiveEntry to)

    • write

      public void write(byte[] wBuf, int wOffset, int numToWrite) throws IOException
      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:
      write in class FilterOutputStream
      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

    • writeEOFRecord

      private void writeEOFRecord() throws IOException
      Writes an EOF (end of archive) record to the tar archive. An EOF record consists of a record of all zeros.
      Throws:
      IOException

    • writePaxHeaders

      void writePaxHeaders(TarArchiveEntry entry, String entryName, Map<String,String> headers) throws IOException
      Writes a PAX extended header with the given map as contents.
      Throws:
      IOException
      Since:
      1.4

    • writeRecord

      private void writeRecord(byte[] record) throws IOException
      Writes an archive record to the archive.
      Parameters:
      record - The record data to write to the archive.
      Throws:
      IOException - on error