javax.xml.soap.SOAPException Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2004-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.soap;
/**
* An exception that signals that a SOAP exception has occurred. A
* SOAPException object may contain a String
* that gives the reason for the exception, an embedded
* Throwable object, or both. This class provides methods
* for retrieving reason messages and for retrieving the embedded
* Throwable object.
*
* Typical reasons for throwing a SOAPException
* object are problems such as difficulty setting a header, not being
* able to send a message, and not being able to get a connection with
* the provider. Reasons for embedding a Throwable
* object include problems such as input/output errors or a parsing
* problem, such as an error in parsing a header.
*/
public class SOAPException extends Exception {
private Throwable cause;
/**
* Constructs a SOAPException object with no
* reason or embedded Throwable object.
*/
public SOAPException() {
super();
this.cause = null;
}
/**
* Constructs a SOAPException object with the given
* String as the reason for the exception being thrown.
*
* @param reason a description of what caused the exception
*/
public SOAPException(String reason) {
super(reason);
this.cause = null;
}
/**
* Constructs a SOAPException object with the given
* String as the reason for the exception being thrown
* and the given Throwable object as an embedded
* exception.
*
* @param reason a description of what caused the exception
* @param cause a Throwable object that is to
* be embedded in this SOAPException object
*/
public SOAPException(String reason, Throwable cause) {
super(reason);
initCause(cause);
}
/**
* Constructs a SOAPException object initialized
* with the given Throwable object.
*/
public SOAPException(Throwable cause) {
super(cause.toString());
initCause(cause);
}
/**
* Returns the detail message for this SOAPException
* object.
*
* If there is an embedded Throwable object, and if the
* SOAPException object has no detail message of its
* own, this method will return the detail message from the embedded
* Throwable object.
*
* @return the error or warning message for this
* SOAPException or, if it has none, the
* message of the embedded Throwable object,
* if there is one
*/
public String getMessage() {
String message = super.getMessage();
if (message == null && cause != null) {
return cause.getMessage();
} else {
return message;
}
}
/**
* Returns the Throwable object embedded in this
* SOAPException if there is one. Otherwise, this method
* returns null.
*
* @return the embedded Throwable object or null
* if there is none
*/
public Throwable getCause() {
return cause;
}
/**
* Initializes the cause field of this SOAPException
* object with the given Throwable object.
*
* This method can be called at most once. It is generally called from
* within the constructor or immediately after the constructor has
* returned a new SOAPException object.
* If this SOAPException object was created with the
* constructor {@link #SOAPException(Throwable)} or
* {@link #SOAPException(String,Throwable)}, meaning that its
* cause field already has a value, this method cannot be
* called even once.
*
* @param cause the Throwable object that caused this
* SOAPException object to be thrown. The value of this
* parameter is saved for later retrieval by the
* {@link #getCause()} method. A null value is
* permitted and indicates that the cause is nonexistent or
* unknown.
* @return a reference to this SOAPException instance
* @throws IllegalArgumentException if cause is this
* Throwable object. (A Throwable object
* cannot be its own cause.)
* @throws IllegalStateException if the cause for this SOAPException object
* has already been initialized
*/
public synchronized Throwable initCause(Throwable cause) {
if (this.cause != null) {
throw new IllegalStateException("Can't override cause");
}
if (cause == this) {
throw new IllegalArgumentException("Self-causation not permitted");
}
this.cause = cause;
return this;
}
}