|
Bouncy Castle Cryptography 1.45 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.bouncycastle.openpgp.PGPSecretKeyRingCollection
public class PGPSecretKeyRingCollection
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.
| Constructor Summary | |
|---|---|
PGPSecretKeyRingCollection(byte[] encoding)
|
|
PGPSecretKeyRingCollection(java.util.Collection collection)
|
|
PGPSecretKeyRingCollection(java.io.InputStream in)
Build a PGPSecretKeyRingCollection from the passed in input stream. |
|
| Method Summary | |
|---|---|
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. |
boolean |
contains(long keyID)
Return true if a key matching the passed in key ID is present, false otherwise. |
void |
encode(java.io.OutputStream outStream)
|
byte[] |
getEncoded()
|
java.util.Iterator |
getKeyRings()
return the secret key rings making up this collection. |
java.util.Iterator |
getKeyRings(java.lang.String userID)
Return an iterator of the key rings associated with the passed in userID. |
java.util.Iterator |
getKeyRings(java.lang.String userID,
boolean matchPartial)
Return an iterator of the key rings associated with the passed in userID. |
java.util.Iterator |
getKeyRings(java.lang.String userID,
boolean matchPartial,
boolean ignoreCase)
Return an iterator of the key rings associated with the passed in userID. |
PGPSecretKey |
getSecretKey(long keyID)
Return the PGP secret key associated with the given key id. |
PGPSecretKeyRing |
getSecretKeyRing(long keyID)
Return the secret key ring which contains the key referred to by keyID. |
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. |
int |
size()
Return the number of rings in this collection. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public PGPSecretKeyRingCollection(byte[] encoding)
throws java.io.IOException,
PGPException
java.io.IOException
PGPException
public PGPSecretKeyRingCollection(java.io.InputStream in)
throws java.io.IOException,
PGPException
in - input stream containing data
java.io.IOException - if a problem parsinh the base stream occurs
PGPException - if an object is encountered which isn't a PGPSecretKeyRing
public PGPSecretKeyRingCollection(java.util.Collection collection)
throws java.io.IOException,
PGPException
java.io.IOException
PGPException| Method Detail |
|---|
public int size()
public java.util.Iterator getKeyRings()
public java.util.Iterator getKeyRings(java.lang.String userID)
throws PGPException
userID - the user ID to be matched.
PGPException
public java.util.Iterator getKeyRings(java.lang.String userID,
boolean matchPartial)
throws PGPException
userID - the user ID to be matched.matchPartial - if true userID need only be a substring of an actual ID string to match.
PGPException
public java.util.Iterator getKeyRings(java.lang.String userID,
boolean matchPartial,
boolean ignoreCase)
throws PGPException
userID - the user ID to be matched.matchPartial - if true userID need only be a substring of an actual ID string to match.ignoreCase - if true case is ignored in user ID comparisons.
PGPException
public PGPSecretKey getSecretKey(long keyID)
throws PGPException
keyID -
PGPException
public PGPSecretKeyRing getSecretKeyRing(long keyID)
throws PGPException
keyID -
PGPException
public boolean contains(long keyID)
throws PGPException
keyID - key ID to look for.
PGPException
public byte[] getEncoded()
throws java.io.IOException
java.io.IOException
public void encode(java.io.OutputStream outStream)
throws java.io.IOException
java.io.IOException
public static PGPSecretKeyRingCollection addSecretKeyRing(PGPSecretKeyRingCollection ringCollection,
PGPSecretKeyRing secretKeyRing)
ringCollection - the collection the ring to be added to.secretKeyRing - the key ring to be added.
java.lang.IllegalArgumentException - if the keyID for the passed in ring is already present.
public static PGPSecretKeyRingCollection removeSecretKeyRing(PGPSecretKeyRingCollection ringCollection,
PGPSecretKeyRing secretKeyRing)
ringCollection - the collection the ring to be removed from.secretKeyRing - the key ring to be removed.
java.lang.IllegalArgumentException - if the keyID for the passed in ring is not present.
|
Bouncy Castle Cryptography 1.45 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||