| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>InvocationController (Apache Axis2)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="InvocationController (Apache Axis2)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"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"; |
| var pathtoroot = "../../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/InvocationController.html">Use</a></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" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.axis2.jaxws.core.controller</a></div> |
| <h2 title="Interface InvocationController" class="title">Interface InvocationController</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="impl/AxisInvocationController.html" title="class in org.apache.axis2.jaxws.core.controller.impl">AxisInvocationController</a></code>, <code><a href="impl/InvocationControllerImpl.html" title="class in org.apache.axis2.jaxws.core.controller.impl">InvocationControllerImpl</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">InvocationController</span></pre> |
| <div class="block">The <tt>InvocationController</tt> is an interface modeling the invocation of a |
| target web service. All of the information that the InvocationController needs |
| should exist within the InvocatonContext that is passed in to the various invoke |
| methods. |
| <p/> |
| The request information is passed in within the InvocationContext. The InvocationController |
| assumes that there is a MessageContext within that InvocationContext that is populated with all |
| of the information that it needs to invoke. If not, an error will be returned. Once the |
| response comes back, the information for that response will be held inside of the MessageContext |
| representing the response, that exists in the InvocationContext. |
| <p/> |
| The InvocationController supports four different invocation patterns: |
| <p/> |
| 1) synchronous - This is represented by the <a href="#invoke(org.apache.axis2.jaxws.core.InvocationContext)"><code>invoke(InvocationContext)</code></a> method. This is a |
| blocking, request/response call to the web service. |
| <p/> |
| 2) one-way - This is represented by the <a href="#invokeOneWay(org.apache.axis2.jaxws.core.InvocationContext)"><code>invokeOneWay(InvocationContext)</code></a> method. This is |
| a one-way invocation that only returns errors related to sending the message. If an error occurs |
| while processing, the client will not be notified. |
| <p/> |
| 3) asynchronous (callback) - <a href="#invokeAsync(org.apache.axis2.jaxws.core.InvocationContext,javax.xml.ws.AsyncHandler)"><code>invokeAsync(InvocationContext, AsyncHandler)</code></a> |
| <p/> |
| 4) asynchronous (polling) - <a href="#invokeAsync(org.apache.axis2.jaxws.core.InvocationContext)"><code>invokeAsync(InvocationContext)</code></a></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invoke(org.apache.axis2.jaxws.core.InvocationContext)">invoke</a></span>​(<a href="../InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a> ic)</code></th> |
| <td class="colLast"> |
| <div class="block">Performs a synchronous (blocking) invocation of a target service.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/Response.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">Response</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invokeAsync(org.apache.axis2.jaxws.core.InvocationContext)">invokeAsync</a></span>​(<a href="../InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a> ic)</code></th> |
| <td class="colLast"> |
| <div class="block">Performs an asynchronous (non-blocking) invocation of the client based on a callback model.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invokeAsync(org.apache.axis2.jaxws.core.InvocationContext,javax.xml.ws.AsyncHandler)">invokeAsync</a></span>​(<a href="../InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a> ic, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/AsyncHandler.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">AsyncHandler</a> asyncHandler)</code></th> |
| <td class="colLast"> |
| <div class="block">Performs an asynchronous (non-blocking) invocation of the client based on a polling model.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invokeOneWay(org.apache.axis2.jaxws.core.InvocationContext)">invokeOneWay</a></span>​(<a href="../InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a> ic)</code></th> |
| <td class="colLast"> |
| <div class="block">Performs a one-way invocation of the client.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="invoke(org.apache.axis2.jaxws.core.InvocationContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invoke</h4> |
| <pre class="methodSignature"><a href="../InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a> invoke​(<a href="../InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a> ic)</pre> |
| <div class="block">Performs a synchronous (blocking) invocation of a target service. The InvocationContext |
| passed in should contain a valid MessageContext containing the properties and message to be |
| sent for the request. The response contents will be processed and placed in the |
| InvocationContext as well.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ic</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a id="invokeOneWay(org.apache.axis2.jaxws.core.InvocationContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invokeOneWay</h4> |
| <pre class="methodSignature">void invokeOneWay​(<a href="../InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a> ic) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Performs a one-way invocation of the client. This is SHOULD NOT be a robust invocation, so |
| any fault that occurs during the processing of the request will not be returned to the |
| client. Errors returned to the client are problems that occurred during the sending of the |
| message to the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ic</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="invokeAsync(org.apache.axis2.jaxws.core.InvocationContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invokeAsync</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/Response.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">Response</a> invokeAsync​(<a href="../InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a> ic)</pre> |
| <div class="block">Performs an asynchronous (non-blocking) invocation of the client based on a callback model. |
| The AsyncHandler that is passed in is the callback that the client programmer supplied when |
| they invoked their JAX-WS Dispatch or their SEI-based dynamic proxy.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ic</code> - </dd> |
| <dd><code>callback</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a id="invokeAsync(org.apache.axis2.jaxws.core.InvocationContext,javax.xml.ws.AsyncHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>invokeAsync</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a><?> invokeAsync​(<a href="../InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a> ic, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/AsyncHandler.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">AsyncHandler</a> asyncHandler)</pre> |
| <div class="block">Performs an asynchronous (non-blocking) invocation of the client based on a polling model. |
| The Response object that is returned allows the client programmer to poll against it to see |
| if a response has been sent back by the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ic</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/InvocationController.html">Use</a></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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
