Bouncy Castle Cryptography Library 1.80 · org.bouncycastle.bcpg.BCPGOutputStream

Modifier and Type	Field and Description
private static final int	BUF_SIZE_POWER
pack-priv OutputStream	out
private PacketFormat	packetFormat
private byte[]	partialBuffer
private int	partialBufferLength
private int	partialOffset
private int	partialPower

Access	Constructor and Description
public	BCPGOutputStream(OutputStream output stream to write encoded data to. out) Base constructor - generate a PGP protocol encoding with old-style packets whenever there is an alternative for backwards compatibility.
public	BCPGOutputStream(OutputStream output stream to write encoded data to. out, boolean true if use new format packets, false if backwards compatible preferred. newFormatOnly) Base constructor specifying whether to use packets in the new format wherever possible.
public	BCPGOutputStream(OutputStream out, PacketFormat packetFormat)
public	BCPGOutputStream(OutputStream out, int the packet tag for the object. tag) Create a stream representing an old style partial object.
public	BCPGOutputStream(OutputStream out, int tag, long length, boolean oldFormat) Create a stream representing a general packet.
public	BCPGOutputStream(OutputStream out, int tag, long length)
public	BCPGOutputStream(OutputStream output stream to write to. out, int packet tag. tag, byte[] size of chunks making up the packet. buffer) Create a new style partial input stream buffered into chunks.

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	finish() Finish writing out the current packet without closing the underlying stream.
public void	flush() Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Flush the underlying stream.
private void	partialFlush(boolean isLast)
public static BCPGOutputStream	Returns: BCPGOutputStream wrap(OutputStream output stream out) If the argument is a `BCPGOutputStream`, return it.
public void	write(int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.
public void	write(byte[] the data. bytes, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.
private void	writeHeader(int tag, boolean oldPackets, boolean partial, long bodyLen)
public void	writeObject(BCPGObject o)
public void	writePacket(ContainedPacket packet p) Write a packet to the stream.
pack-priv void	writePacket(int packet tag tag, byte[] packet body body) Write a packet to the stream.
pack-priv void	writePacket(boolean whether the packet prefers to be encoded using the new packet format objectPrefersNewPacketFormat, int packet tag tag, byte[] packet body body) Write a packet.
pack-priv void	writePacket(int packet tag tag, byte[] packet body body, boolean if true, old format is forced, else force new format oldFormat) Write a packet, forcing the packet format to be either old or new.
private void	writePartial(byte b)
private void	writePartial(byte[] buf, int off, int len)

Inherited from java.io.OutputStream:: nullOutputStream write

Field Detail

BUF_SIZE_POWER	back to summary
private static final int BUF_SIZE_POWER

out	back to summary
pack-priv OutputStream out

packetFormat	back to summary
private PacketFormat packetFormat

partialBuffer	back to summary
private byte[] partialBuffer

partialBufferLength	back to summary
private int partialBufferLength

partialOffset	back to summary
private int partialOffset

partialPower	back to summary
private int partialPower

Constructor Detail

BCPGOutputStream	back to summary
public BCPGOutputStream(OutputStream out) Base constructor - generate a PGP protocol encoding with old-style packets whenever there is an alternative for backwards compatibility. Parameters out:OutputStream output stream to write encoded data to.

BCPGOutputStream

back to summary

public BCPGOutputStream(OutputStream out)

Base constructor - generate a PGP protocol encoding with old-style packets whenever there is an alternative for backwards compatibility.

Parameters

out:OutputStream: output stream to write encoded data to.

BCPGOutputStream	back to summary
public BCPGOutputStream(OutputStream out, boolean newFormatOnly) Base constructor specifying whether to use packets in the new format wherever possible. Parameters out:OutputStream output stream to write encoded data to. newFormatOnly:boolean true if use new format packets, false if backwards compatible preferred.

BCPGOutputStream

back to summary

public BCPGOutputStream(OutputStream out, boolean newFormatOnly)

Base constructor specifying whether to use packets in the new format wherever possible.

Parameters

out:OutputStream: output stream to write encoded data to.
newFormatOnly:boolean: true if use new format packets, false if backwards compatible preferred.

BCPGOutputStream	back to summary
public BCPGOutputStream(OutputStream out, PacketFormat packetFormat)

BCPGOutputStream	back to summary
public BCPGOutputStream(OutputStream out, int tag) throws IOException Create a stream representing an old style partial object. Parameters tag:int the packet tag for the object.

BCPGOutputStream

back to summary

public BCPGOutputStream(OutputStream out, int tag) throws IOException

Create a stream representing an old style partial object.

Parameters

tag:int: the packet tag for the object.

BCPGOutputStream	back to summary
public BCPGOutputStream(OutputStream out, int tag, long length, boolean oldFormat) throws IOException Create a stream representing a general packet.

BCPGOutputStream	back to summary
public BCPGOutputStream(OutputStream out, int tag, long length) throws IOException

BCPGOutputStream	back to summary
public BCPGOutputStream(OutputStream out, int tag, byte[] buffer) throws IOException Create a new style partial input stream buffered into chunks. Parameters out:OutputStream output stream to write to. tag:int packet tag. buffer:byte[] size of chunks making up the packet.

BCPGOutputStream

back to summary

public BCPGOutputStream(OutputStream out, int tag, byte[] buffer) throws IOException

Create a new style partial input stream buffered into chunks.

Parameters

out:OutputStream: output stream to write to.
tag:int: packet tag.
buffer:byte[]: size of chunks making up the packet.

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.

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.

finish	back to summary
public void finish() throws IOException Finish writing out the current packet without closing the underlying stream.

flush	back to summary
public void flush() throws IOException Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Flush the underlying stream. Exceptions IOException: Doc from java.io.OutputStream.flush. if an I/O error occurs.

flush

back to summary

public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Flush the underlying stream.

Exceptions

IOException:

Doc from java.io.OutputStream.flush.

if an I/O error occurs.

partialFlush	back to summary
private void partialFlush(boolean isLast) throws IOException

wrap back to summary

wrap	back to summary
public static BCPGOutputStream wrap(OutputStream out) If the argument is a `BCPGOutputStream`, return it. Otherwise wrap it in a `BCPGOutputStream` and then return the result. Parameters out:OutputStream output stream Returns:BCPGOutputStream BCPGOutputStream

public static BCPGOutputStream wrap(OutputStream out)

If the argument is a BCPGOutputStream, return it. Otherwise wrap it in a BCPGOutputStream and then return the result.

Parameters

out:OutputStream: output stream

Returns:BCPGOutputStream

BCPGOutputStream

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.

write back to summary

write	back to summary
public void write(byte[] bytes, int off, int len) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream. The general contract for `write(b, off, len)` is that some of the bytes in the array `b` are written to the output stream in order; element `b[off]` is the first byte written and `b[off+len-1]` is the last byte written by this operation. If `b` is `null`, a `NullPointerException` is thrown. If `off` is negative, or `len` is negative, or `off+len` is greater than the length of the array `b`, then an `IndexOutOfBoundsException` is thrown. Parameters bytes:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Exceptions IOException: if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.

public void write(byte[] bytes, int off, int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters

bytes:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

writeHeader	back to summary
private void writeHeader(int tag, boolean oldPackets, boolean partial, long bodyLen) throws IOException

writeObject	back to summary
public void writeObject(BCPGObject o) throws IOException

writePacket	back to summary
public void writePacket(ContainedPacket p) throws IOException Write a packet to the stream. Parameters p:ContainedPacket packet

writePacket

back to summary

public void writePacket(ContainedPacket p) throws IOException

Write a packet to the stream.

Parameters

p:ContainedPacket: packet

writePacket back to summary

writePacket	back to summary
pack-priv void writePacket(int tag, byte[] body) throws IOException Write a packet to the stream. The packet will use the old encoding format if `packetFormat` is `PacketFormat#LEGACY`, otherwise it will be encoded using the new packet format. Parameters tag:int packet tag body:byte[] packet body

pack-priv void writePacket(int tag, byte[] body) throws IOException

Write a packet to the stream. The packet will use the old encoding format if packetFormat is PacketFormat#LEGACY, otherwise it will be encoded using the new packet format.

Parameters

tag:int: packet tag
body:byte[]: packet body

writePacket back to summary

writePacket	back to summary
pack-priv void writePacket(boolean objectPrefersNewPacketFormat, int tag, byte[] body) throws IOException Write a packet. The packet format will be chosen primarily based on `packetFormat`. If `packetFormat` is `PacketFormat#CURRENT`, the packet will be encoded using the new format. If it is `PacketFormat#LEGACY`, the packet will use old encoding format. If it is `PacketFormat#ROUNDTRIP`, then the format will be determined by objectPrefersNewPacketFormat. Parameters objectPrefersNewPacketFormat:boolean whether the packet prefers to be encoded using the new packet format tag:int packet tag body:byte[] packet body

pack-priv void writePacket(boolean objectPrefersNewPacketFormat, int tag, byte[] body) throws IOException

Write a packet. The packet format will be chosen primarily based on packetFormat. If packetFormat is PacketFormat#CURRENT, the packet will be encoded using the new format. If it is PacketFormat#LEGACY, the packet will use old encoding format. If it is PacketFormat#ROUNDTRIP, then the format will be determined by objectPrefersNewPacketFormat.

Parameters

objectPrefersNewPacketFormat:boolean: whether the packet prefers to be encoded using the new packet format
tag:int: packet tag
body:byte[]: packet body

writePacket	back to summary
pack-priv void writePacket(int tag, byte[] body, boolean oldFormat) throws IOException Write a packet, forcing the packet format to be either old or new. Parameters tag:int packet tag body:byte[] packet body oldFormat:boolean if true, old format is forced, else force new format

writePacket

back to summary

pack-priv void writePacket(int tag, byte[] body, boolean oldFormat) throws IOException

Write a packet, forcing the packet format to be either old or new.

Parameters

tag:int: packet tag
body:byte[]: packet body
oldFormat:boolean: if true, old format is forced, else force new format

writePartial	back to summary
private void writePartial(byte b) throws IOException

writePartial	back to summary
private void writePartial(byte[] buf, int off, int len) throws IOException

public Class BCPGOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail