Generator for producing filtered literal data packets which are automatically canonicalized.

PGPCanonicalizedDataGenerator 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 originating data to be written is known in advance, use open(OutputStream, char, String, 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 PGPCanonicalizedDataGenerator 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.

Modifier and Type	Class and Description
private static class	PGPCanonicalizedDataGenerator.ArrayCRLFGeneratorStream
pack-priv static class	PGPCanonicalizedDataGenerator.CRLFGeneratorStream
private static class	PGPCanonicalizedDataGenerator.ErasableOutputStream
private static class	PGPCanonicalizedDataGenerator.FileCRLFGeneratorStream
private static class	PGPCanonicalizedDataGenerator.IndefiniteCRLFGeneratorStream

Field Summary

Modifier and Type	Field and Description
public static final String	CONSOLE The special name indicating a "for your eyes only" packet.
private PGPLiteralDataGenerator	lGen
public static final Date	NOW The special time for a modification time of "now" or the present time.
private boolean	oldFormat
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	PGPCanonicalizedDataGenerator() Constructs a generator for literal data objects.
public	PGPCanonicalizedDataGenerator(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 `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. modificationTime) Open a literal data packet, returning a stream to store the data inside the packet.
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 `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. modificationTime, File backingFile) 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 `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 `TEXT` or `UTF8`). format, File the file to determine the filename from. file) Open a literal data packet for the passed in File object, returning an output stream for saving the file contents.

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

Field Detail

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

lGen	back to summary
private PGPLiteralDataGenerator lGen

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

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

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

PGPCanonicalizedDataGenerator back to summary

PGPCanonicalizedDataGenerator	back to summary
public PGPCanonicalizedDataGenerator(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 PGPCanonicalizedDataGenerator(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, 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 `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.

public OutputStream open(OutputStream out, char format, String name, 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 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.

open back to summary

open	back to summary
public OutputStream open(OutputStream out, char format, String name, Date modificationTime, File backingFile) 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 `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.

public OutputStream open(OutputStream out, char format, String name, Date modificationTime, File backingFile) 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 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.

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 `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 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 `TEXT` or `UTF8`). file:File the file to determine the 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 TEXT or UTF8).
file:File: the file to determine the 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.

org.bouncycastle.openpgp back to summary

private Class PGPCanonicalizedDataGenerator.ArrayCRLFGeneratorStream

Class Inheritance

extends CRLFGeneratorStream

java.lang.Object
java.io.OutputStream
org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream
org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.ArrayCRLFGeneratorStream

Field Summary

Modifier and Type	Field and Description
private final char	format
private final PGPLiteralDataGenerator	lGen
private final Date	modificationTime
private final String	name
private final OutputStream	out

Inherited from org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream:: crlfOut

Constructor Summary

Access	Constructor and Description
public	ArrayCRLFGeneratorStream(OutputStream out, PGPLiteralDataGenerator sGen, char format, String name, Date modificationTime)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.

Inherited from org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream:: write

Field Detail

format	back to summary
private final char format

lGen	back to summary
private final PGPLiteralDataGenerator lGen

modificationTime	back to summary
private final Date modificationTime

name	back to summary
private final String name

out	back to summary
private final OutputStream out

Constructor Detail

ArrayCRLFGeneratorStream	back to summary
public ArrayCRLFGeneratorStream(OutputStream out, PGPLiteralDataGenerator sGen, char format, String name, Date modificationTime)

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Overrides org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream.close. Implements java.io.Closeable.close. Doc from java.io.OutputStream.close. Closes this output stream and releases any system resources associated with this stream. The general contract of `close` is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened. Exceptions IOException: if an I/O error occurs.

public void close() throws IOException

Overrides org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Exceptions

IOException:: if an I/O error occurs.

org.bouncycastle.openpgp back to summary

pack-priv Class PGPCanonicalizedDataGenerator.CRLFGeneratorStream

Class Inheritance

extends OutputStream

java.lang.Object
java.io.OutputStream
org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream

Known Direct Subclasses

org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.FileCRLFGeneratorStream, org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.IndefiniteCRLFGeneratorStream, org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.ArrayCRLFGeneratorStream

Field Summary

Modifier and Type	Field and Description
protected final OutputStream	crlfOut
private final boolean	isBinary
private int	lastB

Constructor Summary

Access	Constructor and Description
public	CRLFGeneratorStream(OutputStream crlfOut, boolean isBinary)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.
public void	write(int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.

Inherited from java.io.OutputStream:: flush nullOutputStream write write

Field Detail

crlfOut	back to summary
protected final OutputStream crlfOut

isBinary	back to summary
private final boolean isBinary

lastB	back to summary
private int lastB

Constructor Detail

CRLFGeneratorStream	back to summary
public CRLFGeneratorStream(OutputStream crlfOut, boolean isBinary)

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Doc from java.io.OutputStream.close. Closes this output stream and releases any system resources associated with this stream. The general contract of `close` is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened. Exceptions IOException: if an I/O error occurs.

public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(int b) throws IOException Implements abstract java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes the specified byte to this output stream. The general contract for `write` is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument `b`. The 24 high-order bits of `b` are ignored. Parameters b:int the `byte`. Exceptions IOException: if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.

public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters

b:int: the byte.

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

Access	Constructor and Description
public	ErasableOutputStream()

Modifier and Type	Method and Description
public void	erase()
public byte[]	getBuf()

ErasableOutputStream	back to summary
public ErasableOutputStream()

erase	back to summary
public void erase()

getBuf	back to summary
public byte[] getBuf()

org.bouncycastle.openpgp back to summary

private Class PGPCanonicalizedDataGenerator.FileCRLFGeneratorStream

Class Inheritance

extends CRLFGeneratorStream

java.lang.Object
java.io.OutputStream
org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream
org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.FileCRLFGeneratorStream

Field Summary

Modifier and Type	Field and Description
private final File	backingFile
private final char	format
private final PGPLiteralDataGenerator	lGen
private final Date	modificationTime
private final String	name
private final OutputStream	out

Inherited from org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream:: crlfOut

Constructor Summary

Access	Constructor and Description
public	FileCRLFGeneratorStream(OutputStream out, PGPLiteralDataGenerator sGen, char format, String name, Date modificationTime, File backingFile)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.

Inherited from org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream:: write

Field Detail

backingFile	back to summary
private final File backingFile

format	back to summary
private final char format

lGen	back to summary
private final PGPLiteralDataGenerator lGen

modificationTime	back to summary
private final Date modificationTime

name	back to summary
private final String name

out	back to summary
private final OutputStream out

Constructor Detail

FileCRLFGeneratorStream	back to summary
public FileCRLFGeneratorStream(OutputStream out, PGPLiteralDataGenerator sGen, char format, String name, Date modificationTime, File backingFile) throws FileNotFoundException

Method Detail

close back to summary

public void close() throws IOException

Overrides org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Exceptions

IOException:: if an I/O error occurs.

org.bouncycastle.openpgp back to summary

private Class PGPCanonicalizedDataGenerator.IndefiniteCRLFGeneratorStream

Class Inheritance

extends CRLFGeneratorStream

java.lang.Object
java.io.OutputStream
org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream
org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.IndefiniteCRLFGeneratorStream

Field Summary

Inherited from org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream:: crlfOut

Constructor Summary

Access	Constructor and Description
public	IndefiniteCRLFGeneratorStream(OutputStream out, PGPLiteralDataGenerator sGen, char format, String name, Date modificationTime, byte[] buffer)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.

Inherited from org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream:: write

Constructor Detail

IndefiniteCRLFGeneratorStream	back to summary
public IndefiniteCRLFGeneratorStream(OutputStream out, PGPLiteralDataGenerator sGen, char format, String name, Date modificationTime, byte[] buffer) throws IOException

Method Detail

close back to summary

public void close() throws IOException

Overrides org.bouncycastle.openpgp.PGPCanonicalizedDataGenerator.CRLFGeneratorStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Exceptions

IOException:: if an I/O error occurs.

public Class PGPCanonicalizedDataGenerator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PGPCanonicalizedDataGenerator.ArrayCRLFGeneratorStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class PGPCanonicalizedDataGenerator.CRLFGeneratorStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class PGPCanonicalizedDataGenerator.ErasableOutputStream

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class PGPCanonicalizedDataGenerator.FileCRLFGeneratorStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PGPCanonicalizedDataGenerator.IndefiniteCRLFGeneratorStream

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail