FileDocCategorySizeDatePackage
CertPathValidatorException.javaAPI DocJava SE 5 API5776Fri Aug 26 14:57:16 BST 2005java.security.cert

CertPathValidatorException

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 {@link #getCause 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 {@link #getCertPath getCertPath} and {@link #getIndex 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.

see
CertPathValidator
version
1.10 12/19/03
since
1.4
author
Yassir Elley

Fields Summary
private static final long
serialVersionUID
private int
index
private CertPath
certPath
Constructors Summary
public CertPathValidatorException()
Creates a CertPathValidatorException with no detail message.


                  
      
        super();
    
public CertPathValidatorException(String msg)
Creates a CertPathValidatorException with the given detail message. A detail message is a String that describes this particular exception.

param
msg the detail message

        super(msg);
    
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).

param
cause the cause (which is saved for later retrieval by the {@link #getCause getCause()} method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

	super(cause);
    
public CertPathValidatorException(String msg, Throwable cause)
Creates a CertPathValidatorException with the specified detail message and cause.

param
msg the detail message
param
cause the cause (which is saved for later retrieval by the {@link #getCause getCause()} method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

        super(msg, cause);
    
public CertPathValidatorException(String msg, Throwable cause, CertPath certPath, int index)
Creates a CertPathValidatorException with the specified detail message, cause, certification path, and index.

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

        super(msg, cause);
	if (certPath == null && index != -1) {
	    throw new IllegalArgumentException();
	}
	if (index < -1 || 
	    (certPath != null && index >= certPath.getCertificates().size())) {
	    throw new IndexOutOfBoundsException();
	}
	this.certPath = certPath;
	this.index = index;
    
Methods Summary
public java.security.cert.CertPathgetCertPath()
Returns the certification path that was being validated when the exception was thrown.

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

        return this.certPath;
    
public intgetIndex()
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.

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

	return this.index;