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

Modifier and Type	Field and Description
pack-priv int	bufPtr
pack-priv boolean	clearText
private final CRC24	crc
pack-priv boolean	crcFound
private static final byte[]	decodingTable set up the decoding table.
private boolean	detectMissingChecksum
pack-priv boolean	hasHeaders
pack-priv String	header
pack-priv StringList	headerList
pack-priv InputStream	in
pack-priv boolean	isEndOfStream
pack-priv int	lastC
pack-priv boolean	newLineFound
pack-priv byte[]	outBuf
pack-priv boolean	restart
pack-priv boolean	start

Access	Constructor and Description
public	ArmoredInputStream(InputStream in) Create a stream for reading a PGP armoured message, parsing up to a header and then reading the data that follows.
public	ArmoredInputStream(InputStream in, boolean true if headers are to be looked for, false otherwise. hasHeaders) Create an armoured input stream which will assume the data starts straight away, or parse for headers first depending on the value of hasHeaders.
private	ArmoredInputStream(InputStream in, ArmoredInputStream.Builder builder)

Method Summary

Modifier and Type	Method and Description
public int	available() Overrides java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected.
public static ArmoredInputStream.Builder	builder()
private void	checkIndexSize(int size, int off, int len)
public void	close() Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
private static int	Returns: the offset the data starts in out. decode(int in0, int in1, int in2, int in3, byte[] out) decode the base 64 encoded input data.
public String	Returns: the armor header line, null if none present. getArmorHeaderLine() Return the armor header line (if there is one)
public String[]	Returns: an array of armor headers, null if there aren't any. getArmorHeaders() Return the armor headers (the lines after the armor header line),
public boolean	Returns: true if we are inside the clear text section of a PGP signed message. isClearText()
public boolean	Returns: true if the stream is actually at end of file. isEndOfStream()
private boolean	parseHeaders()
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	Returns: total number of bytes read into the buffer read(byte[] byte array b, int offset at which we start writing data to the array off, int number of bytes we write into the array len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.
private int	readIgnoreSpace()
public void	setDetectMissingCRC(boolean false if ignore missing CRC sums, true for exception detectMissing) Deprecated use Builder class for configuring this. Change how the stream should react if it encounters missing CRC checksum.

Inherited from java.io.InputStream:: mark markSupported nullInputStream read readAllBytes readNBytes readNBytes reset skip skipNBytes transferTo

Field Detail

bufPtr	back to summary
pack-priv int bufPtr

clearText	back to summary
pack-priv boolean clearText

crc	back to summary
private final CRC24 crc

crcFound	back to summary
pack-priv boolean crcFound

decodingTable	back to summary
private static final byte[] decodingTable set up the decoding table.

detectMissingChecksum	back to summary
private boolean detectMissingChecksum

hasHeaders	back to summary
pack-priv boolean hasHeaders

header	back to summary
pack-priv String header

headerList	back to summary
pack-priv StringList headerList

in	back to summary
pack-priv InputStream in

isEndOfStream	back to summary
pack-priv boolean isEndOfStream

lastC	back to summary
pack-priv int lastC

newLineFound	back to summary
pack-priv boolean newLineFound

outBuf	back to summary
pack-priv byte[] outBuf

restart	back to summary
pack-priv boolean restart

start	back to summary
pack-priv boolean start

Constructor Detail

ArmoredInputStream	back to summary
public ArmoredInputStream(InputStream in) throws IOException Create a stream for reading a PGP armoured message, parsing up to a header and then reading the data that follows.

ArmoredInputStream	back to summary
public ArmoredInputStream(InputStream in, boolean hasHeaders) throws IOException Create an armoured input stream which will assume the data starts straight away, or parse for headers first depending on the value of hasHeaders. Parameters hasHeaders:boolean true if headers are to be looked for, false otherwise.

ArmoredInputStream

back to summary

public ArmoredInputStream(InputStream in, boolean hasHeaders) throws IOException

Create an armoured input stream which will assume the data starts straight away, or parse for headers first depending on the value of hasHeaders.

Parameters

hasHeaders:boolean: true if headers are to be looked for, false otherwise.

ArmoredInputStream	back to summary
private ArmoredInputStream(InputStream in, ArmoredInputStream.Builder builder) throws IOException

Method Detail

available back to summary

available	back to summary
public int available() throws IOException Overrides java.io.InputStream.available. Doc from java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. Note that while some implementations of `InputStream` will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream. A subclass's implementation of this method may choose to throw an `IOException` if this input stream has been closed by invoking the `close()` method. Returns:int an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or `0` when it reaches the end of the input stream. Exceptions IOException: if an I/O error occurs.

public int available() throws IOException

Overrides java.io.InputStream.available.

Doc from java.io.InputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Note that while some implementations of InputStream will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream.

A subclass's implementation of this method may choose to throw an IOException if this input stream has been closed by invoking the close() method.

Returns:int

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream.

Exceptions

IOException:: if an I/O error occurs.

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

checkIndexSize	back to summary
private void checkIndexSize(int size, int off, int len)

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Doc from java.io.InputStream.close. Closes this input stream and releases any system resources associated with the stream. Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.InputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Exceptions

IOException:: if an I/O error occurs.

decode	back to summary
private static int decode(int in0, int in1, int in2, int in3, byte[] out) throws IOException decode the base 64 encoded input data. Returns:int the offset the data starts in out.

decode

back to summary

private static int decode(int in0, int in1, int in2, int in3, byte[] out) throws IOException

decode the base 64 encoded input data.

Returns:int: the offset the data starts in out.

getArmorHeaderLine	back to summary
public String getArmorHeaderLine() Return the armor header line (if there is one) Returns:String the armor header line, null if none present.

getArmorHeaderLine

back to summary

public String getArmorHeaderLine()

Return the armor header line (if there is one)

Returns:String: the armor header line, null if none present.

getArmorHeaders	back to summary
public String[] getArmorHeaders() Return the armor headers (the lines after the armor header line), Returns:String[] an array of armor headers, null if there aren't any.

getArmorHeaders

back to summary

public String[] getArmorHeaders()

Return the armor headers (the lines after the armor header line),

Returns:String[]: an array of armor headers, null if there aren't any.

isClearText	back to summary
public boolean isClearText() Returns:boolean true if we are inside the clear text section of a PGP signed message.

isEndOfStream	back to summary
public boolean isEndOfStream() Returns:boolean true if the stream is actually at end of file.

parseHeaders	back to summary
private boolean parseHeaders() throws IOException

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] b, int off, int len) throws IOException Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. The first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Note We need to override the custom behavior of Java's `InputStream#read(byte[], int, int)`, as the upstream method silently swallows `IOExceptions`. This would cause CRC checksum errors to go unnoticed. Parameters b:byte[] byte array off:int offset at which we start writing data to the array len:int number of bytes we write into the array Returns:int total number of bytes read into the buffer Exceptions IOException: if an exception happens AT ANY POINT See Also Related BC bug report

public int read(byte[] b, int off, int len) throws IOException

Overrides java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len.

Note

We need to override the custom behavior of Java's InputStream#read(byte[], int, int), as the upstream method silently swallows IOExceptions. This would cause CRC checksum errors to go unnoticed.

Parameters

b:byte[]: byte array
off:int: offset at which we start writing data to the array
len:int: number of bytes we write into the array

Returns:int

total number of bytes read into the buffer

Exceptions

IOException:: if an exception happens AT ANY POINT

See Also

Related BC bug report

readIgnoreSpace	back to summary
private int readIgnoreSpace() throws IOException

setDetectMissingCRC back to summary

setDetectMissingCRC	back to summary
public void setDetectMissingCRC(boolean detectMissing) Deprecated use Builder class for configuring this. Change how the stream should react if it encounters missing CRC checksum. The default value is false (ignore missing CRC checksums). If the behavior is set to true, an `IOException` will be thrown if a missing CRC checksum is encountered. Parameters detectMissing:boolean false if ignore missing CRC sums, true for exception

public void setDetectMissingCRC(boolean detectMissing)

Deprecated

use Builder class for configuring this.

Change how the stream should react if it encounters missing CRC checksum. The default value is false (ignore missing CRC checksums). If the behavior is set to true, an IOException will be thrown if a missing CRC checksum is encountered.

Parameters

detectMissing:boolean: false if ignore missing CRC sums, true for exception

org.bouncycastle.bcpg back to summary

public Class ArmoredInputStream.Builder

Class Inheritance

extends Object

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

Field Summary

Modifier and Type	Field and Description
private boolean	detectMissingCRC
private boolean	hasHeaders
private boolean	ignoreCRC

Constructor Summary

Access	Constructor and Description
private	Builder()

Method Summary

Modifier and Type	Method and Description
public ArmoredInputStream	build(InputStream inputStream)
public ArmoredInputStream.Builder	setDetectMissingCRC(boolean false if ignore missing CRC sums, true for exception detectMissingCRC) Change how the stream should react if it encounters missing CRC checksum.
public ArmoredInputStream.Builder	Returns: the current builder instance. setIgnoreCRC(boolean true if CRC should be ignored, false otherwise. ignoreCRC) Specifically ignore the CRC if in place (this will also avoid the cost of calculation).
public ArmoredInputStream.Builder	Returns: the current builder instance. setParseForHeaders(boolean true if headers should be expected, false otherwise. hasHeaders) Enable or disable header parsing (default value true).

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

Field Detail

detectMissingCRC	back to summary
private boolean detectMissingCRC

hasHeaders	back to summary
private boolean hasHeaders

ignoreCRC	back to summary
private boolean ignoreCRC

Constructor Detail

Builder	back to summary
private Builder()

Method Detail

build	back to summary
public ArmoredInputStream build(InputStream inputStream) throws IOException

setDetectMissingCRC back to summary

setDetectMissingCRC	back to summary
public ArmoredInputStream.Builder setDetectMissingCRC(boolean detectMissingCRC) Change how the stream should react if it encounters missing CRC checksum. The default value is false (ignore missing CRC checksums). If the behavior is set to true, an `IOException` will be thrown if a missing CRC checksum is encountered. Parameters detectMissingCRC:boolean false if ignore missing CRC sums, true for exception

public ArmoredInputStream.Builder setDetectMissingCRC(boolean detectMissingCRC)

Parameters

detectMissingCRC:boolean: false if ignore missing CRC sums, true for exception

setIgnoreCRC	back to summary
public ArmoredInputStream.Builder setIgnoreCRC(boolean ignoreCRC) Specifically ignore the CRC if in place (this will also avoid the cost of calculation). Parameters ignoreCRC:boolean true if CRC should be ignored, false otherwise. Returns:ArmoredInputStream.Builder the current builder instance.

setIgnoreCRC

back to summary

public ArmoredInputStream.Builder setIgnoreCRC(boolean ignoreCRC)

Specifically ignore the CRC if in place (this will also avoid the cost of calculation).

Parameters

ignoreCRC:boolean: true if CRC should be ignored, false otherwise.

Returns:ArmoredInputStream.Builder

the current builder instance.

setParseForHeaders	back to summary
public ArmoredInputStream.Builder setParseForHeaders(boolean hasHeaders) Enable or disable header parsing (default value true). Parameters hasHeaders:boolean true if headers should be expected, false otherwise. Returns:ArmoredInputStream.Builder the current builder instance.

setParseForHeaders

back to summary

public ArmoredInputStream.Builder setParseForHeaders(boolean hasHeaders)

Enable or disable header parsing (default value true).

Parameters

hasHeaders:boolean: true if headers should be expected, false otherwise.

Returns:ArmoredInputStream.Builder

the current builder instance.

public Class ArmoredInputStream

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ArmoredInputStream.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail