CertPathValidatorException (Java 2 Platform SE v1.4.1_"07")

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

JavaTM 2 Platform
Std. Ed. v1.4.1_"07"

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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 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 and the index of the certificate in the certification path that caused the exception to be thrown. Use the `getCertPath` and `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`, Serialized Form

Constructor Summary
`CertPathValidatorException()` Creates a `CertPathValidatorException` with no detail message.
`CertPathValidatorException(String msg)` Creates a `CertPathValidatorException` with the given detail message.
`CertPathValidatorException(String msg, Throwable cause)` Creates a `CertPathValidatorException` with the specified detail message and cause.
`CertPathValidatorException(String msg, Throwable cause, CertPath certPath, int index)` Creates a `CertPathValidatorException` with the specified detail message, cause, certification path, and index.
`CertPathValidatorException(Throwable cause)` Creates a `CertPathValidatorException` that wraps the specified throwable.

Method Summary
`Throwable` | `getCause()` Returns the cause of this `CertPathValidatorException` or `null` if the cause is nonexistent or unknown.
`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.
`String` | `getMessage()` Returns the detail message for this `CertPathValidatorException`.
`void` | `printStackTrace()` Prints a stack trace to `System.err`, including the backtrace of the cause, if any.
`void` | `printStackTrace(PrintStream ps)` Prints a stack trace to a `PrintStream`, including the backtrace of the cause, if any.
`void` | `printStackTrace(PrintWriter pw)` Prints a stack trace to a `PrintWriter`, including the backtrace of the cause, if any.
`String` | `toString()` Returns a string describing this exception, including a description of the internal (wrapped) cause if there is one.

Methods inherited from class java.lang.Throwable
`fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, setStackTrace`

Methods inherited from 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 the `getCause()` method). (A `null` 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 the `getCause()` method). (A `null` 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 (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` - if `certPath` is `null` and `index` is not -1

Method Detail

### getMessage

    public String getMessage()

  Returns the detail message for this `CertPathValidatorException`.

  Overrides:
    `getMessage` in class `Throwable`
  Returns:
    the detail message, or `null` if neither the message nor cause were specified

### 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 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

### getCause

    public Throwable getCause()

  Returns the cause of this `CertPathValidatorException` or `null` if the cause is nonexistent or unknown.

  Overrides:
    `getCause` in class `Throwable`
  Returns:
    the cause of this throwable or `null` if the cause is nonexistent or unknown.

### toString

    public String toString()

  Returns a string describing this exception, including a description of the internal (wrapped) cause 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 backtrace of the cause, if any.

  Overrides:
    `printStackTrace` in class `Throwable`

### printStackTrace

    public void printStackTrace(PrintStream ps)

  Prints a stack trace to a `PrintStream`, including the backtrace of the cause, 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 backtrace of the cause, if any.

  Overrides:
    `printStackTrace` in class `Throwable`
  Parameters:
    `pw` - the `PrintWriter` to use for output

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

JavaTM 2 Platform
Std. Ed. v1.4.1_"07"

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.