java.security.cert
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 retrieving the certification path that was being validated when the exception was thrown, as well as retrieving the index of the certificate in the certification path that caused the exception to be thrown.

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

Constructor Summary

CertPathValidatorException()

CertPathValidatorException(Exception e)
Creates a CertPathValidatorException that wraps the specified exception.

CertPathValidatorException(String msg)
Creates a CertPathValidatorException with the given detail message.

CertPathValidatorException(String msg, Exception e)
Creates a CertPathValidatorException with the given detail message and internal exception.

CertPathValidatorException(String msg, Exception e, CertPath certPath, int index)
Creates a CertPathValidatorException with the given detail message, internal exception, certification path, and index.

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.
Exception	getInternalException() Returns the internal (wrapped) exception, or null if there is no internal exception.
void	printStackTrace() Prints a stack trace to System.err, including the internal exception, if any.
void	printStackTrace(PrintStream ps) Prints a stack trace to a PrintStream, including the internal exception, if any.
void	printStackTrace(PrintWriter pw) Prints a stack trace to a PrintWriter, including the internal exception, if any.
String	toString() Returns a string describing this exception, including a description of the internal (wrapped) exception if there is one.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CertPathValidatorException

public CertPathValidatorException()

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(Exception e)

Creates a CertPathValidatorException that wraps the specified exception. This allows any exception to be converted into a CertPathValidatorException, while retaining information about the wrapped exception, which may be useful for debugging.

Parameters:

e - the internal exception

CertPathValidatorException

public CertPathValidatorException(String msg,
                                  Exception e)

Creates a CertPathValidatorException with the given detail message and internal exception.

Parameters:

msg - the detail message

e - the internal exception

CertPathValidatorException

public CertPathValidatorException(String msg,
                                  Exception e,
                                  CertPath certPath,
                                  int index)

Creates a CertPathValidatorException with the given detail message, internal exception, certification path, and index.

Parameters:

msg - the detail message (or null if none)

e - the internal exception (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 CertPaths are 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

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 (or null 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 CertPaths are 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

getInternalException

public Exception getInternalException()

Returns the internal (wrapped) exception, or null if there is no internal exception.

Returns:

the internal exception, or null if there is no internal exception

toString

public String toString()

Returns a string describing this exception, including a description of the internal (wrapped) exception if there is one.

Overrides:

toString in class Throwable

Returns:

a string representation of this CertPathValidatorException

printStackTrace

public void printStackTrace()

Prints a stack trace to System.err, including the internal exception, if any.

Overrides:

printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintStream ps)

Prints a stack trace to a PrintStream, including the internal exception, if any.

Overrides:

printStackTrace in class Throwable

Parameters:

ps - the PrintStream to use for output

printStackTrace

public void printStackTrace(PrintWriter pw)

Prints a stack trace to a PrintWriter, including the internal exception, if any.

Overrides:

printStackTrace in class Throwable

Parameters:

pw - the PrintWriter to use for output