| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Dispatch</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="Dispatch"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ws/BindingType.html" title="annotation in javax.xml.ws"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../javax/xml/ws/Endpoint.html" title="class in javax.xml.ws"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/xml/ws/Dispatch.html" target="_top">Frames</a></li> |
| <li><a href="Dispatch.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.ws</div> |
| <h2 title="Interface Dispatch" class="title">Interface Dispatch<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The type of the message or payload</dd> |
| </dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../javax/xml/ws/BindingProvider.html" title="interface in javax.xml.ws">BindingProvider</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Dispatch<T></span> |
| extends <a href="../../../javax/xml/ws/BindingProvider.html" title="interface in javax.xml.ws">BindingProvider</a></pre> |
| <div class="block">The <code>Dispatch</code> interface provides support |
| for the dynamic invocation of a service endpoint operations. The |
| <code>javax.xml.ws.Service</code> |
| class acts as a factory for the creation of <code>Dispatch</code> |
| instances.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, JAX-WS 2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.javax.xml.ws.BindingProvider"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface javax.xml.ws.<a href="../../../javax/xml/ws/BindingProvider.html" title="interface in javax.xml.ws">BindingProvider</a></h3> |
| <code><a href="../../../javax/xml/ws/BindingProvider.html#ENDPOINT_ADDRESS_PROPERTY">ENDPOINT_ADDRESS_PROPERTY</a>, <a href="../../../javax/xml/ws/BindingProvider.html#PASSWORD_PROPERTY">PASSWORD_PROPERTY</a>, <a href="../../../javax/xml/ws/BindingProvider.html#SESSION_MAINTAIN_PROPERTY">SESSION_MAINTAIN_PROPERTY</a>, <a href="../../../javax/xml/ws/BindingProvider.html#SOAPACTION_URI_PROPERTY">SOAPACTION_URI_PROPERTY</a>, <a href="../../../javax/xml/ws/BindingProvider.html#SOAPACTION_USE_PROPERTY">SOAPACTION_USE_PROPERTY</a>, <a href="../../../javax/xml/ws/BindingProvider.html#USERNAME_PROPERTY">USERNAME_PROPERTY</a></code></li> |
| </ul> |
| </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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/ws/Dispatch.html" title="type parameter in Dispatch">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/Dispatch.html#invoke-T-">invoke</a></span>(<a href="../../../javax/xml/ws/Dispatch.html" title="type parameter in Dispatch">T</a> msg)</code> |
| <div class="block">Invoke a service operation synchronously.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../javax/xml/ws/Response.html" title="interface in javax.xml.ws">Response</a><<a href="../../../javax/xml/ws/Dispatch.html" title="type parameter in Dispatch">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/Dispatch.html#invokeAsync-T-">invokeAsync</a></span>(<a href="../../../javax/xml/ws/Dispatch.html" title="type parameter in Dispatch">T</a> msg)</code> |
| <div class="block">Invoke a service operation asynchronously.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.concurrent.Future<?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/Dispatch.html#invokeAsync-T-javax.xml.ws.AsyncHandler-">invokeAsync</a></span>(<a href="../../../javax/xml/ws/Dispatch.html" title="type parameter in Dispatch">T</a> msg, |
| <a href="../../../javax/xml/ws/AsyncHandler.html" title="interface in javax.xml.ws">AsyncHandler</a><<a href="../../../javax/xml/ws/Dispatch.html" title="type parameter in Dispatch">T</a>> handler)</code> |
| <div class="block">Invoke a service operation asynchronously.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/ws/Dispatch.html#invokeOneWay-T-">invokeOneWay</a></span>(<a href="../../../javax/xml/ws/Dispatch.html" title="type parameter in Dispatch">T</a> msg)</code> |
| <div class="block">Invokes a service operation using the one-way |
| interaction mode.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.javax.xml.ws.BindingProvider"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface javax.xml.ws.<a href="../../../javax/xml/ws/BindingProvider.html" title="interface in javax.xml.ws">BindingProvider</a></h3> |
| <code><a href="../../../javax/xml/ws/BindingProvider.html#getBinding--">getBinding</a>, <a href="../../../javax/xml/ws/BindingProvider.html#getEndpointReference--">getEndpointReference</a>, <a href="../../../javax/xml/ws/BindingProvider.html#getEndpointReference-java.lang.Class-">getEndpointReference</a>, <a href="../../../javax/xml/ws/BindingProvider.html#getRequestContext--">getRequestContext</a>, <a href="../../../javax/xml/ws/BindingProvider.html#getResponseContext--">getResponseContext</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="invoke-java.lang.Object-"> |
| <!-- --> |
| </a><a name="invoke-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invoke</h4> |
| <pre><a href="../../../javax/xml/ws/Dispatch.html" title="type parameter in Dispatch">T</a> invoke(<a href="../../../javax/xml/ws/Dispatch.html" title="type parameter in Dispatch">T</a> msg)</pre> |
| <div class="block">Invoke a service operation synchronously. |
| |
| The client is responsible for ensuring that the <code>msg</code> object |
| when marshalled is formed according to the requirements of the protocol |
| binding in use.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>msg</code> - An object that will form the message or payload of |
| the message used to invoke the operation.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The response message or message payload to the |
| operation invocation.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/ws/WebServiceException.html" title="class in javax.xml.ws">WebServiceException</a></code> - If a fault occurs during communication with |
| the service</dd> |
| <dd><code><a href="../../../javax/xml/ws/WebServiceException.html" title="class in javax.xml.ws">WebServiceException</a></code> - If there is any error in the configuration of |
| the <code>Dispatch</code> instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="invokeAsync-java.lang.Object-"> |
| <!-- --> |
| </a><a name="invokeAsync-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invokeAsync</h4> |
| <pre><a href="../../../javax/xml/ws/Response.html" title="interface in javax.xml.ws">Response</a><<a href="../../../javax/xml/ws/Dispatch.html" title="type parameter in Dispatch">T</a>> invokeAsync(<a href="../../../javax/xml/ws/Dispatch.html" title="type parameter in Dispatch">T</a> msg)</pre> |
| <div class="block">Invoke a service operation asynchronously. The |
| method returns without waiting for the response to the operation |
| invocation, the results of the operation are obtained by polling the |
| returned <code>Response</code>. |
| <p> |
| The client is responsible for ensuring that the <code>msg</code> object |
| when marshalled is formed according to the requirements of the protocol |
| binding in use.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>msg</code> - An object that will form the message or payload of |
| the message used to invoke the operation.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The response message or message payload to the |
| operation invocation.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/ws/WebServiceException.html" title="class in javax.xml.ws">WebServiceException</a></code> - If there is any error in the configuration of |
| the <code>Dispatch</code> instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="invokeAsync-java.lang.Object-javax.xml.ws.AsyncHandler-"> |
| <!-- --> |
| </a><a name="invokeAsync-T-javax.xml.ws.AsyncHandler-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invokeAsync</h4> |
| <pre>java.util.concurrent.Future<?> invokeAsync(<a href="../../../javax/xml/ws/Dispatch.html" title="type parameter in Dispatch">T</a> msg, |
| <a href="../../../javax/xml/ws/AsyncHandler.html" title="interface in javax.xml.ws">AsyncHandler</a><<a href="../../../javax/xml/ws/Dispatch.html" title="type parameter in Dispatch">T</a>> handler)</pre> |
| <div class="block">Invoke a service operation asynchronously. The |
| method returns without waiting for the response to the operation |
| invocation, the results of the operation are communicated to the client |
| via the passed in <code>handler</code>. |
| <p> |
| The client is responsible for ensuring that the <code>msg</code> object |
| when marshalled is formed according to the requirements of the protocol |
| binding in use.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>msg</code> - An object that will form the message or payload of |
| the message used to invoke the operation.</dd> |
| <dd><code>handler</code> - The handler object that will receive the |
| response to the operation invocation.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>Future</code> object that may be used to check the status |
| of the operation invocation. This object MUST NOT be used to try to |
| obtain the results of the operation - the object returned from |
| <code>Future<?>.get()</code> is implementation dependent |
| and any use of it will result in non-portable behaviour.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/ws/WebServiceException.html" title="class in javax.xml.ws">WebServiceException</a></code> - If there is any error in the configuration of |
| the <code>Dispatch</code> instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="invokeOneWay-java.lang.Object-"> |
| <!-- --> |
| </a><a name="invokeOneWay-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>invokeOneWay</h4> |
| <pre>void invokeOneWay(<a href="../../../javax/xml/ws/Dispatch.html" title="type parameter in Dispatch">T</a> msg)</pre> |
| <div class="block">Invokes a service operation using the one-way |
| interaction mode. The operation invocation is logically non-blocking, |
| subject to the capabilities of the underlying protocol, no results |
| are returned. When |
| the protocol in use is SOAP/HTTP, this method MUST block until |
| an HTTP response code has been received or an error occurs. |
| <p> |
| The client is responsible for ensuring that the <code>msg</code> object |
| when marshalled is formed according to the requirements of the protocol |
| binding in use.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>msg</code> - An object that will form the message or payload of |
| the message used to invoke the operation.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/ws/WebServiceException.html" title="class in javax.xml.ws">WebServiceException</a></code> - If there is any error in the configuration of |
| the <code>Dispatch</code> instance or if an error occurs during the |
| invocation.</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/ws/BindingType.html" title="annotation in javax.xml.ws"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../javax/xml/ws/Endpoint.html" title="class in javax.xml.ws"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/xml/ws/Dispatch.html" target="_top">Frames</a></li> |
| <li><a href="Dispatch.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
