Class CertPathValidatorException
- All Implemented Interfaces:
Serializable
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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumThe BasicReason enumerates the potential reasons that a certification path of any type may be invalid.static interfaceThe reason the validation algorithm failed. -
Constructor Summary
ConstructorsConstructorDescriptionCreates aCertPathValidatorExceptionwith no detail message.Creates aCertPathValidatorExceptionwith the given detail message.CertPathValidatorException(String msg, Throwable cause) Creates aCertPathValidatorExceptionwith the specified detail message and cause.CertPathValidatorException(String msg, Throwable cause, CertPath certPath, int index) Creates aCertPathValidatorExceptionwith the specified detail message, cause, certification path, and index.CertPathValidatorException(String msg, Throwable cause, CertPath certPath, int index, CertPathValidatorException.Reason reason) Creates aCertPathValidatorExceptionwith the specified detail message, cause, certification path, index, and reason.Creates aCertPathValidatorExceptionthat wraps the specified throwable. -
Method Summary
Modifier and TypeMethodDescriptionReturns the certification path that was being validated when the exception was thrown.intgetIndex()Returns the index of the certificate in the certification path that caused the exception to be thrown.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
-
Constructor Details
-
CertPathValidatorException
public CertPathValidatorException()Creates aCertPathValidatorExceptionwith no detail message. -
CertPathValidatorException
Creates aCertPathValidatorExceptionwith the given detail message. A detail message is aStringthat describes this particular exception.- Parameters:
msg- the detail message
-
CertPathValidatorException
Creates aCertPathValidatorExceptionthat wraps the specified throwable. This allows any exception to be converted into aCertPathValidatorException, 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). (Anullvalue is permitted, and indicates that the cause is nonexistent or unknown.)
-
CertPathValidatorException
Creates aCertPathValidatorExceptionwith the specified detail message and cause.- Parameters:
msg- the detail messagecause- the cause (which is saved for later retrieval by thegetCause()method). (Anullvalue is permitted, and indicates that the cause is nonexistent or unknown.)
-
CertPathValidatorException
Creates aCertPathValidatorExceptionwith the specified detail message, cause, certification path, and index.- Parameters:
msg- the detail message (ornullif none)cause- the cause (ornullif none)certPath- the certification path that was in the process of being validated when the error was encounteredindex- 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 aCertPathis zero based.- Throws:
IndexOutOfBoundsException- if the index is out of range(index < -1 || (certPath != null && index >= certPath.getCertificates().size())IllegalArgumentException- ifcertPathisnullandindexis not -1
-
CertPathValidatorException
public CertPathValidatorException(String msg, Throwable cause, CertPath certPath, int index, CertPathValidatorException.Reason reason) Creates aCertPathValidatorExceptionwith the specified detail message, cause, certification path, index, and reason.- Parameters:
msg- the detail message (ornullif none)cause- the cause (ornullif none)certPath- the certification path that was in the process of being validated when the error was encounteredindex- 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 aCertPathis 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- ifcertPathisnullandindexis not -1NullPointerException- ifreasonisnull- Since:
- 1.7
-
-
Method Details
-
getCertPath
Returns the certification path that was being validated when the exception was thrown.- Returns:
- the
CertPaththat was being validated when the exception was thrown (ornullif 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 aCertPathis 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
Returns the reason that the validation failed. The reason is associated with the index of the certificate returned bygetIndex().- Returns:
- the reason that the validation failed, or
BasicReason.UNSPECIFIEDif a reason has not been specified - Since:
- 1.7
-