org.bouncycastle.openpgp
Class PGPSecretKeyRingCollection
java.lang.Object
org.bouncycastle.openpgp.PGPSecretKeyRingCollection
public class PGPSecretKeyRingCollection
extends java.lang.Object
Often a PGP key ring file is made up of a succession of master/sub-key key rings.
If you want to read an entire secret key file in one hit this is the class for you.
PGPSecretKeyRingCollection
public PGPSecretKeyRingCollection(Collection collection)
throws IOException,
PGPException
PGPSecretKeyRingCollection
public PGPSecretKeyRingCollection(InputStream in)
throws IOException,
PGPException
PGPSecretKeyRingCollection
public PGPSecretKeyRingCollection(byte[] encoding)
throws IOException,
PGPException
addSecretKeyRing
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.
ringCollection
- the collection the ring to be added to.secretKeyRing
- the key ring to be added.
- a new collection merging the current one with the passed in ring.
encode
public void encode(OutputStream outStream)
throws IOException
getEncoded
public byte[] getEncoded()
throws IOException
getKeyRings
public Iterator getKeyRings()
return the secret key rings making up this collection.
getKeyRings
public Iterator getKeyRings(String userID)
throws PGPException
Return an iterator of the key rings associated with the passed in userID.
userID
- the user ID to be matched.
- an iterator (possibly empty) of key rings which matched.
PGPException
-
getKeyRings
public Iterator getKeyRings(String userID,
boolean matchPartial)
throws PGPException
Return an iterator of the key rings associated with the passed in userID.
userID
- the user ID to be matched.matchPartial
- if true userID need only be a substring of an actual ID string to match.
- an iterator (possibly empty) of key rings which matched.
PGPException
-
getSecretKeyRing
public PGPSecretKeyRing getSecretKeyRing(long keyID)
throws PGPException
Return the secret key ring which contains the key referred to by keyID.
keyID
-
- the secret key ring
PGPException
-
removeSecretKeyRing
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.
ringCollection
- the collection the ring to be removed from.secretKeyRing
- the key ring to be removed.
- a new collection merging the current one with the passed in ring.
size
public int size()
Return the number of rings in this collection.
- size of the collection