org.bouncycastle.openpgp

Class PGPLiteralDataGenerator

public class PGPLiteralDataGenerator extends Object implements StreamGenerator

Class for producing literal data packets.
Field Summary
static charBINARY
static StringCONSOLE
The special name indicating a "for your eyes only" packet.
static DateNOW
The special time for a modification time of "now" or the present time.
static charTEXT
Constructor Summary
PGPLiteralDataGenerator()
PGPLiteralDataGenerator(boolean oldFormat)
Generates literal data objects in the old format, this is important if you need compatability with PGP 2.6.x.
Method Summary
voidclose()
Close the literal data packet - this is equivalent to calling close on the stream returned by the open() method.
OutputStreamopen(OutputStream out, char format, String name, long length, Date modificationTime)
Open a literal data packet, returning a stream to store the data inside the packet.
OutputStreamopen(OutputStream out, char format, String name, Date modificationTime, byte[] buffer)
Open a literal data packet, returning a stream to store the data inside the packet as an indefiinite length stream.
OutputStreamopen(OutputStream out, char format, File file)
Open a literal data packet for the passed in File object, returning an output stream for saving the file contents.

Field Detail

BINARY

public static final char BINARY

CONSOLE

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

NOW

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

TEXT

public static final char TEXT

Constructor Detail

PGPLiteralDataGenerator

public PGPLiteralDataGenerator()

PGPLiteralDataGenerator

public PGPLiteralDataGenerator(boolean oldFormat)
Generates literal data objects in the old format, this is important if you need compatability with PGP 2.6.x.

Parameters: oldFormat

Method Detail

close

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

Throws: IOException

open

public OutputStream open(OutputStream out, char format, String name, long length, Date modificationTime)
Open a literal data packet, returning a stream to store the data inside the packet. The stream can be closed off by either calling close() on the stream or close() on the generator.

Parameters: out the stream we want the packet in format the format we are using name the name of the "file" length the length of the data we will write modificationTime the time of last modification we want stored.

open

public OutputStream open(OutputStream out, char format, String name, Date modificationTime, byte[] buffer)
Open a literal data packet, returning a stream to store the data inside the packet as an indefiinite 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 can be closed off by either calling close() on the stream or close() on the generator.

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 the stream we want the packet in format the format we are using name the name of the "file" modificationTime the time of last modification we want stored. buffer the buffer to use for collecting data to put into chunks.

open

public OutputStream open(OutputStream out, char format, File file)
Open a literal data packet for the passed in File object, returning an output stream for saving the file contents. The stream can be closed off by either calling close() on the stream or close() on the generator.

Parameters: out format file

Returns: OutputStream

Throws: IOException