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