blob: a1926b2d7649f288f5a954fd534aa17f05d00f03 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>InvocationController (Apache Axis2)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="InvocationController (Apache Axis2)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="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">
<li>Prev Class</li>
<li><a href="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationControllerFactory.html" title="interface in org.apache.axis2.jaxws.core.controller"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/axis2/jaxws/core/controller/InvocationController.html" target="_top">Frames</a></li>
<li><a href="InvocationController.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">org.apache.axis2.jaxws.core.controller</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><a href="../../../../../../org/apache/axis2/jaxws/core/controller/impl/AxisInvocationController.html" title="class in org.apache.axis2.jaxws.core.controller.impl">AxisInvocationController</a>, <a href="../../../../../../org/apache/axis2/jaxws/core/controller/impl/InvocationControllerImpl.html" title="class in org.apache.axis2.jaxws.core.controller.impl">InvocationControllerImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">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="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationController.html#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="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationController.html#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="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationController.html#invokeAsync(org.apache.axis2.jaxws.core.InvocationContext, javax.xml.ws.AsyncHandler)"><code>invokeAsync(InvocationContext, AsyncHandler)</code></a>
<p/>
4) asynchronous (polling) - <a href="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationController.html#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 =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationController.html#invoke(org.apache.axis2.jaxws.core.InvocationContext)">invoke</a></strong>(<a href="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a>&nbsp;ic)</code>
<div class="block">Performs a synchronous (blocking) invocation of a target service.</div>
</td>
</tr>
<tr 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">Response</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationController.html#invokeAsync(org.apache.axis2.jaxws.core.InvocationContext)">invokeAsync</a></strong>(<a href="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a>&nbsp;ic)</code>
<div class="block">Performs an asynchronous (non-blocking) invocation of the client based on a callback model.</div>
</td>
</tr>
<tr 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">Future</a>&lt;?&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationController.html#invokeAsync(org.apache.axis2.jaxws.core.InvocationContext, javax.xml.ws.AsyncHandler)">invokeAsync</a></strong>(<a href="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a>&nbsp;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">AsyncHandler</a>&nbsp;asyncHandler)</code>
<div class="block">Performs an asynchronous (non-blocking) invocation of the client based on a polling model.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationController.html#invokeOneWay(org.apache.axis2.jaxws.core.InvocationContext)">invokeOneWay</a></strong>(<a href="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a>&nbsp;ic)</code>
<div class="block">Performs a one-way invocation of the client.</div>
</td>
</tr>
</table>
</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(org.apache.axis2.jaxws.core.InvocationContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invoke</h4>
<pre><a href="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a>&nbsp;invoke(<a href="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a>&nbsp;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="strong">Parameters:</span></dt><dd><code>ic</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="invokeOneWay(org.apache.axis2.jaxws.core.InvocationContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invokeOneWay</h4>
<pre>void&nbsp;invokeOneWay(<a href="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a>&nbsp;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">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="strong">Parameters:</span></dt><dd><code>ic</code> - </dd>
<dt><span class="strong">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">Exception</a></code></dd></dl>
</li>
</ul>
<a name="invokeAsync(org.apache.axis2.jaxws.core.InvocationContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invokeAsync</h4>
<pre><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">Response</a>&nbsp;invokeAsync(<a href="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a>&nbsp;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="strong">Parameters:</span></dt><dd><code>ic</code> - </dd><dd><code>callback</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="invokeAsync(org.apache.axis2.jaxws.core.InvocationContext, javax.xml.ws.AsyncHandler)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>invokeAsync</h4>
<pre><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">Future</a>&lt;?&gt;&nbsp;invokeAsync(<a href="../../../../../../org/apache/axis2/jaxws/core/InvocationContext.html" title="interface in org.apache.axis2.jaxws.core">InvocationContext</a>&nbsp;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">AsyncHandler</a>&nbsp;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="strong">Parameters:</span></dt><dd><code>ic</code> - </dd>
<dt><span class="strong">Returns:</span></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="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">
<li>Prev Class</li>
<li><a href="../../../../../../org/apache/axis2/jaxws/core/controller/InvocationControllerFactory.html" title="interface in org.apache.axis2.jaxws.core.controller"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/axis2/jaxws/core/controller/InvocationController.html" target="_top">Frames</a></li>
<li><a href="InvocationController.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>