| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>FaultAction</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="FaultAction"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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="../../../jakarta/xml/ws/EndpointReference.html" title="class in jakarta.xml.ws"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/xml/ws/Holder.html" title="class in jakarta.xml.ws"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/xml/ws/FaultAction.html" target="_top">Frames</a></li> |
| <li><a href="FaultAction.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>Field | </li> |
| <li><a href="#annotation.type.required.element.summary">Required</a> | </li> |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</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">jakarta.xml.ws</div> |
| <h2 title="Annotation Type FaultAction" class="title">Annotation Type FaultAction</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@Documented |
| @Retention(value=RUNTIME) |
| @Target(value=METHOD) |
| public @interface <span class="memberNameLabel">FaultAction</span></pre> |
| <div class="block">The <code>FaultAction</code> annotation is used inside an <a href="../../../jakarta/xml/ws/Action.html" title="annotation in jakarta.xml.ws"><code>Action</code></a> |
| annotation to allow an explicit association of a WS-Addressing |
| <code>Action</code> message addressing property with the <code>fault</code> |
| messages of the WSDL operation mapped from the exception class. |
| <p> |
| The <code>wsam:Action</code> attribute value in the <code>fault</code> |
| message in the generated WSDL operation mapped for <code>className</code> |
| class is equal to the corresponding value in the <code>FaultAction</code>. |
| For the exact computation of <code>wsam:Action</code> values for the |
| fault messages, refer to the algorithm in the JAX-WS specification. |
| |
| <p> |
| <b>Example 1</b>: Specify explicit values for <code>Action</code> message addressing |
| property for the <code>input</code>, <code>output</code> and <code>fault</code> message |
| if the Java method throws only one service specific exception. |
| |
| <pre> |
| @WebService(targetNamespace="http://example.com/numbers") |
| public class AddNumbersImpl { |
| @Action( |
| fault = { |
| <b> @FaultAction(className=AddNumbersException.class, value="http://example.com/faultAction")</b> |
| }) |
| public int addNumbers(int number1, int number2) |
| throws AddNumbersException { |
| return number1 + number2; |
| } |
| } |
| </pre> |
| |
| The generated WSDL looks like: |
| |
| <pre> <code> |
| <definitions targetNamespace="http://example.com/numbers" ...> |
| ... |
| <portType name="AddNumbersPortType"> |
| <operation name="AddNumbers"> |
| ... |
| <fault message="tns:AddNumbersException" name="AddNumbersException"</code> |
| <b>wsam:Action="http://example.com/faultAction"</b><code> /> |
| </operation> |
| </portType> |
| ... |
| </definitions> </code> |
| </pre> |
| |
| <p> |
| Example 2: Here is an example that shows if the explicit value for <code>Action</code> |
| message addressing property for the service specific exception is not present. |
| |
| <pre> |
| @WebService(targetNamespace="http://example.com/numbers") |
| public class AddNumbersImpl { |
| public int addNumbers(int number1, int number2) |
| throws AddNumbersException { |
| return number1 + number2; |
| } |
| } |
| </pre> |
| |
| The generated WSDL looks like: |
| |
| <pre><code> |
| <definitions targetNamespace="http://example.com/numbers" ...> |
| ... |
| <portType name="AddNumbersPortType"> |
| <operation name="AddNumbers"> |
| ... |
| <fault message="tns:addNumbersFault" name="InvalidNumbers"</code> |
| <b>wsam:Action="http://example.com/numbers/AddNumbersPortType/AddNumbers/Fault/AddNumbersException"</b><code> /> |
| </operation> |
| </portType> |
| ... |
| </definitions> |
| </code></pre> |
| |
| <p> |
| Example 3: Here is an example that shows how to specify explicit values for <code>Action</code> |
| message addressing property if the Java method throws more than one service specific exception. |
| |
| <pre> |
| @WebService(targetNamespace="http://example.com/numbers") |
| public class AddNumbersImpl { |
| @Action( |
| fault = { |
| <b> @FaultAction(className=AddNumbersException.class, value="http://example.com/addFaultAction"), |
| @FaultAction(className=TooBigNumbersException.class, value="http://example.com/toobigFaultAction")</b> |
| }) |
| public int addNumbers(int number1, int number2) |
| throws AddNumbersException, TooBigNumbersException { |
| return number1 + number2; |
| } |
| } |
| </pre> |
| |
| The generated WSDL looks like: |
| |
| <pre> <code> |
| <definitions targetNamespace="http://example.com/numbers" ...> |
| ... |
| <portType name="AddNumbersPortType"> |
| <operation name="AddNumbers"> |
| ... |
| <fault message="tns:addNumbersFault" name="AddNumbersException"</code> |
| <b>wsam:Action="http://example.com/addFaultAction"</b><code> /> |
| <fault message="tns:tooBigNumbersFault" name="TooBigNumbersException"</code> |
| <b>wsam:Action="http://example.com/toobigFaultAction"</b><code> /> |
| </operation> |
| </portType> |
| ... |
| </definitions> |
| </code></pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, JAX-WS 2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.required.element.summary"> |
| <!-- --> |
| </a> |
| <h3>Required Element Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> |
| <caption><span>Required Elements</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Required Element and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.Class<? extends java.lang.Exception></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/ws/FaultAction.html#className--">className</a></span></code> |
| <div class="block">Name of the exception class.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.optional.element.summary"> |
| <!-- --> |
| </a> |
| <h3>Optional Element Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> |
| <caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Optional Element and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/ws/FaultAction.html#value--">value</a></span></code> |
| <div class="block">Value of WS-Addressing <code>Action</code> message addressing property for the exception.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.element.detail"> |
| <!-- --> |
| </a> |
| <h3>Element Detail</h3> |
| <a name="className--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>className</h4> |
| <pre>public abstract java.lang.Class<? extends java.lang.Exception> className</pre> |
| <div class="block">Name of the exception class.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the exception class</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="value--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>value</h4> |
| <pre>public abstract java.lang.String value</pre> |
| <div class="block">Value of WS-Addressing <code>Action</code> message addressing property for the exception.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>WS-Addressing <code>Action</code> message addressing property for the exception</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</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="../../../jakarta/xml/ws/EndpointReference.html" title="class in jakarta.xml.ws"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/xml/ws/Holder.html" title="class in jakarta.xml.ws"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/xml/ws/FaultAction.html" target="_top">Frames</a></li> |
| <li><a href="FaultAction.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>Field | </li> |
| <li><a href="#annotation.type.required.element.summary">Required</a> | </li> |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |