Skip to content

Most visited

Recently visited

navigation

CertPathValidatorException

public class CertPathValidatorException
extends GeneralSecurityException

java.lang.Object
   ↳ java.lang.Throwable
     ↳ java.lang.Exception
       ↳ java.security.GeneralSecurityException
         ↳ java.security.cert.CertPathValidatorException


An exception indicating one of a variety of problems encountered when validating a certification path.

A CertPathValidatorException provides support for wrapping exceptions. The getCause method returns the throwable, if any, that caused this exception to be thrown.

A CertPathValidatorException may also include the certification path that was being validated when the exception was thrown, the index of the certificate in the certification path that caused the exception to be thrown, and the reason that caused the failure. Use the getCertPath, getIndex, and getReason methods to retrieve this information.

Concurrent Access

Unless otherwise specified, the methods defined in this class are not thread-safe. Multiple threads that need to access a single object concurrently should synchronize amongst themselves and provide the necessary locking. Multiple threads each manipulating separate objects need not synchronize.

See also:

Summary

Nested classes

enum CertPathValidatorException.BasicReason

The BasicReason enumerates the potential reasons that a certification path of any type may be invalid. 

interface CertPathValidatorException.Reason

The reason the validation algorithm failed. 

Public constructors

CertPathValidatorException()

Creates a CertPathValidatorException with no detail message.

CertPathValidatorException(String msg)

Creates a CertPathValidatorException with the given detail message.

CertPathValidatorException(Throwable cause)

Creates a CertPathValidatorException that wraps the specified throwable.

CertPathValidatorException(String msg, Throwable cause)

Creates a CertPathValidatorException with the specified detail message and cause.

CertPathValidatorException(String msg, Throwable cause, CertPath certPath, int index)

Creates a CertPathValidatorException with the specified detail message, cause, certification path, and index.

CertPathValidatorException(String msg, Throwable cause, CertPath certPath, int index, CertPathValidatorException.Reason reason)

Creates a CertPathValidatorException with the specified detail message, cause, certification path, index, and reason.

Public methods

CertPath getCertPath()

Returns the certification path that was being validated when the exception was thrown.

int getIndex()

Returns the index of the certificate in the certification path that caused the exception to be thrown.

CertPathValidatorException.Reason getReason()

Returns the reason that the validation failed.

Inherited methods

From class java.lang.Throwable
From class java.lang.Object

Public constructors

CertPathValidatorException

Added in API level 1
CertPathValidatorException ()

Creates a CertPathValidatorException with no detail message.

CertPathValidatorException

Added in API level 1
CertPathValidatorException (String msg)

Creates a CertPathValidatorException with the given detail message. A detail message is a String that describes this particular exception.

Parameters
msg String: the detail message

CertPathValidatorException

Added in API level 1
CertPathValidatorException (Throwable cause)

Creates a CertPathValidatorException that wraps the specified throwable. This allows any exception to be converted into a CertPathValidatorException, while retaining information about the wrapped exception, which may be useful for debugging. The detail message is set to (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

Parameters
cause Throwable: the cause (which is saved for later retrieval by the getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

CertPathValidatorException

Added in API level 1
CertPathValidatorException (String msg, 
                Throwable cause)

Creates a CertPathValidatorException with the specified detail message and cause.

Parameters
msg String: the detail message
cause Throwable: the cause (which is saved for later retrieval by the getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

CertPathValidatorException

Added in API level 1
CertPathValidatorException (String msg, 
                Throwable cause, 
                CertPath certPath, 
                int index)

Creates a CertPathValidatorException with the specified detail message, cause, certification path, and index.

Parameters
msg String: the detail message (or null if none)
cause Throwable: the cause (or null if none)
certPath CertPath: the certification path that was in the process of being validated when the error was encountered
index int: the index of the certificate in the certification path that caused the error (or -1 if not applicable). Note that the list of certificates in a CertPath is zero based.
Throws
IndexOutOfBoundsException if the index is out of range (index < -1 || (certPath != null && index >= certPath.getCertificates().size())
IllegalArgumentException if certPath is null and index is not -1

CertPathValidatorException

Added in API level 24
CertPathValidatorException (String msg, 
                Throwable cause, 
                CertPath certPath, 
                int index, 
                CertPathValidatorException.Reason reason)

Creates a CertPathValidatorException with the specified detail message, cause, certification path, index, and reason.

Parameters
msg String: the detail message (or null if none)
cause Throwable: the cause (or null if none)
certPath CertPath: the certification path that was in the process of being validated when the error was encountered
index int: the index of the certificate in the certification path that caused the error (or -1 if not applicable). Note that the list of certificates in a CertPath is zero based.
reason CertPathValidatorException.Reason: the reason the validation failed
Throws
IndexOutOfBoundsException if the index is out of range (index < -1 || (certPath != null && index >= certPath.getCertificates().size())
IllegalArgumentException if certPath is null and index is not -1
NullPointerException if reason is null

Public methods

getCertPath

Added in API level 1
CertPath getCertPath ()

Returns the certification path that was being validated when the exception was thrown.

Returns
CertPath the CertPath that was being validated when the exception was thrown (or null if not specified)

getIndex

Added in API level 1
int getIndex ()

Returns the index of the certificate in the certification path that caused the exception to be thrown. Note that the list of certificates in a CertPath is zero based. If no index has been set, -1 is returned.

Returns
int the index that has been set, or -1 if none has been set

getReason

Added in API level 24
CertPathValidatorException.Reason getReason ()

Returns the reason that the validation failed. The reason is associated with the index of the certificate returned by getIndex().

Returns
CertPathValidatorException.Reason the reason that the validation failed, or BasicReason.UNSPECIFIED if a reason has not been specified
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.