Bouncy Castle Cryptography Library 1.80 · org.bouncycastle.openpgp.PGPLiteralDataGenerator

Generator for producing literal data packets.

A PGPLiteralData is used by invoking one of the open functions to create an OutputStream that raw data can be supplied to for encoding:

If the length of the data to be written is known in advance, use open(OutputStream, char, String, long, Date) to create a packet containing a single literal data object.
If the length of the data is unknown, use open(OutputStream, char, String, Date, byte[]) to create a packet consisting of a series of literal data objects (partials).

A PGPLiteralDataGenerator is usually used to wrap the OutputStream obtained from a PGPEncryptedDataGenerator or a PGPCompressedDataGenerator.

Once literal data has been written to the constructed OutputStream, writing of the object stream is completed by closing the OutputStream obtained from the open() method, or equivalently invoking close() on this generator.

Field Summary

Modifier and Type	Field and Description
public static final char	BINARY Format tag for binary literal data
public static final String	CONSOLE The special name indicating a "for your eyes only" packet.
public static final Date	NOW The special time for a modification time of "now" or the present time.
private boolean	oldFormat
private BCPGOutputStream	pkOut
public static final char	TEXT Format tag for textual literal data
public static final char	UTF8 Format tag for UTF-8 encoded textual literal data

Constructor Summary

Access	Constructor and Description
public	PGPLiteralDataGenerator() Constructs a generator for literal data objects.
public	PGPLiteralDataGenerator(boolean `true` to use PGP 2.6.x compatible format. oldFormat) Constructs a generator for literal data objects, specifying to use new or old (PGP 2.6.x compatible) format.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements org.bouncycastle.openpgp.StreamGenerator.close. Close the literal data packet - this is equivalent to calling close on the stream returned by the open() method.
public OutputStream	open(OutputStream the underlying output stream to write the literal data packet to. out, char the format of the literal data that will be written to the output stream (one of `BINARY`, `TEXT` or `UTF8`). format, String the name of the "file" to encode in the literal data object. name, long the length of the data that will be written. length, Date the time of last modification we want stored. modificationTime) Open a literal data packet, returning a stream to store the data inside the packet.
public OutputStream	Returns: the output stream to write data to. open(OutputStream the underlying output stream to write the literal data packet to. out, char the format of the literal data that will be written to the output stream (one of `BINARY`, `TEXT` or `UTF8`). format, String the name of the "file" to encode in the literal data object. name, Date the time of last modification we want stored (will be stored to second level precision). modificationTime, byte[] a buffer to use to buffer and write partial packets. The returned stream takes ownership of the buffer. buffer) Open a literal data packet, returning a stream to store the data inside the packet as an indefinite-length stream.
public OutputStream	Returns: the output stream to write data to. open(OutputStream the underlying output stream to write the literal data packet to. out, char the format of the literal data that will be written to the output stream (one of `BINARY`, `TEXT` or `UTF8`). format, File the file to determine the length and filename from. file) Open a literal data packet for the passed in File object, returning an output stream for saving the file contents.
private void	writeHeader(OutputStream out, char format, byte[] encName, long modificationTime)

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

Field Detail

BINARY	back to summary
public static final char BINARY Format tag for binary literal data

CONSOLE	back to summary
public static final String CONSOLE The special name indicating a "for your eyes only" packet.

NOW	back to summary
public static final Date NOW The special time for a modification time of "now" or the present time.

oldFormat	back to summary
private boolean oldFormat

pkOut	back to summary
private BCPGOutputStream pkOut

TEXT	back to summary
public static final char TEXT Format tag for textual literal data

UTF8	back to summary
public static final char UTF8 Format tag for UTF-8 encoded textual literal data

Constructor Detail

PGPLiteralDataGenerator	back to summary
public PGPLiteralDataGenerator() Constructs a generator for literal data objects.

PGPLiteralDataGenerator back to summary

PGPLiteralDataGenerator	back to summary
public PGPLiteralDataGenerator(boolean oldFormat) Constructs a generator for literal data objects, specifying to use new or old (PGP 2.6.x compatible) format. This can be used for compatibility with PGP 2.6.x. Parameters oldFormat:boolean `true` to use PGP 2.6.x compatible format.

public PGPLiteralDataGenerator(boolean oldFormat)

Constructs a generator for literal data objects, specifying to use new or old (PGP 2.6.x compatible) format.

This can be used for compatibility with PGP 2.6.x.

Parameters

oldFormat:boolean: true to use PGP 2.6.x compatible format.

Method Detail

close	back to summary
public void close() throws IOException Implements org.bouncycastle.openpgp.StreamGenerator.close. Close the literal data packet - this is equivalent to calling close on the stream returned by the open() method.

back to summary

public void close() throws IOException

Implements org.bouncycastle.openpgp.StreamGenerator.close.

Close the literal data packet - this is equivalent to calling close on the stream returned by the open() method.

open back to summary

open	back to summary
public OutputStream open(OutputStream out, char format, String name, long length, Date modificationTime) throws IOException Open a literal data packet, returning a stream to store the data inside the packet. The stream created can be closed off by either calling close() on the stream or close() on the generator. Closing the returned stream does not close off the OutputStream parameter out. Parameters out:OutputStream the underlying output stream to write the literal data packet to. format:char the format of the literal data that will be written to the output stream (one of `BINARY`, `TEXT` or `UTF8`). name:String the name of the "file" to encode in the literal data object. length:long the length of the data that will be written. modificationTime:Date the time of last modification we want stored.

public OutputStream open(OutputStream out, char format, String name, long length, Date modificationTime) throws IOException

Open a literal data packet, returning a stream to store the data inside the packet.

The stream created can be closed off by either calling close() on the stream or close() on the generator. Closing the returned stream does not close off the OutputStream parameter out.

Parameters

out:OutputStream: the underlying output stream to write the literal data packet to.
format:char: the format of the literal data that will be written to the output stream (one of BINARY, TEXT or UTF8).
name:String: the name of the "file" to encode in the literal data object.
length:long: the length of the data that will be written.
modificationTime:Date: the time of last modification we want stored.

open back to summary

open	back to summary
public OutputStream open(OutputStream out, char format, String name, Date modificationTime, byte[] buffer) throws IOException Open a literal data packet, returning a stream to store the data inside the packet as an indefinite-length stream. The stream is written out as a series of partial packets with a chunk size determined by the size of the passed in buffer. The stream created can be closed off by either calling close() on the stream or close() on the generator. Closing the returned stream does not close off the OutputStream parameter out. Note if the buffer is not a power of 2 in length only the largest power of 2 bytes worth of the buffer will be used. Parameters out:OutputStream the underlying output stream to write the literal data packet to. format:char the format of the literal data that will be written to the output stream (one of `BINARY`, `TEXT` or `UTF8`). name:String the name of the "file" to encode in the literal data object. modificationTime:Date the time of last modification we want stored (will be stored to second level precision). buffer:byte[] a buffer to use to buffer and write partial packets. The returned stream takes ownership of the buffer. Returns:OutputStream the output stream to write data to. Exceptions IOException: if an error occurs writing stream header information to the provider output stream. IllegalStateException: if this generator already has an open OutputStream.

public OutputStream open(OutputStream out, char format, String name, Date modificationTime, byte[] buffer) throws IOException

Open a literal data packet, returning a stream to store the data inside the packet as an indefinite-length stream. The stream is written out as a series of partial packets with a chunk size determined by the size of the passed in buffer.

The stream created can be closed off by either calling close() on the stream or close() on the generator. Closing the returned stream does not close off the OutputStream parameter out.

Note

if the buffer is not a power of 2 in length only the largest power of 2 bytes worth of the buffer will be used.

Parameters

out:OutputStream: the underlying output stream to write the literal data packet to.
format:char: the format of the literal data that will be written to the output stream (one of BINARY, TEXT or UTF8).
name:String: the name of the "file" to encode in the literal data object.
modificationTime:Date: the time of last modification we want stored (will be stored to second level precision).
buffer:byte[]: a buffer to use to buffer and write partial packets. The returned stream takes ownership of the buffer.

Returns:OutputStream

the output stream to write data to.

Exceptions

IOException:: if an error occurs writing stream header information to the provider output stream.
IllegalStateException:: if this generator already has an open OutputStream.

open back to summary

open	back to summary
public OutputStream open(OutputStream out, char format, File file) throws IOException Open a literal data packet for the passed in File object, returning an output stream for saving the file contents. This method configures the generator to store the file contents in a single literal data packet, taking the filename and modification time from the file, but does not store the actual file data. The stream created can be closed off by either calling close() on the stream or close() on the generator. Closing the returned stream does not close off the OutputStream parameter out. Parameters out:OutputStream the underlying output stream to write the literal data packet to. format:char the format of the literal data that will be written to the output stream (one of `BINARY`, `TEXT` or `UTF8`). file:File the file to determine the length and filename from. Returns:OutputStream the output stream to write data to. Exceptions IOException: if an error occurs writing stream header information to the provider output stream. IllegalStateException: if this generator already has an open OutputStream.

public OutputStream open(OutputStream out, char format, File file) throws IOException

Open a literal data packet for the passed in File object, returning an output stream for saving the file contents.

This method configures the generator to store the file contents in a single literal data packet, taking the filename and modification time from the file, but does not store the actual file data.

The stream created can be closed off by either calling close() on the stream or close() on the generator. Closing the returned stream does not close off the OutputStream parameter out.

Parameters

out:OutputStream: the underlying output stream to write the literal data packet to.
format:char: the format of the literal data that will be written to the output stream (one of BINARY, TEXT or UTF8).
file:File: the file to determine the length and filename from.

Returns:OutputStream

the output stream to write data to.

Exceptions

IOException:: if an error occurs writing stream header information to the provider output stream.
IllegalStateException:: if this generator already has an open OutputStream.

writeHeader	back to summary
private void writeHeader(OutputStream out, char format, byte[] encName, long modificationTime) throws IOException

public Class PGPLiteralDataGenerator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail