| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>SOAPFaultException</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SOAPFaultException"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/xml/rpc/soap/SOAPFaultException.html" target="_top">Frames</a></li> |
| <li><a href="SOAPFaultException.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">javax.xml.rpc.soap</div> |
| <h2 title="Class SOAPFaultException" class="title">Class SOAPFaultException</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.lang.Throwable</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.lang.Exception</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.lang.RuntimeException</li> |
| <li> |
| <ul class="inheritance"> |
| <li>javax.xml.rpc.soap.SOAPFaultException</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SOAPFaultException</span> |
| extends java.lang.RuntimeException</pre> |
| <div class="block">The <code>SOAPFaultException</code> exception represents a |
| SOAP fault. |
| |
| <p>The message part in the SOAP fault maps to the contents of |
| <code>faultdetail</code> element accessible through the |
| <code>getDetail</code> method on the <code>SOAPFaultException</code>. |
| The method <code>createDetail</code> on the |
| <code>javax.xml.soap.SOAPFactory</code> creates an instance |
| of the <code>javax.xml.soap.Detail</code>. |
| |
| <p>The <code>faultstring</code> provides a human-readable |
| description of the SOAP fault. The <code>faultcode</code> |
| element provides an algorithmic mapping of the SOAP fault. |
| |
| <p>Refer to SOAP 1.1 and WSDL 1.1 specifications for more |
| details of the SOAP faults.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../javax/xml/soap/Detail.html" title="interface in javax.xml.soap"><code>Detail</code></a>, |
| <a href="../../../../javax/xml/soap/SOAPFactory.html#createDetail--"><code>SOAPFactory.createDetail()</code></a>, |
| <a href="../../../../serialized-form.html#javax.xml.rpc.soap.SOAPFaultException">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/soap/SOAPFaultException.html#SOAPFaultException-javax.xml.namespace.QName-java.lang.String-java.lang.String-javax.xml.soap.Detail-">SOAPFaultException</a></span>(javax.xml.namespace.QName faultcode, |
| java.lang.String faultstring, |
| java.lang.String faultactor, |
| <a href="../../../../javax/xml/soap/Detail.html" title="interface in javax.xml.soap">Detail</a> faultdetail)</code> |
| <div class="block">Constructor for the SOAPFaultException</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/soap/Detail.html" title="interface in javax.xml.soap">Detail</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/soap/SOAPFaultException.html#getDetail--">getDetail</a></span>()</code> |
| <div class="block">Gets the detail element.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/soap/SOAPFaultException.html#getFaultActor--">getFaultActor</a></span>()</code> |
| <div class="block">Gets the <code>faultactor</code> element.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>javax.xml.namespace.QName</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/soap/SOAPFaultException.html#getFaultCode--">getFaultCode</a></span>()</code> |
| <div class="block">Gets the <code>faultcode</code> element.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/rpc/soap/SOAPFaultException.html#getFaultString--">getFaultString</a></span>()</code> |
| <div class="block">Gets the <code>faultstring</code> element.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Throwable</h3> |
| <code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SOAPFaultException-javax.xml.namespace.QName-java.lang.String-java.lang.String-javax.xml.soap.Detail-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SOAPFaultException</h4> |
| <pre>public SOAPFaultException(javax.xml.namespace.QName faultcode, |
| java.lang.String faultstring, |
| java.lang.String faultactor, |
| <a href="../../../../javax/xml/soap/Detail.html" title="interface in javax.xml.soap">Detail</a> faultdetail)</pre> |
| <div class="block">Constructor for the SOAPFaultException</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>faultcode</code> - <code>QName</code> for the SOAP faultcode</dd> |
| <dd><code>faultstring</code> - <code>faultstring</code> element of SOAP fault</dd> |
| <dd><code>faultactor</code> - <code>faultactor</code> element of SOAP fault</dd> |
| <dd><code>faultdetail</code> - <code>faultdetail</code> element of SOAP fault</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../javax/xml/soap/SOAPFactory.html#createDetail--"><code>SOAPFactory.createDetail()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getFaultCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFaultCode</h4> |
| <pre>public javax.xml.namespace.QName getFaultCode()</pre> |
| <div class="block">Gets the <code>faultcode</code> element. The <code>faultcode</code> |
| element provides an algorithmic mechanism for identifying the |
| fault. SOAP defines a small set of SOAP fault codes covering |
| basic SOAP faults.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>QName of the faultcode element</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFaultString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFaultString</h4> |
| <pre>public java.lang.String getFaultString()</pre> |
| <div class="block">Gets the <code>faultstring</code> element. The <code>faultstring</code> |
| provides a human-readable description of the SOAP fault and |
| is not intended for algorithmic processing.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>faultstring element of the SOAP fault</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFaultActor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFaultActor</h4> |
| <pre>public java.lang.String getFaultActor()</pre> |
| <div class="block">Gets the <code>faultactor</code> element. The <code>faultactor</code> |
| element provides information about which SOAP node on the |
| SOAP message path caused the fault to happen. It indicates |
| the source of the fault.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>faultactor</code> element of the SOAP fault</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDetail--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getDetail</h4> |
| <pre>public <a href="../../../../javax/xml/soap/Detail.html" title="interface in javax.xml.soap">Detail</a> getDetail()</pre> |
| <div class="block">Gets the detail element. The detail element is intended for |
| carrying application specific error information related to |
| the SOAP Body.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>detail</code> element of the SOAP fault</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../javax/xml/soap/Detail.html" title="interface in javax.xml.soap"><code>Detail</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/xml/rpc/soap/SOAPFaultException.html" target="_top">Frames</a></li> |
| <li><a href="SOAPFaultException.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
