1 /*
2  * Copyright (c) 2005, 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  * $Id: XMLSignatureException.java,v 1.5 2005/05/10 16:03:48 mullan Exp $
27  */
28 package javax.xml.crypto.dsig;
29 
30 import java.io.PrintStream;
31 import java.io.PrintWriter;
32 
33 /**
34  * Indicates an exceptional condition that occurred during the XML
35  * signature generation or validation process.
36  *
37  * <p>An {@code XMLSignatureException} can contain a cause: another
38  * throwable that caused this {@code XMLSignatureException} to get thrown.
39  *
40  * @since 1.6
41  */
42 public class XMLSignatureException extends Exception {
43 
44     private static final long serialVersionUID = -3438102491013869995L;
45 
46     /**
47      * The throwable that caused this exception to get thrown, or null if this
48      * exception was not caused by another throwable or if the causative
49      * throwable is unknown.
50      *
51      * @serial
52      */
53     private Throwable cause;
54 
55     /**
56      * Constructs a new {@code XMLSignatureException} with
57      * {@code null} as its detail message.
58      */
XMLSignatureException()59     public XMLSignatureException() {
60         super();
61     }
62 
63     /**
64      * Constructs a new {@code XMLSignatureException} with the specified
65      * detail message.
66      *
67      * @param message the detail message
68      */
XMLSignatureException(String message)69     public XMLSignatureException(String message) {
70         super(message);
71     }
72 
73     /**
74      * Constructs a new {@code XMLSignatureException} with the
75      * specified detail message and cause.
76      * <p>Note that the detail message associated with
77      * {@code cause} is <i>not</i> automatically incorporated in
78      * this exception's detail message.
79      *
80      * @param message the detail message
81      * @param cause the cause (A {@code null} value is permitted, and
82      *        indicates that the cause is nonexistent or unknown.)
83      */
XMLSignatureException(String message, Throwable cause)84     public XMLSignatureException(String message, Throwable cause) {
85         super(message);
86         this.cause = cause;
87     }
88 
89     /**
90      * Constructs a new {@code XMLSignatureException} with the specified
91      * cause and a detail message of
92      * {@code (cause==null ? null : cause.toString())}
93      * (which typically contains the class and detail message of
94      * {@code cause}).
95      *
96      * @param cause the cause (A {@code null} value is permitted, and
97      *        indicates that the cause is nonexistent or unknown.)
98      */
XMLSignatureException(Throwable cause)99     public XMLSignatureException(Throwable cause) {
100         super(cause==null ? null : cause.toString());
101         this.cause = cause;
102     }
103 
104     /**
105      * Returns the cause of this {@code XMLSignatureException} or
106      * {@code null} if the cause is nonexistent or unknown.  (The
107      * cause is the throwable that caused this
108      * {@code XMLSignatureException} to get thrown.)
109      *
110      * @return the cause of this {@code XMLSignatureException} or
111      *         {@code null} if the cause is nonexistent or unknown.
112      */
getCause()113     public Throwable getCause() {
114         return cause;
115     }
116 
117     /**
118      * Prints this {@code XMLSignatureException}, its backtrace and
119      * the cause's backtrace to the standard error stream.
120      */
printStackTrace()121     public void printStackTrace() {
122         super.printStackTrace();
123         if (cause != null) {
124             cause.printStackTrace();
125         }
126     }
127 
128     /**
129      * Prints this {@code XMLSignatureException}, its backtrace and
130      * the cause's backtrace to the specified print stream.
131      *
132      * @param s {@code PrintStream} to use for output
133      */
printStackTrace(PrintStream s)134     public void printStackTrace(PrintStream s) {
135         super.printStackTrace(s);
136         if (cause != null) {
137             cause.printStackTrace(s);
138         }
139     }
140 
141     /**
142      * Prints this {@code XMLSignatureException}, its backtrace and
143      * the cause's backtrace to the specified print writer.
144      *
145      * @param s {@code PrintWriter} to use for output
146      */
printStackTrace(PrintWriter s)147     public void printStackTrace(PrintWriter s) {
148         super.printStackTrace(s);
149         if (cause != null) {
150             cause.printStackTrace(s);
151         }
152     }
153 }
154