View Javadoc
1   /*
2    * Copyright (c) 2005, 2010, 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  package javax.xml.ws.soap;
27  
28  import javax.xml.soap.SOAPFault;
29  
30  /** The <code>SOAPFaultException</code> exception represents a
31   *  SOAP 1.1 or 1.2 fault.
32   *
33   *  <p>A <code>SOAPFaultException</code> wraps a SAAJ <code>SOAPFault</code>
34   *  that manages the SOAP-specific representation of faults.
35   *  The <code>createFault</code> method of
36   *  <code>javax.xml.soap.SOAPFactory</code> may be used to create an instance
37   *  of <code>javax.xml.soap.SOAPFault</code> for use with the
38   *  constructor. <code>SOAPBinding</code> contains an accessor for the
39   *  <code>SOAPFactory</code> used by the binding instance.
40   *
41   *  <p>Note that the value of <code>getFault</code> is the only part of the
42   *  exception used when searializing a SOAP fault.
43   *
44   *  <p>Refer to the SOAP specification for a complete
45   *  description of SOAP faults.
46   *
47   *  @see javax.xml.soap.SOAPFault
48   *  @see javax.xml.ws.soap.SOAPBinding#getSOAPFactory
49   *  @see javax.xml.ws.ProtocolException
50   *
51   *  @since JAX-WS 2.0
52   **/
53  public class SOAPFaultException extends javax.xml.ws.ProtocolException  {
54  
55      private SOAPFault fault;
56  
57      /** Constructor for SOAPFaultException
58       *  @param fault   <code>SOAPFault</code> representing the fault
59       *
60       *  @see javax.xml.soap.SOAPFactory#createFault
61       **/
62      public SOAPFaultException(SOAPFault fault) {
63          super(fault.getFaultString());
64          this.fault = fault;
65      }
66  
67      /** Gets the embedded <code>SOAPFault</code> instance.
68       *
69       *  @return <code>javax.xml.soap.SOAPFault</code> SOAP
70       *          fault element
71       **/
72      public javax.xml.soap.SOAPFault getFault() {
73          return this.fault;
74      }
75  }