CertPathValidatorException

AI-generated Key Takeaways

• CertPathValidatorException signals problems during certification path validation.

• It can wrap other exceptions, provide context with the problematic certificate's path and index, and specify a reason for the failure.

• This exception offers methods to retrieve the certificate path, problematic certificate index, and the reason for validation failure.

• Methods in CertPathValidatorException are generally not thread-safe and require synchronization for concurrent access by multiple threads.

public class CertPathValidatorException extends GeneralSecurityException

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

• CertPathValidator

Nested Class Summary

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 Constructor Summary

	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 Method Summary

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 Method Summary

From class java.lang.Throwable

synchronized final void	addSuppressed(Throwable exception) Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
synchronized Throwable	fillInStackTrace() Fills in the execution stack trace.
synchronized Throwable	getCause() Returns the cause of this throwable or null if the cause is nonexistent or unknown.
String	getLocalizedMessage() Creates a localized description of this throwable.
String	getMessage() Returns the detail message string of this throwable.
StackTraceElement[]	getStackTrace() Provides programmatic access to the stack trace information printed by printStackTrace().
synchronized final Throwable[]	getSuppressed() Returns an array containing all of the exceptions that were suppressed, typically by the try-with-resources statement, in order to deliver this exception.
synchronized Throwable	initCause(Throwable cause) Initializes the cause of this throwable to the specified value.
void	printStackTrace() Prints this throwable and its backtrace to the standard error stream.
void	printStackTrace(PrintWriter s) Prints this throwable and its backtrace to the specified print writer.
void	printStackTrace(PrintStream s) Prints this throwable and its backtrace to the specified print stream.
void	setStackTrace(StackTraceElement[] stackTrace) Sets the stack trace elements that will be returned by getStackTrace() and printed by printStackTrace() and related methods.
String	toString() Returns a short description of this throwable.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Constructors

public CertPathValidatorException ()

Creates a CertPathValidatorException with no detail message.

public CertPathValidatorException (String msg)

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

Parameters

msg	the detail message

public 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	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.)

public CertPathValidatorException (String msg, Throwable cause)

Creates a CertPathValidatorException with the specified detail message and cause.

Parameters

msg	the detail message
cause	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.)

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

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

Parameters

msg	the detail message (or null if none)
cause	the cause (or null if none)
certPath	the certification path that was in the process of being validated when the error was encountered
index	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

public 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	the detail message (or null if none)
cause	the cause (or null if none)
certPath	the certification path that was in the process of being validated when the error was encountered
index	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	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

public CertPath getCertPath ()

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

Returns

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

public 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

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

public CertPathValidatorException.Reason getReason ()

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

Returns

• the reason that the validation failed, or BasicReason.UNSPECIFIED if a reason has not been specified