Class PGPKeyRing

java.lang.Object
org.bouncycastle.openpgp.PGPKeyRing
Direct Known Subclasses:
PGPPublicKeyRing, PGPSecretKeyRing

public abstract class PGPKeyRing extends Object
Parent class for PGP public and secret key rings.
  • Method Details

    • getPublicKey

      public abstract PGPPublicKey getPublicKey()
      Return the first public key in the ring. In the case of a PGPSecretKeyRing this is also the public key of the master key pair.
      Returns:
      PGPPublicKey
    • getPublicKeys

      public abstract Iterator<PGPPublicKey> getPublicKeys()
      Return an iterator containing all the public keys.
      Returns:
      Iterator
    • getPublicKey

      public abstract PGPPublicKey getPublicKey(long keyID)
      Return the public key referred to by the passed in keyID if it is present.
      Parameters:
      keyID - the full keyID of the key of interest.
      Returns:
      PGPPublicKey with matching keyID.
    • getPublicKey

      public abstract PGPPublicKey getPublicKey(byte[] fingerprint)
      Return the public key with the passed in fingerprint if it is present.
      Parameters:
      fingerprint - the full fingerprint of the key of interest.
      Returns:
      PGPPublicKey with the matching fingerprint.
    • getPublicKey

      public abstract PGPPublicKey getPublicKey(KeyIdentifier identifier)
    • getPublicKeys

      public abstract Iterator<PGPPublicKey> getPublicKeys(KeyIdentifier identifier)
    • getKeysWithSignaturesBy

      public abstract Iterator<PGPPublicKey> getKeysWithSignaturesBy(long keyID)
      Return an iterator containing all the public keys carrying signatures issued from key keyID.
      Returns:
      an iterator (possibly empty) of the public keys associated with keyID.
    • getKeysWithSignaturesBy

      public abstract Iterator<PGPPublicKey> getKeysWithSignaturesBy(KeyIdentifier identifier)
    • size

      public abstract int size()
      Return the number of keys in the key ring.
      Returns:
      number of keys (master key + subkey).
    • encode

      public abstract void encode(OutputStream outStream) throws IOException
      Throws:
      IOException
    • getEncoded

      public abstract byte[] getEncoded() throws IOException
      Throws:
      IOException
    • getEncoded

      public abstract byte[] getEncoded(PacketFormat format) throws IOException
      Throws:
      IOException