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

Modifier and Type	Field and Description
private List<Long>	order
private Map<Long, PGPSecretKeyRing>	secretRings

Access	Constructor and Description
private	PGPSecretKeyRingCollection(Map<Long, PGPSecretKeyRing> secretRings, List<Long> order)
public	PGPSecretKeyRingCollection(byte[] encoding, KeyFingerPrintCalculator fingerPrintCalculator)
public	PGPSecretKeyRingCollection(InputStream input stream containing data in, KeyFingerPrintCalculator fingerPrintCalculator) Build a PGPSecretKeyRingCollection from the passed in input stream.
public	PGPSecretKeyRingCollection(Collection<PGPSecretKeyRing> collection)

Method Summary

Modifier and Type	Method and Description
public static PGPSecretKeyRingCollection	Returns: a new collection merging the current one with the passed in ring. addSecretKeyRing(PGPSecretKeyRingCollection the collection the ring to be added to. ringCollection, PGPSecretKeyRing the key ring to be added. secretKeyRing) Return a new collection object containing the contents of the passed in collection and the passed in secret key ring.
public boolean	Returns: true if keyID present, false otherwise. contains(long key ID to look for. keyID) Return true if a key matching the passed in key ID is present, false otherwise.
public void	encode(OutputStream outStream)
public byte[]	getEncoded()
public Iterator<PGPSecretKeyRing>	getKeyRings() return the secret key rings making up this collection.
public Iterator<PGPSecretKeyRing>	Returns: an iterator (possibly empty) of key rings which matched. getKeyRings(String the user ID to be matched. userID) Return an iterator of the key rings associated with the passed in userID.
public Iterator<PGPSecretKeyRing>	Returns: an iterator (possibly empty) of key rings which matched. getKeyRings(String the user ID to be matched. userID, boolean if true userID need only be a substring of an actual ID string to match. matchPartial) Return an iterator of the key rings associated with the passed in userID.
public Iterator<PGPSecretKeyRing>	Returns: an iterator (possibly empty) of key rings which matched. getKeyRings(String the user ID to be matched. userID, boolean if true userID need only be a substring of an actual ID string to match. matchPartial, boolean if true case is ignored in user ID comparisons. ignoreCase) Return an iterator of the key rings associated with the passed in userID.
public PGPSecretKey	Returns: the secret key getSecretKey(long id of the secret key keyID) Return the PGP secret key associated with the given key id.
public PGPSecretKeyRing	Returns: the secret key ring getSecretKeyRing(long id of a secret key keyID) Return the secret key ring which contains the key referred to by keyID.
public Iterator<PGPSecretKeyRing>	iterator() Implements org.bouncycastle.util.Iterable.iterator. Support method for Iterable where available.
public static PGPSecretKeyRingCollection	Returns: a new collection merging the current one with the passed in ring. removeSecretKeyRing(PGPSecretKeyRingCollection the collection the ring to be removed from. ringCollection, PGPSecretKeyRing the key ring to be removed. secretKeyRing) Return a new collection object containing the contents of this collection with the passed in secret key ring removed.
public int	Returns: size of the collection size() Return the number of rings in this collection.

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

order	back to summary
private List<Long> order

secretRings	back to summary
private Map<Long, PGPSecretKeyRing> secretRings

PGPSecretKeyRingCollection	back to summary
private PGPSecretKeyRingCollection(Map<Long, PGPSecretKeyRing> secretRings, List<Long> order)

PGPSecretKeyRingCollection	back to summary
public PGPSecretKeyRingCollection(byte[] encoding, KeyFingerPrintCalculator fingerPrintCalculator) throws IOException, PGPException

PGPSecretKeyRingCollection	back to summary
public PGPSecretKeyRingCollection(InputStream in, KeyFingerPrintCalculator fingerPrintCalculator) throws IOException, PGPException Build a PGPSecretKeyRingCollection from the passed in input stream. Parameters in:InputStream input stream containing data Exceptions IOException: if a problem parsing the base stream occurs PGPException: if an object is encountered which isn't a PGPSecretKeyRing

PGPSecretKeyRingCollection	back to summary
public PGPSecretKeyRingCollection(Collection<PGPSecretKeyRing> collection)

Method Detail

addSecretKeyRing	back to summary
public static PGPSecretKeyRingCollection addSecretKeyRing(PGPSecretKeyRingCollection ringCollection, PGPSecretKeyRing secretKeyRing) Return a new collection object containing the contents of the passed in collection and the passed in secret key ring. Parameters ringCollection:PGPSecretKeyRingCollection the collection the ring to be added to. secretKeyRing:PGPSecretKeyRing the key ring to be added. Returns:PGPSecretKeyRingCollection a new collection merging the current one with the passed in ring. Exceptions IllegalArgumentException: if the keyID for the passed in ring is already present.

addSecretKeyRing

back to summary

public static PGPSecretKeyRingCollection addSecretKeyRing(PGPSecretKeyRingCollection ringCollection, PGPSecretKeyRing secretKeyRing)

Return a new collection object containing the contents of the passed in collection and the passed in secret key ring.

Parameters

ringCollection:PGPSecretKeyRingCollection: the collection the ring to be added to.
secretKeyRing:PGPSecretKeyRing: the key ring to be added.

Returns:PGPSecretKeyRingCollection

a new collection merging the current one with the passed in ring.

Exceptions

IllegalArgumentException:: if the keyID for the passed in ring is already present.

contains	back to summary
public boolean contains(long keyID) Return true if a key matching the passed in key ID is present, false otherwise. Parameters keyID:long key ID to look for. Returns:boolean true if keyID present, false otherwise.

contains

back to summary

public boolean contains(long keyID)

Return true if a key matching the passed in key ID is present, false otherwise.

Parameters

keyID:long: key ID to look for.

Returns:boolean

true if keyID present, false otherwise.

encode	back to summary
public void encode(OutputStream outStream) throws IOException

getEncoded	back to summary
public byte[] getEncoded() throws IOException

getKeyRings	back to summary
public Iterator<PGPSecretKeyRing> getKeyRings() return the secret key rings making up this collection.

getKeyRings	back to summary
public Iterator<PGPSecretKeyRing> getKeyRings(String userID) Return an iterator of the key rings associated with the passed in userID. Parameters userID:String the user ID to be matched. Returns:Iterator<PGPSecretKeyRing> an iterator (possibly empty) of key rings which matched.

getKeyRings

back to summary

public Iterator<PGPSecretKeyRing> getKeyRings(String userID)

Return an iterator of the key rings associated with the passed in userID.

Parameters

userID:String: the user ID to be matched.

Returns:Iterator<PGPSecretKeyRing>

an iterator (possibly empty) of key rings which matched.

getKeyRings	back to summary
public Iterator<PGPSecretKeyRing> getKeyRings(String userID, boolean matchPartial) Return an iterator of the key rings associated with the passed in userID. Parameters userID:String the user ID to be matched. matchPartial:boolean if true userID need only be a substring of an actual ID string to match. Returns:Iterator<PGPSecretKeyRing> an iterator (possibly empty) of key rings which matched.

getKeyRings

back to summary

public Iterator<PGPSecretKeyRing> getKeyRings(String userID, boolean matchPartial)

Return an iterator of the key rings associated with the passed in userID.

Parameters

userID:String: the user ID to be matched.
matchPartial:boolean: if true userID need only be a substring of an actual ID string to match.

Returns:Iterator<PGPSecretKeyRing>

an iterator (possibly empty) of key rings which matched.

getKeyRings	back to summary
public Iterator<PGPSecretKeyRing> getKeyRings(String userID, boolean matchPartial, boolean ignoreCase) Return an iterator of the key rings associated with the passed in userID. Parameters userID:String the user ID to be matched. matchPartial:boolean if true userID need only be a substring of an actual ID string to match. ignoreCase:boolean if true case is ignored in user ID comparisons. Returns:Iterator<PGPSecretKeyRing> an iterator (possibly empty) of key rings which matched.

getKeyRings

back to summary

public Iterator<PGPSecretKeyRing> getKeyRings(String userID, boolean matchPartial, boolean ignoreCase)

Return an iterator of the key rings associated with the passed in userID.

Parameters

userID:String: the user ID to be matched.
matchPartial:boolean: if true userID need only be a substring of an actual ID string to match.
ignoreCase:boolean: if true case is ignored in user ID comparisons.

Returns:Iterator<PGPSecretKeyRing>

an iterator (possibly empty) of key rings which matched.

getSecretKey	back to summary
public PGPSecretKey getSecretKey(long keyID) Return the PGP secret key associated with the given key id. Parameters keyID:long id of the secret key Returns:PGPSecretKey the secret key

getSecretKey

back to summary

public PGPSecretKey getSecretKey(long keyID)

Return the PGP secret key associated with the given key id.

Parameters

keyID:long: id of the secret key

Returns:PGPSecretKey

the secret key

getSecretKeyRing	back to summary
public PGPSecretKeyRing getSecretKeyRing(long keyID) Return the secret key ring which contains the key referred to by keyID. Parameters keyID:long id of a secret key Returns:PGPSecretKeyRing the secret key ring

getSecretKeyRing

back to summary

public PGPSecretKeyRing getSecretKeyRing(long keyID)

Return the secret key ring which contains the key referred to by keyID.

Parameters

keyID:long: id of a secret key

Returns:PGPSecretKeyRing

the secret key ring

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

iterator

back to summary

public Iterator<PGPSecretKeyRing> iterator()

Implements org.bouncycastle.util.Iterable.iterator.

Support method for Iterable where available.

Returns:Iterator<PGPSecretKeyRing>

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

an Iterator.

removeSecretKeyRing	back to summary
public static PGPSecretKeyRingCollection removeSecretKeyRing(PGPSecretKeyRingCollection ringCollection, PGPSecretKeyRing secretKeyRing) Return a new collection object containing the contents of this collection with the passed in secret key ring removed. Parameters ringCollection:PGPSecretKeyRingCollection the collection the ring to be removed from. secretKeyRing:PGPSecretKeyRing the key ring to be removed. Returns:PGPSecretKeyRingCollection a new collection merging the current one with the passed in ring. Exceptions IllegalArgumentException: if the keyID for the passed in ring is not present.

removeSecretKeyRing

back to summary

public static PGPSecretKeyRingCollection removeSecretKeyRing(PGPSecretKeyRingCollection ringCollection, PGPSecretKeyRing secretKeyRing)

Return a new collection object containing the contents of this collection with the passed in secret key ring removed.

Parameters

ringCollection:PGPSecretKeyRingCollection: the collection the ring to be removed from.
secretKeyRing:PGPSecretKeyRing: the key ring to be removed.

Returns:PGPSecretKeyRingCollection

a new collection merging the current one with the passed in ring.

Exceptions

IllegalArgumentException:: if the keyID for the passed in ring is not present.

size	back to summary
public int size() Return the number of rings in this collection. Returns:int size of the collection

size

back to summary

public int size()

Return the number of rings in this collection.

Returns:int: size of the collection

public Class PGPSecretKeyRingCollection

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail