| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Action</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="Action"; |
| } |
| } |
| 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>Prev Class</li> |
| <li><a href="../../../javax/xml/ws/AsyncHandler.html" title="interface in javax.xml.ws"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/xml/ws/Action.html" target="_top">Frames</a></li> |
| <li><a href="Action.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>Required | </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">javax.xml.ws</div> |
| <h2 title="Annotation Type Action" class="title">Annotation Type Action</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">Action</span></pre> |
| <div class="block">The <code>Action</code> annotation allows explicit association of a |
| WS-Addressing <code>Action</code> message addressing property with |
| <code>input</code>, <code>output</code>, and |
| <code>fault</code> messages of the mapped WSDL operation. |
| <p> |
| This annotation can be specified on each method of a service endpoint interface. |
| For such a method, the mapped operation in the generated WSDL's |
| <code>wsam:Action</code> attribute on the WSDL <code>input</code>, |
| <code>output</code> and <code>fault</code> messages of the WSDL <code>operation</code> |
| is based upon which attributes of the <code>Action</code> annotation have been specified. |
| For the exact computation of <code>wsam:Action</code> values for the 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 <code>input</code> and <code>output</code> messages. |
| |
| <pre> |
| @WebService(targetNamespace="http://example.com/numbers") |
| public class AddNumbersImpl { |
| <b> @Action( |
| input="http://example.com/inputAction", |
| output="http://example.com/outputAction")</b> |
| public int addNumbers(int number1, int number2) { |
| return number1 + number2; |
| } |
| } |
| </pre> |
| |
| The generated WSDL looks like: |
| <pre> <code> |
| <definitions targetNamespace="http://example.com/numbers" ...> |
| ... |
| <portType name="AddNumbersPortType"> |
| <operation name="AddNumbers"> |
| <input message="tns:AddNumbersInput" name="foo" |
| <b>wsam:Action="http://example.com/inputAction"</b>/> |
| <output message="tns:AddNumbersOutput" name="bar" |
| <b>wsam:Action="http://example.com/outputAction"</b>/> |
| </operation> |
| </portType> |
| ... |
| </definitions> |
| </code> |
| </pre> |
| |
| <p> |
| <b>Example 2</b>: Specify explicit value for <code>Action</code> message addressing property |
| for only the <code>input</code> message. The <code>wsam:Action</code> values for the |
| WSDL <code>output</code> message are computed using the algorithm in the JAX-WS specification. |
| |
| <pre> |
| @WebService(targetNamespace="http://example.com/numbers") |
| public class AddNumbersImpl { |
| <b> @Action(input="http://example.com/inputAction")</b> |
| public int addNumbers(int number1, int number2) { |
| return number1 + number2; |
| } |
| } |
| </pre> |
| |
| The generated WSDL looks like: |
| <pre> <code> |
| <definitions targetNamespace="http://example.com/numbers" ...> |
| ... |
| <portType name="AddNumbersPortType"> |
| <operation name="AddNumbers"> |
| <input message="tns:AddNumbersInput" name="foo" |
| <b>wsam:Action="http://example.com/inputAction"</b>/> |
| <output message="tns:AddNumbersOutput" name="bar" |
| <b>wsam:Action="http://example.com/numbers/AddNumbersPortType/AddNumbersResponse"</b>/> |
| </operation> |
| </portType> |
| ... |
| </definitions> |
| </code></pre> |
| |
| It is legitimate to specify an explicit value for <code>Action</code> message addressing property for |
| <code>output</code> message only. In this case, <code>wsam:Action</code> value for the |
| WSDL <code>input</code> message is computed using the algorithm in the JAX-WS specification. |
| |
| <p> |
| <b>Example 3</b>: See <a href="../../../javax/xml/ws/FaultAction.html" title="annotation in javax.xml.ws"><code>FaultAction</code></a> annotation for an example of |
| how to specify an explicit value for <code>Action</code> message addressing property for the |
| <code>fault</code> message.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, JAX-WS 2.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../javax/xml/ws/FaultAction.html" title="annotation in javax.xml.ws"><code>FaultAction</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== 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><a href="../../../javax/xml/ws/FaultAction.html" title="annotation in javax.xml.ws">FaultAction</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/Action.html#fault--">fault</a></span></code> |
| <div class="block">Explicit value of the WS-Addressing <code>Action</code> message addressing property for the <code>fault</code> |
| message(s) of the operation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/Action.html#input--">input</a></span></code> |
| <div class="block">Explicit value of the WS-Addressing <code>Action</code> message addressing property for the <code>input</code> |
| message of the operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/Action.html#output--">output</a></span></code> |
| <div class="block">Explicit value of the WS-Addressing <code>Action</code> message addressing property for the <code>output</code> |
| message of the operation.</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="input--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>input</h4> |
| <pre>public abstract java.lang.String input</pre> |
| <div class="block">Explicit value of the WS-Addressing <code>Action</code> message addressing property for the <code>input</code> |
| message of the operation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>Action</code> message addressing property for the <code>input</code> message</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="output--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>output</h4> |
| <pre>public abstract java.lang.String output</pre> |
| <div class="block">Explicit value of the WS-Addressing <code>Action</code> message addressing property for the <code>output</code> |
| message of the operation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>Action</code> message addressing property for the <code>output</code> message</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fault--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>fault</h4> |
| <pre>public abstract <a href="../../../javax/xml/ws/FaultAction.html" title="annotation in javax.xml.ws">FaultAction</a>[] fault</pre> |
| <div class="block">Explicit value of the WS-Addressing <code>Action</code> message addressing property for the <code>fault</code> |
| message(s) of the operation. Each exception that is mapped to a fault and requires an explicit WS-Addressing |
| <code>Action</code> message addressing property, needs to be specified as a value in this property |
| using <a href="../../../javax/xml/ws/FaultAction.html" title="annotation in javax.xml.ws"><code>FaultAction</code></a> annotation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>Action</code> message addressing property for the <code>fault</code> message(s)</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>Prev Class</li> |
| <li><a href="../../../javax/xml/ws/AsyncHandler.html" title="interface in javax.xml.ws"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/xml/ws/Action.html" target="_top">Frames</a></li> |
| <li><a href="Action.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>Required | </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> |