• Home
  • History
  • Annotate
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1  /*
2   * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved.
3   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4   *
5   * This code is free software; you can redistribute it and/or modify it
6   * under the terms of the GNU General Public License version 2 only, as
7   * published by the Free Software Foundation.  Oracle designates this
8   * particular file as subject to the "Classpath" exception as provided
9   * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package java.security.cert;
27  
28  import java.security.GeneralSecurityException;
29  
30  /**
31   * An exception indicating one of a variety of problems encountered when
32   * building a certification path with a {@code CertPathBuilder}.
33   * <p>
34   * A {@code CertPathBuilderException} provides support for wrapping
35   * exceptions. The {@link #getCause getCause} method returns the throwable,
36   * if any, that caused this exception to be thrown.
37   * <p>
38   * <b>Concurrent Access</b>
39   * <p>
40   * Unless otherwise specified, the methods defined in this class are not
41   * thread-safe. Multiple threads that need to access a single
42   * object concurrently should synchronize amongst themselves and
43   * provide the necessary locking. Multiple threads each manipulating
44   * separate objects need not synchronize.
45   *
46   * @see CertPathBuilder
47   *
48   * @since       1.4
49   * @author      Sean Mullan
50   */
51  public class CertPathBuilderException extends GeneralSecurityException {
52  
53      private static final long serialVersionUID = 5316471420178794402L;
54  
55      /**
56       * Creates a {@code CertPathBuilderException} with {@code null}
57       * as its detail message.
58       */
CertPathBuilderException()59      public CertPathBuilderException() {
60          super();
61      }
62  
63      /**
64       * Creates a {@code CertPathBuilderException} with the given
65       * detail message. The detail message is a {@code String} that
66       * describes this particular exception in more detail.
67       *
68       * @param msg the detail message
69       */
CertPathBuilderException(String msg)70      public CertPathBuilderException(String msg) {
71          super(msg);
72      }
73  
74      /**
75       * Creates a {@code CertPathBuilderException} that wraps the specified
76       * throwable. This allows any exception to be converted into a
77       * {@code CertPathBuilderException}, while retaining information
78       * about the wrapped exception, which may be useful for debugging. The
79       * detail message is set to ({@code cause==null ? null : cause.toString()})
80       * (which typically contains the class and detail message of
81       * cause).
82       *
83       * @param cause the cause (which is saved for later retrieval by the
84       * {@link #getCause getCause()} method). (A {@code null} value is
85       * permitted, and indicates that the cause is nonexistent or unknown.)
86       */
CertPathBuilderException(Throwable cause)87      public CertPathBuilderException(Throwable cause) {
88          super(cause);
89      }
90  
91      /**
92       * Creates a {@code CertPathBuilderException} with the specified
93       * detail message and cause.
94       *
95       * @param msg the detail message
96       * @param  cause the cause (which is saved for later retrieval by the
97       * {@link #getCause getCause()} method). (A {@code null} value is
98       * permitted, and indicates that the cause is nonexistent or unknown.)
99       */
CertPathBuilderException(String msg, Throwable cause)100      public CertPathBuilderException(String msg, Throwable cause) {
101          super(msg, cause);
102      }
103  
104  }
105