java.security.cert

Class Certificate

  • java.lang.Object
    • java.security.cert.Certificate
  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    X509Certificate


    public abstract class Certificate
    extends java.lang.Object
    implements java.io.Serializable

    Abstract class for managing a variety of identity certificates. An identity certificate is a binding of a principal to a public key which is vouched for by another principal. (A principal represents an entity such as an individual user, a group, or a corporation.)

    This class is an abstraction for certificates that have different formats but important common uses. For example, different types of certificates, such as X.509 and PGP, share general certificate functionality (like encoding and verifying) and some types of information (like a public key).

    X.509, PGP, and SDSI certificates can all be implemented by subclassing the Certificate class, even though they contain different sets of information, and they store and retrieve the information in different ways.

    See Also:
    X509Certificate, CertificateFactory, Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class and Description
      protected static class  Certificate.CertificateRep
      Alternate Certificate class for serialization.
    • Constructor Summary

      Constructors 
      Modifier Constructor and Description
      protected Certificate(java.lang.String type)
      Creates a certificate of the specified type.
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean equals(java.lang.Object other)
      Compares this certificate for equality with the specified object.
      abstract byte[] getEncoded()
      Returns the encoded form of this certificate.
      abstract java.security.PublicKey getPublicKey()
      Gets the public key from this certificate.
      java.lang.String getType()
      Returns the type of this certificate.
      int hashCode()
      Returns a hashcode value for this certificate from its encoded form.
      abstract java.lang.String toString()
      Returns a string representation of this certificate.
      abstract void verify(java.security.PublicKey key)
      Verifies that this certificate was signed using the private key that corresponds to the specified public key.
      void verify(java.security.PublicKey key, java.security.Provider sigProvider)
      Verifies that this certificate was signed using the private key that corresponds to the specified public key.
      abstract void verify(java.security.PublicKey key, java.lang.String sigProvider)
      Verifies that this certificate was signed using the private key that corresponds to the specified public key.
      protected java.lang.Object writeReplace()
      Replace the Certificate to be serialized.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • getType

        public final java.lang.String getType()
        Returns the type of this certificate.
        Returns:
        the type of this certificate.
      • equals

        public boolean equals(java.lang.Object other)
        Compares this certificate for equality with the specified object. If the other object is an instanceof Certificate, then its encoded form is retrieved and compared with the encoded form of this certificate.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        other - the object to test for equality with this certificate.
        Returns:
        true iff the encoded forms of the two certificates match, false otherwise.
      • hashCode

        public int hashCode()
        Returns a hashcode value for this certificate from its encoded form.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        the hashcode value.
      • getEncoded

        public abstract byte[] getEncoded()
                                   throws CertificateEncodingException
        Returns the encoded form of this certificate. It is assumed that each certificate type would have only a single form of encoding; for example, X.509 certificates would be encoded as ASN.1 DER.
        Returns:
        the encoded form of this certificate
        Throws:
        CertificateEncodingException - if an encoding error occurs.
      • verify

        public abstract void verify(java.security.PublicKey key)
                             throws CertificateException,
                                    java.security.NoSuchAlgorithmException,
                                    java.security.InvalidKeyException,
                                    java.security.NoSuchProviderException,
                                    java.security.SignatureException
        Verifies that this certificate was signed using the private key that corresponds to the specified public key.
        Parameters:
        key - the PublicKey used to carry out the verification.
        Throws:
        java.security.NoSuchAlgorithmException - on unsupported signature algorithms.
        java.security.InvalidKeyException - on incorrect key.
        java.security.NoSuchProviderException - if there's no default provider.
        java.security.SignatureException - on signature errors.
        CertificateException - on encoding errors.
      • verify

        public abstract void verify(java.security.PublicKey key,
                                    java.lang.String sigProvider)
                             throws CertificateException,
                                    java.security.NoSuchAlgorithmException,
                                    java.security.InvalidKeyException,
                                    java.security.NoSuchProviderException,
                                    java.security.SignatureException
        Verifies that this certificate was signed using the private key that corresponds to the specified public key. This method uses the signature verification engine supplied by the specified provider.
        Parameters:
        key - the PublicKey used to carry out the verification.
        sigProvider - the name of the signature provider.
        Throws:
        java.security.NoSuchAlgorithmException - on unsupported signature algorithms.
        java.security.InvalidKeyException - on incorrect key.
        java.security.NoSuchProviderException - on incorrect provider.
        java.security.SignatureException - on signature errors.
        CertificateException - on encoding errors.
      • verify

        public void verify(java.security.PublicKey key,
                           java.security.Provider sigProvider)
                    throws CertificateException,
                           java.security.NoSuchAlgorithmException,
                           java.security.InvalidKeyException,
                           java.security.SignatureException
        Verifies that this certificate was signed using the private key that corresponds to the specified public key. This method uses the signature verification engine supplied by the specified provider. Note that the specified Provider object does not have to be registered in the provider list.

        This method was added to version 1.8 of the Java Platform Standard Edition. In order to maintain backwards compatibility with existing service providers, this method cannot be abstract and by default throws an UnsupportedOperationException.

        Parameters:
        key - the PublicKey used to carry out the verification.
        sigProvider - the signature provider.
        Throws:
        java.security.NoSuchAlgorithmException - on unsupported signature algorithms.
        java.security.InvalidKeyException - on incorrect key.
        java.security.SignatureException - on signature errors.
        CertificateException - on encoding errors.
        java.lang.UnsupportedOperationException - if the method is not supported
        Since:
        1.8
      • toString

        public abstract java.lang.String toString()
        Returns a string representation of this certificate.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of this certificate.
      • getPublicKey

        public abstract java.security.PublicKey getPublicKey()
        Gets the public key from this certificate.
        Returns:
        the public key.
      • writeReplace

        protected java.lang.Object writeReplace()
                                         throws java.io.ObjectStreamException
        Replace the Certificate to be serialized.
        Returns:
        the alternate Certificate object to be serialized
        Throws:
        java.io.ObjectStreamException - if a new object representing this Certificate could not be created
        Since:
        1.3

© Portions Copyright 2003, 2015 IBM Corporation. All rights reserved.
© Portions Copyright 2003, 2015, Oracle and/or its affiliates. All rights reserved.