| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>SOAPException</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/jakarta-favicon.ico"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SOAPException"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":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><a href="../../../javax/xml/soap/SOAPEnvelope.html" title="interface in javax.xml.soap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../javax/xml/soap/SOAPFactory.html" title="class in javax.xml.soap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/xml/soap/SOAPException.html" target="_top">Frames</a></li> |
| <li><a href="SOAPException.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.soap</div> |
| <h2 title="Class SOAPException" class="title">Class SOAPException</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>javax.xml.soap.SOAPException</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">SOAPException</span> |
| extends java.lang.Exception</pre> |
| <div class="block">An exception that signals that a SOAP exception has occurred. A |
| <code>SOAPException</code> object may contain a <code>String</code> |
| that gives the reason for the exception, an embedded |
| <code>Throwable</code> object, or both. This class provides methods |
| for retrieving reason messages and for retrieving the embedded |
| <code>Throwable</code> object. |
| |
| <P> Typical reasons for throwing a <code>SOAPException</code> |
| 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 <code>Throwable</code> |
| object include problems such as input/output errors or a parsing |
| problem, such as an error in parsing a header.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../serialized-form.html#javax.xml.soap.SOAPException">Serialized Form</a></dd> |
| <dt><span class="simpleTagLabel">Examples (en):</span></dt> |
| <dd><a href="../../../../../../tomee-8.0/examples/webservice-handlerchain.html">webservice-handlerchain</a></dd> |
| <dt><span class="simpleTagLabel">Examples (pt):</span></dt> |
| <dd><a href="../../../../../../tomee-8.0/pt/examples/webservice-handlerchain.html">webservice-handlerchain</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/soap/SOAPException.html#SOAPException--">SOAPException</a></span>()</code> |
| <div class="block">Constructs a <code>SOAPException</code> object with no |
| reason or embedded <code>Throwable</code> object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPException.html#SOAPException-java.lang.String-">SOAPException</a></span>(java.lang.String reason)</code> |
| <div class="block">Constructs a <code>SOAPException</code> object with the given |
| <code>String</code> as the reason for the exception being thrown.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPException.html#SOAPException-java.lang.String-java.lang.Throwable-">SOAPException</a></span>(java.lang.String reason, |
| java.lang.Throwable cause)</code> |
| <div class="block">Constructs a <code>SOAPException</code> object with the given |
| <code>String</code> as the reason for the exception being thrown |
| and the given <code>Throwable</code> object as an embedded |
| exception.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPException.html#SOAPException-java.lang.Throwable-">SOAPException</a></span>(java.lang.Throwable cause)</code> |
| <div class="block">Constructs a <code>SOAPException</code> object initialized |
| with the given <code>Throwable</code> object.</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>java.lang.Throwable</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPException.html#getCause--">getCause</a></span>()</code> |
| <div class="block">Returns the <code>Throwable</code> object embedded in this |
| <code>SOAPException</code> if there is one.</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/soap/SOAPException.html#getMessage--">getMessage</a></span>()</code> |
| <div class="block">Returns the detail message for this <code>SOAPException</code> |
| object.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.Throwable</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/SOAPException.html#initCause-java.lang.Throwable-">initCause</a></span>(java.lang.Throwable cause)</code> |
| <div class="block">Initializes the <code>cause</code> field of this <code>SOAPException</code> |
| object with the given <code>Throwable</code> object.</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, getLocalizedMessage, getStackTrace, getSuppressed, 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="SOAPException--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SOAPException</h4> |
| <pre>public SOAPException()</pre> |
| <div class="block">Constructs a <code>SOAPException</code> object with no |
| reason or embedded <code>Throwable</code> object.</div> |
| </li> |
| </ul> |
| <a name="SOAPException-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SOAPException</h4> |
| <pre>public SOAPException(java.lang.String reason)</pre> |
| <div class="block">Constructs a <code>SOAPException</code> object with the given |
| <code>String</code> as the reason for the exception being thrown.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reason</code> - a description of what caused the exception</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SOAPException-java.lang.String-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SOAPException</h4> |
| <pre>public SOAPException(java.lang.String reason, |
| java.lang.Throwable cause)</pre> |
| <div class="block">Constructs a <code>SOAPException</code> object with the given |
| <code>String</code> as the reason for the exception being thrown |
| and the given <code>Throwable</code> object as an embedded |
| exception.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reason</code> - a description of what caused the exception</dd> |
| <dd><code>cause</code> - a <code>Throwable</code> object that is to |
| be embedded in this <code>SOAPException</code> object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SOAPException-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SOAPException</h4> |
| <pre>public SOAPException(java.lang.Throwable cause)</pre> |
| <div class="block">Constructs a <code>SOAPException</code> object initialized |
| with the given <code>Throwable</code> object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cause</code> - a <code>Throwable</code> object that is to |
| be embedded in this <code>SOAPException</code> object</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="getMessage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessage</h4> |
| <pre>public java.lang.String getMessage()</pre> |
| <div class="block">Returns the detail message for this <code>SOAPException</code> |
| object. |
| <P> |
| If there is an embedded <code>Throwable</code> object, and if the |
| <code>SOAPException</code> object has no detail message of its |
| own, this method will return the detail message from the embedded |
| <code>Throwable</code> object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>getMessage</code> in class <code>java.lang.Throwable</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the error or warning message for this |
| <code>SOAPException</code> or, if it has none, the |
| message of the embedded <code>Throwable</code> object, |
| if there is one</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCause--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCause</h4> |
| <pre>public java.lang.Throwable getCause()</pre> |
| <div class="block">Returns the <code>Throwable</code> object embedded in this |
| <code>SOAPException</code> if there is one. Otherwise, this method |
| returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>getCause</code> in class <code>java.lang.Throwable</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the embedded <code>Throwable</code> object or <code>null</code> |
| if there is none</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initCause-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>initCause</h4> |
| <pre>public java.lang.Throwable initCause(java.lang.Throwable cause)</pre> |
| <div class="block">Initializes the <code>cause</code> field of this <code>SOAPException</code> |
| object with the given <code>Throwable</code> object. |
| <P> |
| 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 <code>SOAPException</code> object. |
| If this <code>SOAPException</code> object was created with the |
| constructor <a href="../../../javax/xml/soap/SOAPException.html#SOAPException-java.lang.Throwable-"><code>SOAPException(Throwable)</code></a> or |
| <a href="../../../javax/xml/soap/SOAPException.html#SOAPException-java.lang.String-java.lang.Throwable-"><code>SOAPException(String,Throwable)</code></a>, meaning that its |
| <code>cause</code> field already has a value, this method cannot be |
| called even once.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>initCause</code> in class <code>java.lang.Throwable</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cause</code> - the <code>Throwable</code> object that caused this |
| <code>SOAPException</code> object to be thrown. The value of this |
| parameter is saved for later retrieval by the |
| <a href="../../../javax/xml/soap/SOAPException.html#getCause--"><code>getCause()</code></a> method. A <code>null</code> value is |
| permitted and indicates that the cause is nonexistent or |
| unknown.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this <code>SOAPException</code> instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if <code>cause</code> is this |
| <code>Throwable</code> object. (A <code>Throwable</code> object |
| cannot be its own cause.)</dd> |
| <dd><code>java.lang.IllegalStateException</code> - if the cause for this <code>SOAPException</code> object |
| has already been initialized</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><a href="../../../javax/xml/soap/SOAPEnvelope.html" title="interface in javax.xml.soap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../javax/xml/soap/SOAPFactory.html" title="class in javax.xml.soap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/xml/soap/SOAPException.html" target="_top">Frames</a></li> |
| <li><a href="SOAPException.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> |