Class CertPathValidatorException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- java.security.GeneralSecurityException
-
- java.security.cert.CertPathValidatorException
- All Implemented Interfaces:
Serializable
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.
- Since:
- 1.4
- See Also:
-
CertPathValidator
, Serialized Form
Nested Class Summary
Modifier and Type | Class | Description |
---|---|---|
static class | CertPathValidatorException.BasicReason | The BasicReason enumerates the potential reasons that a certification path of any type may be invalid. |
static interface | CertPathValidatorException.Reason | The reason the validation algorithm failed. |
Constructor Summary
Constructor | Description |
---|---|
CertPathValidatorException() | Creates a |
CertPathValidatorException(String msg) | Creates a |
CertPathValidatorException(String msg,
Throwable cause) | Creates a |
CertPathValidatorException(String msg,
Throwable cause,
CertPath certPath,
int index) | Creates a |
CertPathValidatorException(String msg,
Throwable cause,
CertPath certPath,
int index,
CertPathValidatorException.Reason reason) | Creates a |
CertPathValidatorException(Throwable cause) | Creates a |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
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. |
Methods declared in class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Constructor Detail
CertPathValidatorException
public CertPathValidatorException()
Creates a CertPathValidatorException
with no detail message.
CertPathValidatorException
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
CertPathValidatorException
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 thegetCause()
method). (Anull
value is permitted, and indicates that the cause is nonexistent or unknown.)
CertPathValidatorException
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 thegetCause()
method). (Anull
value is permitted, and indicates that the cause is nonexistent or unknown.)
CertPathValidatorException
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 (ornull
if none) -
cause
- the cause (ornull
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 aCertPath
is zero based. - Throws:
-
IndexOutOfBoundsException
- if the index is out of range(index < -1 || (certPath != null && index >= certPath.getCertificates().size())
-
IllegalArgumentException
- ifcertPath
isnull
andindex
is not -1
CertPathValidatorException
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 (ornull
if none) -
cause
- the cause (ornull
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 aCertPath
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
- ifcertPath
isnull
andindex
is not -1 -
NullPointerException
- ifreason
isnull
- Since:
- 1.7
Method Detail
getCertPath
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 (ornull
if not specified)
getIndex
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
getReason
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 - Since:
- 1.7