Modifier and Type	Class and Description
public static class	ArmoredOutputStream.Builder

Field Summary

Modifier and Type	Field and Description
pack-priv byte[]	buf
pack-priv int	bufPtr
public static final String	CHARSET_HDR
pack-priv int	chunkCount
pack-priv boolean	clearText
public static final String	COMMENT_HDR
pack-priv CRC24	crc
public static final String	DEFAULT_VERSION
private static final byte[]	encodingTable
pack-priv String	footerStart
pack-priv String	footerTail
public static final String	HASH_HDR
pack-priv final Hashtable<String, List<String>>	headers
pack-priv String	headerStart
pack-priv String	headerTail
pack-priv int	lastb
public static final String	MESSAGE_ID_HDR
pack-priv boolean	newLine
pack-priv String	nl
pack-priv OutputStream	out
pack-priv boolean	start
pack-priv String	type
public static final String	VERSION_HDR

Constructor Summary

Access	Constructor and Description
public	ArmoredOutputStream(OutputStream the OutputStream to wrap. out) Constructs an armored output stream with `default headers`.
public	ArmoredOutputStream(OutputStream the OutputStream to wrap. out, Hashtable<String, String> additional headers that add to or override the `default headers`. headers) Constructs an armored output stream with default and custom headers.
pack-priv	ArmoredOutputStream(OutputStream out, ArmoredOutputStream.Builder builder)

Method Summary

Modifier and Type	Method and Description
public void	addHeader(String the name of the header entry. name, String the value of the header entry. value) Deprecated use appropriate methods in `Builder` instead Set an additional header entry.
public void	beginClearText(int hash algorithm hashAlgorithm) Start a clear text signed message - backwards compatibility.
public void	beginClearText(int... hash algorithms hashAlgorithms) Start a clear text signed message.
public static ArmoredOutputStream.Builder	builder()
public void	clearHeaders() Deprecated use appropriate methods in `Builder` instead. Remove all headers.
public void	close() Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Note close() does not close the underlying stream.
private static void	encode(OutputStream out, byte[] data, int len) encode the input data producing a base 64 encoded byte array.
private static void	encode3(OutputStream out, byte[] data) encode the input data producing a base 64 encoded byte array.
public void	endClearText()
public void	flush() Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Flushes this output stream and forces any buffered output bytes to be written out.
public void	resetHeaders() Deprecated use `Builder#clearHeaders()` instead. Reset the headers to only contain a Version string (if one is present)
public void	setHeader(String the name of the header entry. name, String the value of the header entry. value) Deprecated use appropriate methods in `Builder` instead. Set an additional header entry.
public void	write(int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.
private void	write(String string)
private void	writeHeaderEntry(String name, String value)

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

Field Detail

buf	back to summary
pack-priv byte[] buf

bufPtr	back to summary
pack-priv int bufPtr

CHARSET_HDR	back to summary
public static final String CHARSET_HDR

chunkCount	back to summary
pack-priv int chunkCount

clearText	back to summary
pack-priv boolean clearText

COMMENT_HDR	back to summary
public static final String COMMENT_HDR

crc	back to summary
pack-priv CRC24 crc

DEFAULT_VERSION	back to summary
public static final String DEFAULT_VERSION

encodingTable	back to summary
private static final byte[] encodingTable

footerStart	back to summary
pack-priv String footerStart

footerTail	back to summary
pack-priv String footerTail

HASH_HDR	back to summary
public static final String HASH_HDR

headers	back to summary
pack-priv final Hashtable<String, List<String>> headers

headerStart	back to summary
pack-priv String headerStart

headerTail	back to summary
pack-priv String headerTail

lastb	back to summary
pack-priv int lastb

MESSAGE_ID_HDR	back to summary
public static final String MESSAGE_ID_HDR

newLine	back to summary
pack-priv boolean newLine

nl	back to summary
pack-priv String nl

out	back to summary
pack-priv OutputStream out

start	back to summary
pack-priv boolean start

type	back to summary
pack-priv String type

VERSION_HDR	back to summary
public static final String VERSION_HDR

Constructor Detail

ArmoredOutputStream back to summary

ArmoredOutputStream	back to summary
public ArmoredOutputStream(OutputStream out) Constructs an armored output stream with `default headers`. Parameters out:OutputStream the OutputStream to wrap.

public ArmoredOutputStream(OutputStream out)

Constructs an armored output stream with default headers.

Parameters

out:OutputStream: the OutputStream to wrap.

ArmoredOutputStream back to summary

ArmoredOutputStream	back to summary
public ArmoredOutputStream(OutputStream out, Hashtable<String, String> headers) Constructs an armored output stream with default and custom headers. Parameters out:OutputStream the OutputStream to wrap. headers:Hashtable<String, String> additional headers that add to or override the `default headers`.

public ArmoredOutputStream(OutputStream out, Hashtable<String, String> headers)

Constructs an armored output stream with default and custom headers.

Parameters

out:OutputStream: the OutputStream to wrap.
headers:Hashtable<String, String>: additional headers that add to or override the default headers.

ArmoredOutputStream	back to summary
pack-priv ArmoredOutputStream(OutputStream out, ArmoredOutputStream.Builder builder)

Method Detail

addHeader back to summary

addHeader	back to summary
public void addHeader(String name, String value) Deprecated use appropriate methods in `Builder` instead Set an additional header entry. The current value(s) will continue to exist together with the new one. Adding a null value has no effect. Parameters name:String the name of the header entry. value:String the value of the header entry. Annotations @Deprecated

public void addHeader(String name, String value)

Deprecated

use appropriate methods in Builder instead

Set an additional header entry. The current value(s) will continue to exist together with the new one. Adding a null value has no effect.

Parameters

name:String: the name of the header entry.
value:String: the value of the header entry.

Annotations

@Deprecated

beginClearText	back to summary
public void beginClearText(int hashAlgorithm) throws IOException Start a clear text signed message - backwards compatibility. Parameters hashAlgorithm:int hash algorithm

beginClearText

back to summary

public void beginClearText(int hashAlgorithm) throws IOException

Start a clear text signed message - backwards compatibility.

Parameters

hashAlgorithm:int: hash algorithm

beginClearText	back to summary
public void beginClearText(int... hashAlgorithms) throws IOException Start a clear text signed message. Parameters hashAlgorithms:int[] hash algorithms

beginClearText

back to summary

public void beginClearText(int... hashAlgorithms) throws IOException

Start a clear text signed message.

Parameters

hashAlgorithms:int[]: hash algorithms

builder	back to summary
public static ArmoredOutputStream.Builder builder()

clearHeaders back to summary

clearHeaders	back to summary
public void clearHeaders() Deprecated use appropriate methods in `Builder` instead. Remove all headers. Annotations @Deprecated

public void clearHeaders()

Deprecated

use appropriate methods in Builder instead.

Remove all headers.

Annotations

@Deprecated

close	back to summary
public void close() throws IOException Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Note close() does not close the underlying stream. So it is possible to write multiple objects using armoring to a single stream. Exceptions IOException: Doc from java.io.OutputStream.close. if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Note

close() does not close the underlying stream. So it is possible to write multiple objects using armoring to a single stream.

Exceptions

IOException:

Doc from java.io.OutputStream.close.

if an I/O error occurs.

encode	back to summary
private static void encode(OutputStream out, byte[] data, int len) throws IOException encode the input data producing a base 64 encoded byte array.

encode3	back to summary
private static void encode3(OutputStream out, byte[] data) throws IOException encode the input data producing a base 64 encoded byte array.

endClearText	back to summary
public void endClearText()

flush back to summary

flush	back to summary
public void flush() throws IOException Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Doc from java.io.OutputStream.flush. Flushes this output stream and forces any buffered output bytes to be written out. The general contract of `flush` is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination. If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive. Exceptions IOException: if an I/O error occurs.

public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Doc from java.io.OutputStream.flush.

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Exceptions

IOException:: if an I/O error occurs.

resetHeaders back to summary

resetHeaders	back to summary
public void resetHeaders() Deprecated use `Builder#clearHeaders()` instead. Reset the headers to only contain a Version string (if one is present) Annotations @Deprecated

public void resetHeaders()

Deprecated

use Builder#clearHeaders() instead.

Reset the headers to only contain a Version string (if one is present)

Annotations

@Deprecated

setHeader back to summary

setHeader	back to summary
public void setHeader(String name, String value) Deprecated use appropriate methods in `Builder` instead. Set an additional header entry. Any current value(s) under the same name will be replaced by the new one. A null value will clear the entry for name. Parameters name:String the name of the header entry. value:String the value of the header entry. Annotations @Deprecated

public void setHeader(String name, String value)

Deprecated

use appropriate methods in Builder instead.

Set an additional header entry. Any current value(s) under the same name will be replaced by the new one. A null value will clear the entry for name.

Parameters

name:String: the name of the header entry.
value:String: the value of the header entry.

Annotations

@Deprecated

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
private void write(String string) throws IOException

writeHeaderEntry	back to summary
private void writeHeaderEntry(String name, String value) throws IOException

org.bouncycastle.bcpg back to summary

public Class ArmoredOutputStream.Builder

Class Inheritance

extends Object

java.lang.Object
org.bouncycastle.bcpg.ArmoredOutputStream.Builder

Field Summary

Modifier and Type	Field and Description
private boolean	computeCRCSum
private final Map<String, List<String>>	headers

Constructor Summary

Access	Constructor and Description
private	Builder()

Method Summary

Modifier and Type	Method and Description
public ArmoredOutputStream.Builder	Returns: builder addComment(String comment comment) Add the given value as one or more additional Comment:
private ArmoredOutputStream.Builder	Returns: builder addHeader(String key key, String value value) Add a header, splitting it into multiple headers if required (newlines).
public ArmoredOutputStream	build(OutputStream outputStream)
public ArmoredOutputStream.Builder	clearHeaders()
public ArmoredOutputStream.Builder	Returns: the current builder instance. enableCRC(boolean true if CRC to be included, false otherwise. doComputeCRC) Enable calculation and inclusion of the CRC check sum (default is true).
private ArmoredOutputStream.Builder	Returns: builder replaceHeader(String key key, String value value) Replace all header values for the given key with the given value.
public ArmoredOutputStream.Builder	Returns: builder setCharset(String charset charset) Replace the Charset:
public ArmoredOutputStream.Builder	Returns: builder setComment(String comment comment) Replace the Comment:
public ArmoredOutputStream.Builder	Returns: builder setMessageId(String message ID messageId) Replace the MessageID:
private ArmoredOutputStream.Builder	Returns: builder setSingletonHeader(String header key key, String header value value) Set and replace the given header value with a single-line header.
public ArmoredOutputStream.Builder	Returns: builder setVersion(String version version) Set a Version: