CertificateRevokedException (Java Platform SE 8 )
Keywords: java.security.cert.CertificateRevokedException class
Date: 2017-01-22

compact1, compact2, compact3
java.security.cert

## Class CertificateRevokedException

- java.lang.Object
- - java.lang.Throwable
  - - java.lang.Exception
    - - java.security.GeneralSecurityException
      - - java.security.cert.CertificateException
        - - java.security.cert.CertificateRevokedException

- All Implemented Interfaces:
    Serializable

      public class CertificateRevokedException
      extends CertificateException

  An exception that indicates an X.509 certificate is revoked. A `CertificateRevokedException` contains additional information about the revoked certificate, such as the date on which the certificate was revoked and the reason it was revoked.
  Since:
    1.7
  See Also:
    `CertPathValidatorException`, Serialized Form

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `CertificateRevokedException(Date revocationDate, CRLReason reason, X500Principal authority, Map<String,Extension> extensions)` Constructs a `CertificateRevokedException` with the specified revocation date, reason code, authority name, and map of extensions.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `X500Principal` | `getAuthorityName()` Returns the name of the authority that signed the certificate's revocation status information.
    `Map<String,Extension>` | `getExtensions()` Returns a map of X.509 extensions containing additional information about the revoked certificate, such as the Invalidity Date Extension.
    `Date` | `getInvalidityDate()` Returns the invalidity date, as specified in the Invalidity Date extension of this `CertificateRevokedException`.
    `String` | `getMessage()` Returns the detail message string of this throwable.
    `Date` | `getRevocationDate()` Returns the date on which the certificate was revoked.
    `CRLReason` | `getRevocationReason()` Returns the reason the certificate was revoked.

    - ### Methods inherited from class java.lang.Throwable

      `addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### CertificateRevokedException

          public CertificateRevokedException(Date revocationDate,
                                             CRLReason reason,
                                             X500Principal authority,
                                             Map<String,Extension> extensions)

      Constructs a `CertificateRevokedException` with the specified revocation date, reason code, authority name, and map of extensions.
      Parameters:
        `revocationDate` - the date on which the certificate was revoked. The date is copied to protect against subsequent modification.
        `reason` - the revocation reason
        `extensions` - a map of X.509 Extensions. Each key is an OID String that maps to the corresponding Extension. The map is copied to prevent subsequent modification.
        `authority` - the `X500Principal` that represents the name of the authority that signed the certificate's revocation status information
      Throws:
        `NullPointerException` - if `revocationDate`, `reason`, `authority`, or `extensions` is `null`

  - ### Method Detail

    - #### getRevocationDate

          public Date getRevocationDate()

      Returns the date on which the certificate was revoked. A new copy is returned each time the method is invoked to protect against subsequent modification.
      Returns:
        the revocation date

    - #### getRevocationReason

          public CRLReason getRevocationReason()

      Returns the reason the certificate was revoked.
      Returns:
        the revocation reason

    - #### getAuthorityName

          public X500Principal getAuthorityName()

      Returns the name of the authority that signed the certificate's revocation status information.
      Returns:
        the `X500Principal` that represents the name of the authority that signed the certificate's revocation status information

    - #### getInvalidityDate

          public Date getInvalidityDate()

      Returns the invalidity date, as specified in the Invalidity Date extension of this `CertificateRevokedException`. The invalidity date is the date on which it is known or suspected that the private key was compromised or that the certificate otherwise became invalid. This implementation calls `getExtensions()` and checks the returned map for an entry for the Invalidity Date extension OID ("2.5.29.24"). If found, it returns the invalidity date in the extension; otherwise null. A new Date object is returned each time the method is invoked to protect against subsequent modification.
      Returns:
        the invalidity date, or `null` if not specified

    - #### getExtensions

          public Map<String,Extension> getExtensions()

      Returns a map of X.509 extensions containing additional information about the revoked certificate, such as the Invalidity Date Extension. Each key is an OID String that maps to the corresponding Extension.
      Returns:
        an unmodifiable map of X.509 extensions, or an empty map if there are no extensions

    - #### getMessage

          public String getMessage()

      Description copied from class: `Throwable`
      Returns the detail message string of this throwable.
      Overrides:
        `getMessage` in class `Throwable`
      Returns:
        the detail message string of this `Throwable` instance (which may be `null`).

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.