Bouncy Castle OpenPGP APIs (FIPS Distribution) 1.0.7.1 · org.bouncycastle.openpgp.PGPObjectFactory

General class for reading a PGP object stream.

Note

if this class finds a PGPPublicKey or a PGPSecretKey it will create a PGPPublicKeyRing, or a PGPSecretKeyRing for each key found. If all you are trying to do is read a key ring file use either PGPPublicKeyRingCollection or PGPSecretKeyRingCollection.

This factory supports reading the following types of objects:

PacketTags#SIGNATURE - produces a PGPSignatureList
PacketTags#SECRET_KEY - produces a PGPSecretKeyRing
PacketTags#PUBLIC_KEY - produces a PGPPublicKeyRing
PacketTags#PUBLIC_SUBKEY - produces a PGPPublicKey
PacketTags#COMPRESSED_DATA - produces a PGPCompressedData
PacketTags#LITERAL_DATA - produces a PGPLiteralData
PacketTags#PUBLIC_KEY_ENC_SESSION - produces a PGPEncryptedDataList
PacketTags#SYMMETRIC_KEY_ENC_SESSION - produces a PGPEncryptedDataList
PacketTags#ONE_PASS_SIGNATURE - produces a PGPOnePassSignatureList
PacketTags#MARKER - produces a PGPMarker

Modifier and Type	Field and Description
private KeyFingerPrintCalculator	fingerPrintCalculator
private BCPGInputStream	in

Constructor Summary

Access	Constructor and Description
public	PGPObjectFactory(InputStream stream to read PGP data from. in, KeyFingerPrintCalculator calculator to use in key finger print calculations. fingerPrintCalculator) Create an object factory suitable for reading PGP objects such as keys, key rings and key ring collections, or PGP encrypted data.
public	PGPObjectFactory(byte[] PGP encoded data. bytes, KeyFingerPrintCalculator calculator to use in key finger print calculations. fingerPrintCalculator) Create an object factory suitable for reading PGP objects such as keys, key rings and key ring collections, or PGP encrypted data.

Method Summary

Modifier and Type	Method and Description
public Iterator<E>	iterator() Implements org.bouncycastle.util.Iterable.iterator. Support method for Iterable where available.
public Object	Returns: one of the supported objects - see class docs for details. nextObject() Return the next object in the stream, or `null` if the end of stream is reached.

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

fingerPrintCalculator	back to summary
private KeyFingerPrintCalculator fingerPrintCalculator

in	back to summary
private BCPGInputStream in

Constructor Detail

PGPObjectFactory	back to summary
public PGPObjectFactory(InputStream in, KeyFingerPrintCalculator fingerPrintCalculator) Create an object factory suitable for reading PGP objects such as keys, key rings and key ring collections, or PGP encrypted data. Parameters in:InputStream stream to read PGP data from. fingerPrintCalculator:KeyFingerPrintCalculator calculator to use in key finger print calculations.

PGPObjectFactory

back to summary

public PGPObjectFactory(InputStream in, KeyFingerPrintCalculator fingerPrintCalculator)

Create an object factory suitable for reading PGP objects such as keys, key rings and key ring collections, or PGP encrypted data.

Parameters

in:InputStream: stream to read PGP data from.
fingerPrintCalculator:KeyFingerPrintCalculator: calculator to use in key finger print calculations.

PGPObjectFactory	back to summary
public PGPObjectFactory(byte[] bytes, KeyFingerPrintCalculator fingerPrintCalculator) Create an object factory suitable for reading PGP objects such as keys, key rings and key ring collections, or PGP encrypted data. Parameters bytes:byte[] PGP encoded data. fingerPrintCalculator:KeyFingerPrintCalculator calculator to use in key finger print calculations.

PGPObjectFactory

back to summary

public PGPObjectFactory(byte[] bytes, KeyFingerPrintCalculator fingerPrintCalculator)

Create an object factory suitable for reading PGP objects such as keys, key rings and key ring collections, or PGP encrypted data.

Parameters

bytes:byte[]: PGP encoded data.
fingerPrintCalculator:KeyFingerPrintCalculator: calculator to use in key finger print calculations.

Method Detail

iterator	back to summary
public Iterator<E> iterator() Implements org.bouncycastle.util.Iterable.iterator. Support method for Iterable where available. Returns:Iterator<E> Doc from org.bouncycastle.util.Iterable.iterator. an Iterator.

iterator

back to summary

public Iterator<E> iterator()

Implements org.bouncycastle.util.Iterable.iterator.

Support method for Iterable where available.

Returns:Iterator<E>

Doc from org.bouncycastle.util.Iterable.iterator.

an Iterator.

nextObject back to summary

nextObject	back to summary
public Object nextObject() throws IOException Return the next object in the stream, or `null` if the end of stream is reached. Returns:Object one of the supported objects - see class docs for details. Exceptions IOException: if an error occurs reading from the wrapped stream or parsing data.

public Object nextObject() throws IOException

Return the next object in the stream, or null if the end of stream is reached.

Returns:Object

one of the supported objects - see class docs for details.

Exceptions

IOException:: if an error occurs reading from the wrapped stream or parsing data.

public Class PGPObjectFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail