|
Bouncy Castle Cryptography Library 1.81 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.bouncycastle.openpgp.PGPPublicKeyRingCollection
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 public key file in one hit this is the class for you.
Constructor Summary | |
PGPPublicKeyRingCollection(byte[] encoding,
KeyFingerPrintCalculator fingerPrintCalculator)
|
|
PGPPublicKeyRingCollection(java.util.Collection collection)
|
|
PGPPublicKeyRingCollection(java.io.InputStream in,
KeyFingerPrintCalculator fingerPrintCalculator)
Build a PGPPublicKeyRingCollection from the passed in input stream. |
Method Summary | |
static PGPPublicKeyRingCollection |
addPublicKeyRing(PGPPublicKeyRingCollection ringCollection,
PGPPublicKeyRing publicKeyRing)
Return a new collection object containing the contents of the passed in collection and the passed in public key ring. |
boolean |
contains(byte[] fingerprint)
Return true if a key matching the passed in fingerprint is present, false otherwise. |
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 public 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. |
java.util.Iterator |
getKeysWithSignaturesBy(long keyID)
Return any keys carrying a signature issued by the key represented by keyID. |
PGPPublicKey |
getPublicKey(byte[] fingerprint)
Return the PGP public key associated with the given key fingerprint. |
PGPPublicKey |
getPublicKey(long keyID)
Return the PGP public key associated with the given key id. |
PGPPublicKeyRing |
getPublicKeyRing(byte[] fingerprint)
Return the public key ring which contains the key associated with the given key fingerprint. |
PGPPublicKeyRing |
getPublicKeyRing(long keyID)
Return the public key ring which contains the key referred to by keyID. |
java.util.Iterator |
iterator()
Support method for Iterable where available. |
static PGPPublicKeyRingCollection |
removePublicKeyRing(PGPPublicKeyRingCollection ringCollection,
PGPPublicKeyRing publicKeyRing)
Return a new collection object containing the contents of this collection with the passed in public 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 PGPPublicKeyRingCollection(byte[] encoding, KeyFingerPrintCalculator fingerPrintCalculator) throws java.io.IOException, PGPException
public PGPPublicKeyRingCollection(java.io.InputStream in, KeyFingerPrintCalculator fingerPrintCalculator) throws java.io.IOException, PGPException
in
- input stream containing data
java.io.IOException
- if a problem parsing the base stream occurs
PGPException
- if an object is encountered which isn't a PGPPublicKeyRingpublic PGPPublicKeyRingCollection(java.util.Collection collection)
Method Detail |
public int size()
public java.util.Iterator getKeyRings()
public java.util.Iterator getKeyRings(java.lang.String userID)
userID
- the user ID to be matched.
public java.util.Iterator getKeyRings(java.lang.String userID, boolean matchPartial)
userID
- the user ID to be matched.matchPartial
- if true userID need only be a substring of an actual ID string to match.
public java.util.Iterator getKeyRings(java.lang.String userID, boolean matchPartial, boolean ignoreCase)
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.
public PGPPublicKey getPublicKey(long keyID)
keyID
- if of the PGP public key
public PGPPublicKeyRing getPublicKeyRing(long keyID)
keyID
- key ID to match against
public PGPPublicKey getPublicKey(byte[] fingerprint)
fingerprint
- the public key fingerprint to match against.
public PGPPublicKeyRing getPublicKeyRing(byte[] fingerprint)
fingerprint
- the public key fingerprint to match against.
public java.util.Iterator getKeysWithSignaturesBy(long keyID)
keyID
- the key id to be matched against.
public boolean contains(long keyID)
keyID
- key ID to look for.
public boolean contains(byte[] fingerprint)
fingerprint
- hte key fingerprint to look for.
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 PGPPublicKeyRingCollection addPublicKeyRing(PGPPublicKeyRingCollection ringCollection, PGPPublicKeyRing publicKeyRing)
ringCollection
- the collection the ring to be added to.publicKeyRing
- the key ring to be added.
java.lang.IllegalArgumentException
- if the keyID for the passed in ring is already present.public static PGPPublicKeyRingCollection removePublicKeyRing(PGPPublicKeyRingCollection ringCollection, PGPPublicKeyRing publicKeyRing)
ringCollection
- the collection the ring to be removed from.publicKeyRing
- the key ring to be removed.
java.lang.IllegalArgumentException
- if the keyID for the passed in ring not present.public java.util.Iterator iterator()
iterator
in interface org.bouncycastle.util.Iterable
|
Bouncy Castle Cryptography Library 1.81 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |