org.bouncycastle.openpgp

Class PGPLiteralDataGenerator

Implemented Interfaces:
org.bouncycastle.openpgp.StreamGenerator

public class PGPLiteralDataGenerator
extends java.lang.Object
implements org.bouncycastle.openpgp.StreamGenerator

Class for producing literal data packets.

Field Summary

static char
BINARY
static String
CONSOLE
The special name indicating a "for your eyes only" packet.
static Date
NOW
The special time for a modification time of "now" or the present time.
static char
TEXT

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

void
close()
Close the literal data packet - this is equivalent to calling close on the stream returned by the open() method.
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.
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.
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.

Field Details

BINARY

public static final char BINARY
Field Value:
'b'

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
Field Value:
't'

Constructor Details

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 Details

close

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

open

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. The stream can be closed off by either calling close() on the stream or close() on the generator.
Parameters:
out -
format -
file -
Returns:
OutputStream

open

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 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,
                         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 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.