Package org.bouncycastle.bcpg

Class BCPGOutputStream

java.lang.Object

java.io.OutputStream

org.bouncycastle.bcpg.BCPGOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, CompressionAlgorithmTags, PacketTags

public class BCPGOutputStream
extends OutputStream
implements PacketTags, CompressionAlgorithmTags

Basic output stream.

Field Summary

Fields inherited from interface org.bouncycastle.bcpg.CompressionAlgorithmTags

BZIP2, UNCOMPRESSED, ZIP, ZLIB

Fields inherited from interface org.bouncycastle.bcpg.PacketTags

AEAD_ENC_DATA, COMPRESSED_DATA, EXPERIMENTAL_1, EXPERIMENTAL_2, EXPERIMENTAL_3, EXPERIMENTAL_4, LITERAL_DATA, MARKER, MOD_DETECTION_CODE, ONE_PASS_SIGNATURE, PADDING, PUBLIC_KEY, PUBLIC_KEY_ENC_SESSION, PUBLIC_SUBKEY, RESERVED, SECRET_KEY, SECRET_SUBKEY, SIGNATURE, SYM_ENC_INTEGRITY_PRO, SYMMETRIC_KEY_ENC, SYMMETRIC_KEY_ENC_SESSION, TRUST, USER_ATTRIBUTE, USER_ID

Constructor Summary

Constructors

Constructor	Description
BCPGOutputStream(OutputStream out)	Base constructor - generate a PGP protocol encoding with old-style packets whenever there is an alternative for backwards compatibility.
BCPGOutputStream(OutputStream out, boolean newFormatOnly)	Base constructor specifying whether to use packets in the new format wherever possible.
BCPGOutputStream(OutputStream out, int tag)	Create a stream representing an old style partial object.
BCPGOutputStream(OutputStream out, int tag, byte[] buffer)	Create a new style partial input stream buffered into chunks.
BCPGOutputStream(OutputStream out, int tag, long length)
BCPGOutputStream(OutputStream out, int tag, long length, boolean oldFormat)	Create a stream representing a general packet.
BCPGOutputStream(OutputStream out, PacketFormat packetFormat)

Method Summary

Modifier and Type	Method	Description
void	close()
void	finish()	Finish writing out the current packet without closing the underlying stream.
void	flush()	Flush the underlying stream.
static BCPGOutputStream	wrap(OutputStream out)	If the argument is a BCPGOutputStream, return it.
void	write(byte[] bytes, int off, int len)
void	write(int b)
void	writeObject(BCPGObject o)
void	writePacket(ContainedPacket p)	Write a packet to the stream.

Methods inherited from class java.io.OutputStream

nullOutputStream, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BCPGOutputStream

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 - output stream to write encoded data to.

BCPGOutputStream

public BCPGOutputStream(OutputStream out,
 boolean newFormatOnly)

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

Parameters:

out - output stream to write encoded data to.

newFormatOnly - true if use new format packets, false if backwards compatible preferred.

BCPGOutputStream

public BCPGOutputStream(OutputStream out,
 PacketFormat packetFormat)

BCPGOutputStream

public BCPGOutputStream(OutputStream out,
 int tag)
                 throws IOException

Create a stream representing an old style partial object.

Parameters:

tag - the packet tag for the object.

Throws:

IOException

BCPGOutputStream

public BCPGOutputStream(OutputStream out,
 int tag,
 long length,
 boolean oldFormat)
                 throws IOException

Create a stream representing a general packet.

Parameters:

out -

tag -

length -

oldFormat -

Throws:

IOException

BCPGOutputStream

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

Parameters:

tag -

length -

Throws:

IOException

BCPGOutputStream

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

Create a new style partial input stream buffered into chunks.

Parameters:

out - output stream to write to.

tag - packet tag.

buffer - size of chunks making up the packet.

Throws:

IOException

Method Details

wrap

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 - output stream

Returns:

BCPGOutputStream

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException

writePacket

public void writePacket(ContainedPacket p)
                 throws IOException

Write a packet to the stream.

Parameters:

p - packet

Throws:

IOException

writeObject

public void writeObject(BCPGObject o)
                 throws IOException

Throws:

IOException

flush

public void flush()
           throws IOException

Flush the underlying stream.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

finish

public void finish()
            throws IOException

Finish writing out the current packet without closing the underlying stream.

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException