jakarta.xml.ws.soap.SOAPFaultException Maven / Gradle / Ivy
/*
* Copyright (c) 2005, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package jakarta.xml.ws.soap;
import jakarta.xml.soap.SOAPFault;
/** The {@code SOAPFaultException} exception represents a
* SOAP 1.1 or 1.2 fault.
*
* A {@code SOAPFaultException} wraps a Jakarta SOAP with Attachments' {@code SOAPFault}
* that manages the SOAP-specific representation of faults.
* The {@code createFault} method of
* {@code jakarta.xml.soap.SOAPFactory} may be used to create an instance
* of {@code jakarta.xml.soap.SOAPFault} for use with the
* constructor. {@code SOAPBinding} contains an accessor for the
* {@code SOAPFactory} used by the binding instance.
*
*
Note that the value of {@code 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 jakarta.xml.soap.SOAPFault
* @see jakarta.xml.ws.soap.SOAPBinding#getSOAPFactory
* @see jakarta.xml.ws.ProtocolException
*
* @since 1.6, JAX-WS 2.0
**/
public class SOAPFaultException extends jakarta.xml.ws.ProtocolException {
private static final long serialVersionUID = -5717334416389757052L;
private SOAPFault fault;
/** Constructor for SOAPFaultException
* @param fault {@code SOAPFault} representing the fault
*
* @see jakarta.xml.soap.SOAPFactory#createFault
**/
public SOAPFaultException(SOAPFault fault) {
super(fault.getFaultString());
this.fault = fault;
}
/** Gets the embedded {@code SOAPFault} instance.
*
* @return {@code jakarta.xml.soap.SOAPFault} SOAP
* fault element
**/
public jakarta.xml.soap.SOAPFault getFault() {
return this.fault;
}
}