lightbulb_outline Please take our October 2018 developer survey. Start survey

CertificateRevokedException

public class CertificateRevokedException
extends CertificateException

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


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.

Summary

Public constructors

CertificateRevokedException(Date revocationDate, CRLReason reason, X500Principal authority, Map<StringExtension> extensions)

Constructs a CertificateRevokedException with the specified revocation date, reason code, authority name, and map of extensions.

Public methods

X500Principal getAuthorityName()

Returns the name of the authority that signed the certificate's revocation status information.

Map<StringExtension> 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.

Inherited methods

Public constructors

CertificateRevokedException

added in API level 24
public CertificateRevokedException (Date revocationDate, 
                CRLReason reason, 
                X500Principal authority, 
                Map<StringExtension> extensions)

Constructs a CertificateRevokedException with the specified revocation date, reason code, authority name, and map of extensions.

Parameters
revocationDate Date: the date on which the certificate was revoked. The date is copied to protect against subsequent modification.

reason CRLReason: the revocation reason

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

extensions Map: 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.

Throws
NullPointerException if revocationDate, reason, authority, or extensions is null

Public methods

getAuthorityName

added in API level 24
public X500Principal getAuthorityName ()

Returns the name of the authority that signed the certificate's revocation status information.

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

getExtensions

added in API level 24
public Map<StringExtension> 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
Map<StringExtension> an unmodifiable map of X.509 extensions, or an empty map if there are no extensions

getInvalidityDate

added in API level 24
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
Date the invalidity date, or null if not specified

getMessage

added in API level 24
public String getMessage ()

Returns the detail message string of this throwable.

Returns
String the detail message string of this Throwable instance (which may be null).

getRevocationDate

added in API level 24
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
Date the revocation date

getRevocationReason

added in API level 24
public CRLReason getRevocationReason ()

Returns the reason the certificate was revoked.

Returns
CRLReason the revocation reason