Note that this class is not a java.io.FileOutputStream, because our goal is to greatly restrict the public methods of FileOutputStream, yet we must use public methods of the underlying FileOutputStream internally. Can't accomplish these goals in Java if we subclass.

This class is ignorant about Tar header fields, attributes and such. It is concerned with reading and writing blocks of data in conformance with Tar formatting, in a way convenient to those who want to write the header and data blocks.

Users write file data by means of populating the provided, public byte array, then calling the single write(int) method to write a portion of that array. This design purposefully goes with efficiency, simplicity, and performance over Java convention, which would not use public fields.

At this time, we do not support appending. That would greatly decrease the generality and simplicity of the our design, since appending is trivial without compression and very difficult with compression.

Users must finish tar file creation by using the finish() method. Just like a normal OutputStream, if processing is aborted for any reason, the close() method must be used to free up system resources.

Security Note

Due to pitiful lack of support for file security in Java before version 1.6, this class will only explicitly set permissions if it is compiled for Java 1.6. If it was not, and if your tar entries contain private data in files with 0400 or similar, be aware that that file can be pretty much be extracted by anybody with access to the tar file.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	TarFileOutputStream.Compression

Field Summary

Modifier and Type	Field and Description
protected int	blocksPerRecord
protected long	bytesWritten
public static final boolean	debug
private final File	targetFile
public byte[]	writeBuffer
private final File	writeFile
private OutputStream	writeStream
pack-priv static final byte[]	ZERO_BLOCK

Constructor Summary

Access	Constructor and Description
public	TarFileOutputStream(File File targetFile) Convenience wrapper to use default blocksPerRecord and compressionType.
public	TarFileOutputStream(File File targetFile, int int compressionType) Convenience wrapper to use default blocksPerRecord.
public	TarFileOutputStream(File File targetFile, int int compressionType, int int blocksPerRecord) This class does no validation or enforcement of file naming conventions.

Method Summary

Modifier and Type	Method and Description
public void	assertAtBlockBoundary()
public int	bytesLeftInBlock()
public void	close() Implements java.io.Closeable.
public void	finish() (Only) when this method returns successfully, the generated file will be a valid tar file.
public void	flush() Implements java.io.Flushable.
public long	getBytesWritten()
public void	padCurrentBlock() Rounds out the current block to the next block boundary.
public void	write(byte[] byte[] byteArray, int int byteCount) This class and subclasses should write to the underlying writeStream ONLY WITH THIS METHOD.
public void	write(int int byteCount) The normal way to write file data (as opposed to header data or padding) using this class.
public void	writeBlock(byte[] byte[] block) Write a user-specified 512-byte block.
public void	writePadBlock() Writes a single zero'd block.
public void	writePadBlocks(int int blockCount) Writes the specified quantity of zero'd blocks.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

blocksPerRecord	back to summary
protected int blocksPerRecord

bytesWritten	back to summary
protected long bytesWritten

debug	back to summary
public static final boolean debug

targetFile	back to summary
private final File targetFile

writeBuffer	back to summary
public byte[] writeBuffer

writeFile	back to summary
private final File writeFile

writeStream	back to summary
private OutputStream writeStream

ZERO_BLOCK	back to summary
pack-priv static final byte[] ZERO_BLOCK

Constructor Detail

TarFileOutputStream back to summary

TarFileOutputStream	back to summary
public TarFileOutputStream(File targetFile) throws IOException Convenience wrapper to use default blocksPerRecord and compressionType. Parameters targetFile:File File Exceptions IOException: on failure See Also `TarFileOutputStream(File, int, int)`

public TarFileOutputStream(File targetFile) throws IOException

Convenience wrapper to use default blocksPerRecord and compressionType.

Parameters

targetFile:File: File

Exceptions

IOException:: on failure

See Also

TarFileOutputStream(File, int, int)

TarFileOutputStream back to summary

TarFileOutputStream	back to summary
public TarFileOutputStream(File targetFile, int compressionType) throws IOException Convenience wrapper to use default blocksPerRecord. Parameters targetFile:File File compressionType:int int Exceptions IOException: on failure See Also `TarFileOutputStream(File, int, int)`

public TarFileOutputStream(File targetFile, int compressionType) throws IOException

Convenience wrapper to use default blocksPerRecord.

Parameters

targetFile:File: File
compressionType:int: int

Exceptions

IOException:: on failure

See Also

TarFileOutputStream(File, int, int)

TarFileOutputStream	back to summary
public TarFileOutputStream(File targetFile, int compressionType, int blocksPerRecord) throws IOException This class does no validation or enforcement of file naming conventions. If desired, the caller should enforce extensions like "tar" and "tar.gz" (and that they match the specified compression type). It also overwrites files without warning (just like FileOutputStream). Parameters targetFile:File File compressionType:int int blocksPerRecord:int int Exceptions IOException: on failure

TarFileOutputStream

back to summary

public TarFileOutputStream(File targetFile, int compressionType, int blocksPerRecord) throws IOException

This class does no validation or enforcement of file naming conventions. If desired, the caller should enforce extensions like "tar" and "tar.gz" (and that they match the specified compression type). It also overwrites files without warning (just like FileOutputStream).

Parameters

targetFile:File: File
compressionType:int: int
blocksPerRecord:int: int

Exceptions

IOException:: on failure

Method Detail

assertAtBlockBoundary	back to summary
public void assertAtBlockBoundary() Exceptions IllegalStateException: if end of file not on a block boundary.

bytesLeftInBlock	back to summary
public int bytesLeftInBlock()

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable. Important Note This method deletes the work file after closing it! Exceptions IOException: on failure See Also `java.io.Closeable`

public void close() throws IOException

Implements java.io.Closeable.

Important Note

This method deletes the work file after closing it!

Exceptions

IOException:: on failure

See Also

java.io.Closeable

finish back to summary

finish	back to summary
public void finish() throws IOException (Only) when this method returns successfully, the generated file will be a valid tar file. This method always performs a close, so you never need to call the close if your code makes it to this method. (You do need to call close if processing is aborted before calling finish()). Exceptions IOException: on failure See Also `close`

public void finish() throws IOException

(Only) when this method returns successfully, the generated file will be a valid tar file. This method always performs a close, so you never need to call the close if your code makes it to this method. (You do need to call close if processing is aborted before calling finish()).

Exceptions

IOException:: on failure

See Also

close

flush back to summary

flush	back to summary
public void flush() throws IOException Implements java.io.Flushable. Exceptions IOException: on failure See Also `java.io.Flushable`

public void flush() throws IOException

Implements java.io.Flushable.

Exceptions

IOException:: on failure

See Also

java.io.Flushable

getBytesWritten	back to summary
public long getBytesWritten()

padCurrentBlock	back to summary
public void padCurrentBlock() throws IOException Rounds out the current block to the next block boundary. If we are currently at a block boundary, nothing is done. Exceptions IOException: on failure

padCurrentBlock

back to summary

public void padCurrentBlock() throws IOException

Rounds out the current block to the next block boundary. If we are currently at a block boundary, nothing is done.

Exceptions

IOException:: on failure

write	back to summary
public void write(byte[] byteArray, int byteCount) throws IOException This class and subclasses should write to the underlying writeStream ONLY WITH THIS METHOD. That way we can be confident that bytesWritten will always be accurate. Parameters byteArray:byte[] byte[] byteCount:int int Exceptions IOException: on failure

write

back to summary

public void write(byte[] byteArray, int byteCount) throws IOException

This class and subclasses should write to the underlying writeStream ONLY WITH THIS METHOD. That way we can be confident that bytesWritten will always be accurate.

Parameters

byteArray:byte[]: byte[]
byteCount:int: int

Exceptions

IOException:: on failure

write	back to summary
public void write(int byteCount) throws IOException The normal way to write file data (as opposed to header data or padding) using this class. Parameters byteCount:int int Exceptions IOException: on failure

write

back to summary

public void write(int byteCount) throws IOException

The normal way to write file data (as opposed to header data or padding) using this class.

Parameters

byteCount:int: int

Exceptions

IOException:: on failure

writeBlock back to summary

writeBlock	back to summary
public void writeBlock(byte[] block) throws IOException Write a user-specified 512-byte block. For efficiency, write(int) should be used when writing file body content. Parameters block:byte[] byte[] Exceptions IOException: on failure See Also `write(int)`

public void writeBlock(byte[] block) throws IOException

Write a user-specified 512-byte block. For efficiency, write(int) should be used when writing file body content.

Parameters

block:byte[]: byte[]

Exceptions

IOException:: on failure

See Also

write(int)

writePadBlock	back to summary
public void writePadBlock() throws IOException Writes a single zero'd block. Exceptions IOException: on failure

writePadBlock

back to summary

public void writePadBlock() throws IOException

Writes a single zero'd block.

Exceptions

IOException:: on failure

writePadBlocks	back to summary
public void writePadBlocks(int blockCount) throws IOException Writes the specified quantity of zero'd blocks. Parameters blockCount:int int Exceptions IOException: on failure

writePadBlocks

back to summary

public void writePadBlocks(int blockCount) throws IOException

Writes the specified quantity of zero'd blocks.

Parameters

blockCount:int: int

Exceptions

IOException:: on failure

org.hsqldb.lib.tar back to summary

public Interface TarFileOutputStream.Compression

Field Summary

Modifier and Type	Field and Description
public static final int	DEFAULT_BLOCKS_PER_RECORD
public static final int	DEFAULT_COMPRESSION
public static final int	GZIP_COMPRESSION
public static final int	NO_COMPRESSION

Field Detail

DEFAULT_BLOCKS_PER_RECORD	back to summary
public static final int DEFAULT_BLOCKS_PER_RECORD

DEFAULT_COMPRESSION	back to summary
public static final int DEFAULT_COMPRESSION

GZIP_COMPRESSION	back to summary
public static final int GZIP_COMPRESSION

NO_COMPRESSION	back to summary
public static final int NO_COMPRESSION

public Class TarFileOutputStream

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface TarFileOutputStream.Compression

Field Summary

Field Detail