javax.xml.ws.soap.SOAPFaultException Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2005-2010 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.ws.soap;
import javax.xml.soap.SOAPFault;
/** The SOAPFaultException exception represents a
* SOAP 1.1 or 1.2 fault.
*
* A SOAPFaultException wraps a SAAJ SOAPFault
* that manages the SOAP-specific representation of faults.
* The createFault method of
* javax.xml.soap.SOAPFactory may be used to create an instance
* of javax.xml.soap.SOAPFault for use with the
* constructor. SOAPBinding contains an accessor for the
* SOAPFactory used by the binding instance.
*
*
Note that the value of getFault is the only part of the
* exception used when searializing a SOAP fault.
*
*
Refer to the SOAP specification for a complete
* description of SOAP faults.
*
* @see javax.xml.soap.SOAPFault
* @see javax.xml.ws.soap.SOAPBinding#getSOAPFactory
* @see javax.xml.ws.ProtocolException
*
* @since JAX-WS 2.0
**/
public class SOAPFaultException extends javax.xml.ws.ProtocolException {
private SOAPFault fault;
/** Constructor for SOAPFaultException
* @param fault SOAPFault representing the fault
*
* @see javax.xml.soap.SOAPFactory#createFault
**/
public SOAPFaultException(SOAPFault fault) {
super(fault.getFaultString());
this.fault = fault;
}
/** Gets the embedded SOAPFault instance.
*
* @return javax.xml.soap.SOAPFault SOAP
* fault element
**/
public javax.xml.soap.SOAPFault getFault() {
return this.fault;
}
}