/*
 * Copyright (c) 2005, 2019, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
/*
 * $Id: MarshalException.java,v 1.5 2005/05/10 15:47:42 mullan Exp $
 */
package javax.xml.crypto;

import java.io.PrintStream;
import java.io.PrintWriter;
import javax.xml.crypto.dsig.Manifest;
import javax.xml.crypto.dsig.XMLSignature;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.keyinfo.KeyInfo;
import javax.xml.crypto.dsig.keyinfo.KeyInfoFactory;

Indicates an exceptional condition that occurred during the XML marshalling or unmarshalling process.

A MarshalException can contain a cause: another throwable that caused this MarshalException to get thrown.

Author:Sean Mullan, JSR 105 Expert Group
See Also:
  • XMLSignature.sign(XMLSignContext)
  • XMLSignatureFactory.unmarshalXMLSignature(XMLValidateContext)
Since:1.6
/** * Indicates an exceptional condition that occurred during the XML * marshalling or unmarshalling process. * * <p>A {@code MarshalException} can contain a cause: another * throwable that caused this {@code MarshalException} to get thrown. * * @author Sean Mullan * @author JSR 105 Expert Group * @since 1.6 * @see XMLSignature#sign(XMLSignContext) * @see XMLSignatureFactory#unmarshalXMLSignature(XMLValidateContext) */
public class MarshalException extends Exception { private static final long serialVersionUID = -863185580332643547L;
The throwable that caused this exception to get thrown, or null if this exception was not caused by another throwable or if the causative throwable is unknown.
@serial
/** * The throwable that caused this exception to get thrown, or null if this * exception was not caused by another throwable or if the causative * throwable is unknown. * * @serial */
private Throwable cause;
Constructs a new MarshalException with null as its detail message.
/** * Constructs a new {@code MarshalException} with * {@code null} as its detail message. */
public MarshalException() { super(); }
Constructs a new MarshalException with the specified detail message.
Params:
  • message – the detail message
/** * Constructs a new {@code MarshalException} with the specified * detail message. * * @param message the detail message */
public MarshalException(String message) { super(message); }
Constructs a new MarshalException with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.

Params:
  • message – the detail message
  • cause – the cause (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
/** * Constructs a new {@code MarshalException} with the * specified detail message and cause. * <p>Note that the detail message associated with * {@code cause} is <i>not</i> automatically incorporated in * this exception's detail message. * * @param message the detail message * @param cause the cause (A {@code null} value is permitted, and * indicates that the cause is nonexistent or unknown.) */
public MarshalException(String message, Throwable cause) { super(message); this.cause = cause; }
Constructs a new MarshalException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
Params:
  • cause – the cause (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
/** * Constructs a new {@code MarshalException} with the specified cause * and a detail message of {@code (cause==null ? null : cause.toString()) * } (which typically contains the class and detail message of * {@code cause}). * * @param cause the cause (A {@code null} value is permitted, and * indicates that the cause is nonexistent or unknown.) */
public MarshalException(Throwable cause) { super(cause==null ? null : cause.toString()); this.cause = cause; }
Returns the cause of this MarshalException or null if the cause is nonexistent or unknown. (The cause is the throwable that caused this MarshalException to get thrown.)
Returns:the cause of this MarshalException or null if the cause is nonexistent or unknown.
/** * Returns the cause of this {@code MarshalException} or * {@code null} if the cause is nonexistent or unknown. (The * cause is the throwable that caused this * {@code MarshalException} to get thrown.) * * @return the cause of this {@code MarshalException} or * {@code null} if the cause is nonexistent or unknown. */
public Throwable getCause() { return cause; }
Prints this MarshalException, its backtrace and the cause's backtrace to the standard error stream.
/** * Prints this {@code MarshalException}, its backtrace and * the cause's backtrace to the standard error stream. */
public void printStackTrace() { super.printStackTrace(); //XXX print backtrace of cause }
Prints this MarshalException, its backtrace and the cause's backtrace to the specified print stream.
Params:
  • s – PrintStream to use for output
/** * Prints this {@code MarshalException}, its backtrace and * the cause's backtrace to the specified print stream. * * @param s {@code PrintStream} to use for output */
public void printStackTrace(PrintStream s) { super.printStackTrace(s); //XXX print backtrace of cause }
Prints this MarshalException, its backtrace and the cause's backtrace to the specified print writer.
Params:
  • s – PrintWriter to use for output
/** * Prints this {@code MarshalException}, its backtrace and * the cause's backtrace to the specified print writer. * * @param s {@code PrintWriter} to use for output */
public void printStackTrace(PrintWriter s) { super.printStackTrace(s); //XXX print backtrace of cause } }