java.security.cert
Class CertPathValidatorException

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.lang.Throwable sample code for java.lang.Throwable definition code for java.lang.Throwable 
      extended by java.lang.Exception sample code for java.lang.Exception definition code for java.lang.Exception 
          extended by java.security.GeneralSecurityException sample code for java.security.GeneralSecurityException definition code for java.security.GeneralSecurityException 
              extended by java.security.cert.CertPathValidatorException
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public class CertPathValidatorException
extends GeneralSecurityException sample code for java.security.GeneralSecurityException definition code for java.security.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 sample code for java.lang.Throwable.getCause() definition code for java.lang.Throwable.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 and the index of the certificate in the certification path that caused the exception to be thrown. Use the getCertPath sample code for java.security.cert.CertPathValidatorException.getCertPath() definition code for java.security.cert.CertPathValidatorException.getCertPath() and getIndex sample code for java.security.cert.CertPathValidatorException.getIndex() definition code for java.security.cert.CertPathValidatorException.getIndex() 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 sample code for java.security.cert.CertPathValidator definition code for java.security.cert.CertPathValidator , Serialized Form

Constructor Summary
CertPathValidatorException sample code for java.security.cert.CertPathValidatorException.CertPathValidatorException() definition code for java.security.cert.CertPathValidatorException.CertPathValidatorException() ()
          Creates a CertPathValidatorException with no detail message.
CertPathValidatorException sample code for java.security.cert.CertPathValidatorException.CertPathValidatorException(java.lang.String) definition code for java.security.cert.CertPathValidatorException.CertPathValidatorException(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  msg)
          Creates a CertPathValidatorException with the given detail message.
CertPathValidatorException sample code for java.security.cert.CertPathValidatorException.CertPathValidatorException(java.lang.String, java.lang.Throwable) definition code for java.security.cert.CertPathValidatorException.CertPathValidatorException(java.lang.String, java.lang.Throwable) (String sample code for java.lang.String definition code for java.lang.String  msg, Throwable sample code for java.lang.Throwable definition code for java.lang.Throwable  cause)
          Creates a CertPathValidatorException with the specified detail message and cause.
CertPathValidatorException sample code for java.security.cert.CertPathValidatorException.CertPathValidatorException(java.lang.String, java.lang.Throwable, java.security.cert.CertPath, int) definition code for java.security.cert.CertPathValidatorException.CertPathValidatorException(java.lang.String, java.lang.Throwable, java.security.cert.CertPath, int) (String sample code for java.lang.String definition code for java.lang.String  msg, Throwable sample code for java.lang.Throwable definition code for java.lang.Throwable  cause, CertPath sample code for java.security.cert.CertPath definition code for java.security.cert.CertPath  certPath, int index)
          Creates a CertPathValidatorException with the specified detail message, cause, certification path, and index.
CertPathValidatorException sample code for java.security.cert.CertPathValidatorException.CertPathValidatorException(java.lang.Throwable) definition code for java.security.cert.CertPathValidatorException.CertPathValidatorException(java.lang.Throwable) (Throwable sample code for java.lang.Throwable definition code for java.lang.Throwable  cause)
          Creates a CertPathValidatorException that wraps the specified throwable.
 
Method Summary
 CertPath sample code for java.security.cert.CertPath definition code for java.security.cert.CertPath getCertPath sample code for java.security.cert.CertPathValidatorException.getCertPath() definition code for java.security.cert.CertPathValidatorException.getCertPath() ()
          Returns the certification path that was being validated when the exception was thrown.
 int getIndex sample code for java.security.cert.CertPathValidatorException.getIndex() definition code for java.security.cert.CertPathValidatorException.getIndex() ()
          Returns the index of the certificate in the certification path that caused the exception to be thrown.
 
Methods inherited from class java.lang.Throwable sample code for java.lang.Throwable definition code for java.lang.Throwable
fillInStackTrace sample code for java.lang.Throwable.fillInStackTrace() definition code for java.lang.Throwable.fillInStackTrace() , getCause sample code for java.lang.Throwable.getCause() definition code for java.lang.Throwable.getCause() , getLocalizedMessage sample code for java.lang.Throwable.getLocalizedMessage() definition code for java.lang.Throwable.getLocalizedMessage() , getMessage sample code for java.lang.Throwable.getMessage() definition code for java.lang.Throwable.getMessage() , getStackTrace sample code for java.lang.Throwable.getStackTrace() definition code for java.lang.Throwable.getStackTrace() , initCause sample code for java.lang.Throwable.initCause(java.lang.Throwable) definition code for java.lang.Throwable.initCause(java.lang.Throwable) , printStackTrace sample code for java.lang.Throwable.printStackTrace() definition code for java.lang.Throwable.printStackTrace() , printStackTrace sample code for java.lang.Throwable.printStackTrace(java.io.PrintStream) definition code for java.lang.Throwable.printStackTrace(java.io.PrintStream) , printStackTrace sample code for java.lang.Throwable.printStackTrace(java.io.PrintWriter) definition code for java.lang.Throwable.printStackTrace(java.io.PrintWriter) , setStackTrace sample code for java.lang.Throwable.setStackTrace(java.lang.StackTraceElement[]) definition code for java.lang.Throwable.setStackTrace(java.lang.StackTraceElement[]) , toString sample code for java.lang.Throwable.toString() definition code for java.lang.Throwable.toString()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

CertPathValidatorException sample code for java.security.cert.CertPathValidatorException() definition code for java.security.cert.CertPathValidatorException()

public CertPathValidatorException()
Creates a CertPathValidatorException with no detail message.


CertPathValidatorException sample code for java.security.cert.CertPathValidatorException(java.lang.String) definition code for java.security.cert.CertPathValidatorException(java.lang.String)

public CertPathValidatorException(String sample code for java.lang.String definition code for java.lang.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 sample code for java.security.cert.CertPathValidatorException(java.lang.Throwable) definition code for java.security.cert.CertPathValidatorException(java.lang.Throwable)

public CertPathValidatorException(Throwable sample code for java.lang.Throwable definition code for java.lang.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() sample code for java.lang.Throwable.getCause() definition code for java.lang.Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

CertPathValidatorException sample code for java.security.cert.CertPathValidatorException(java.lang.String, java.lang.Throwable) definition code for java.security.cert.CertPathValidatorException(java.lang.String, java.lang.Throwable)

public CertPathValidatorException(String sample code for java.lang.String definition code for java.lang.String  msg,
                                  Throwable sample code for java.lang.Throwable definition code for java.lang.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() sample code for java.lang.Throwable.getCause() definition code for java.lang.Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

CertPathValidatorException sample code for java.security.cert.CertPathValidatorException(java.lang.String, java.lang.Throwable, java.security.cert.CertPath, int) definition code for java.security.cert.CertPathValidatorException(java.lang.String, java.lang.Throwable, java.security.cert.CertPath, int)

public CertPathValidatorException(String sample code for java.lang.String definition code for java.lang.String  msg,
                                  Throwable sample code for java.lang.Throwable definition code for java.lang.Throwable  cause,
                                  CertPath sample code for java.security.cert.CertPath definition code for java.security.cert.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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if certPath is null and index is not -1
Method Detail

getCertPath sample code for java.security.cert.CertPathValidatorException.getCertPath() definition code for java.security.cert.CertPathValidatorException.getCertPath()

public CertPath sample code for java.security.cert.CertPath definition code for java.security.cert.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 sample code for java.security.cert.CertPathValidatorException.getIndex() definition code for java.security.cert.CertPathValidatorException.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