blob: adbe29bc978d1232734775a0c980e9e1b9a53a02 [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>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OperationClient (Apache Axis2)</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="OperationClient (Apache Axis2)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":6,"i5":6,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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="class-use/OperationClient.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><a href="../../../../org/apache/axis2/client/FaultMapKey.html" title="class in org.apache.axis2.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/axis2/client/Options.html" title="class in org.apache.axis2.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis2/client/OperationClient.html" target="_top">Frames</a></li>
<li><a href="OperationClient.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.client</div>
<h2 title="Class OperationClient" class="title">Class OperationClient</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.axis2.client.OperationClient</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">OperationClient</span>
extends <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">An operation client is the way an advanced user interacts with Axis2. Actual
operation clients understand a specific MEP and hence their behavior is
defined by their MEP. To interact with an operation client, you first get one
from a specific AxisOperation. Then you set the messages into it one by one
(whatever is available). Then, when you call execute() the client will
execute what it can at that point. If executing the operation client results
in a new message being created, then if a message receiver is registered with
the client then the message will be delivered to that client.</div>
</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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/axis2/client/async/AxisCallback.html" title="interface in org.apache.axis2.client.async">AxisCallback</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#axisCallback">axisCallback</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/axis2/description/AxisOperation.html" title="class in org.apache.axis2.description">AxisOperation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#axisOp">axisOp</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#completed">completed</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/axis2/context/OperationContext.html" title="class in org.apache.axis2.context">OperationContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#oc">oc</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/axis2/client/Options.html" title="class in org.apache.axis2.client">Options</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#options">options</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/axis2/context/ServiceContext.html" title="class in org.apache.axis2.context">ServiceContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#sc">sc</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#OperationClient-org.apache.axis2.description.AxisOperation-org.apache.axis2.context.ServiceContext-org.apache.axis2.client.Options-">OperationClient</a></span>(<a href="../../../../org/apache/axis2/description/AxisOperation.html" title="class in org.apache.axis2.description">AxisOperation</a>&nbsp;axisOp,
<a href="../../../../org/apache/axis2/context/ServiceContext.html" title="class in org.apache.axis2.context">ServiceContext</a>&nbsp;sc,
<a href="../../../../org/apache/axis2/client/Options.html" title="class in org.apache.axis2.client">Options</a>&nbsp;options)</code>&nbsp;</td>
</tr>
</table>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#addMessageContext-org.apache.axis2.context.MessageContext-">addMessageContext</a></span>(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;messageContext)</code>
<div class="block">Add a message context to the client for processing.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#addReferenceParameters-org.apache.axis2.context.MessageContext-">addReferenceParameters</a></span>(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgctx)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#complete-org.apache.axis2.context.MessageContext-">complete</a></span>(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgCtxt)</code>
<div class="block">To close the transport if necessary , can call this method.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#execute-boolean-">execute</a></span>(boolean&nbsp;block)</code>
<div class="block">Execute the MEP.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#executeImpl-boolean-">executeImpl</a></span>(boolean&nbsp;block)</code>
<div class="block">Execute the MEP.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#getMessageContext-java.lang.String-">getMessageContext</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;messageLabel)</code>
<div class="block">Return a message from the client - will return null if the requested
message is not available.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/axis2/context/OperationContext.html" title="class in org.apache.axis2.context">OperationContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#getOperationContext--">getOperationContext</a></span>()</code>
<div class="block">To get the operation context of the operation client</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/axis2/client/Options.html" title="class in org.apache.axis2.client">Options</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#getOptions--">getOptions</a></span>()</code>
<div class="block">Return the options used by this client.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#prepareMessageContext-org.apache.axis2.context.ConfigurationContext-org.apache.axis2.context.MessageContext-">prepareMessageContext</a></span>(<a href="../../../../org/apache/axis2/context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a>&nbsp;configurationContext,
<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;mc)</code>
<div class="block">prepareMessageContext gets a fresh new MessageContext ready to be sent.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#reset--">reset</a></span>()</code>
<div class="block">Reset the operation client to a clean status after the MEP has completed.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#setCallback-org.apache.axis2.client.async.AxisCallback-">setCallback</a></span>(<a href="../../../../org/apache/axis2/client/async/AxisCallback.html" title="interface in org.apache.axis2.client.async">AxisCallback</a>&nbsp;callback)</code>
<div class="block">Set the callback to be executed when a message comes into the MEP and the
operation client is executed.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#setMessageID-org.apache.axis2.context.MessageContext-">setMessageID</a></span>(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;mc)</code>
<div class="block">Create a message ID for the given message context if needed.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/client/OperationClient.html#setOptions-org.apache.axis2.client.Options-">setOptions</a></span>(<a href="../../../../org/apache/axis2/client/Options.html" title="class in org.apache.axis2.client">Options</a>&nbsp;options)</code>
<div class="block">Sets the options that should be used for this particular client.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="axisOp">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>axisOp</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/axis2/description/AxisOperation.html" title="class in org.apache.axis2.description">AxisOperation</a> axisOp</pre>
</li>
</ul>
<a name="sc">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sc</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/axis2/context/ServiceContext.html" title="class in org.apache.axis2.context">ServiceContext</a> sc</pre>
</li>
</ul>
<a name="options">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>options</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/axis2/client/Options.html" title="class in org.apache.axis2.client">Options</a> options</pre>
</li>
</ul>
<a name="oc">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>oc</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/axis2/context/OperationContext.html" title="class in org.apache.axis2.context">OperationContext</a> oc</pre>
</li>
</ul>
<a name="axisCallback">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>axisCallback</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/axis2/client/async/AxisCallback.html" title="interface in org.apache.axis2.client.async">AxisCallback</a> axisCallback</pre>
</li>
</ul>
<a name="completed">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>completed</h4>
<pre>protected&nbsp;boolean completed</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="OperationClient-org.apache.axis2.description.AxisOperation-org.apache.axis2.context.ServiceContext-org.apache.axis2.client.Options-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OperationClient</h4>
<pre>protected&nbsp;OperationClient(<a href="../../../../org/apache/axis2/description/AxisOperation.html" title="class in org.apache.axis2.description">AxisOperation</a>&nbsp;axisOp,
<a href="../../../../org/apache/axis2/context/ServiceContext.html" title="class in org.apache.axis2.context">ServiceContext</a>&nbsp;sc,
<a href="../../../../org/apache/axis2/client/Options.html" title="class in org.apache.axis2.client">Options</a>&nbsp;options)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setOptions-org.apache.axis2.client.Options-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOptions</h4>
<pre>public&nbsp;void&nbsp;setOptions(<a href="../../../../org/apache/axis2/client/Options.html" title="class in org.apache.axis2.client">Options</a>&nbsp;options)</pre>
<div class="block">Sets the options that should be used for this particular client. This
resets the entire set of options to use the new options - so you'd lose
any option cascading that may have been set up.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>options</code> - the options</dd>
</dl>
</li>
</ul>
<a name="getOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOptions</h4>
<pre>public&nbsp;<a href="../../../../org/apache/axis2/client/Options.html" title="class in org.apache.axis2.client">Options</a>&nbsp;getOptions()</pre>
<div class="block">Return the options used by this client. If you want to set a single
option, then the right way is to do getOptions() and set specific
options.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the options, which will never be null.</dd>
</dl>
</li>
</ul>
<a name="addMessageContext-org.apache.axis2.context.MessageContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMessageContext</h4>
<pre>public abstract&nbsp;void&nbsp;addMessageContext(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;messageContext)
throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block">Add a message context to the client for processing. This method must not
process the message - it only records it in the operation client.
Processing only occurs when execute() is called.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>messageContext</code> - the message context</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - if this is called inappropriately.</dd>
</dl>
</li>
</ul>
<a name="getMessageContext-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageContext</h4>
<pre>public abstract&nbsp;<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;getMessageContext(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;messageLabel)
throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block">Return a message from the client - will return null if the requested
message is not available.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>messageLabel</code> - the message label of the desired message context</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the desired message context or null if its not available.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - if the message label is invalid</dd>
</dl>
</li>
</ul>
<a name="setCallback-org.apache.axis2.client.async.AxisCallback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCallback</h4>
<pre>public final&nbsp;void&nbsp;setCallback(<a href="../../../../org/apache/axis2/client/async/AxisCallback.html" title="interface in org.apache.axis2.client.async">AxisCallback</a>&nbsp;callback)</pre>
<div class="block">Set the callback to be executed when a message comes into the MEP and the
operation client is executed. This is the way the operation client
provides notification that a message has been received by it. Exactly
when its executed and under what conditions is a function of the specific
operation client.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>callback</code> - the callback to be used when the client decides its time to
use it</dd>
</dl>
</li>
</ul>
<a name="execute-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>public final&nbsp;void&nbsp;execute(boolean&nbsp;block)
throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block">Execute the MEP. This method is final and only serves to set (if appropriate)
the lastOperationContext on the ServiceContext, and then it calls
executeImpl(), which does the actual work.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>block</code> - Indicates whether execution should block or return ASAP. What
block means is of course a function of the specific operation
client.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - if something goes wrong during the execution of the operation
client.</dd>
</dl>
</li>
</ul>
<a name="executeImpl-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeImpl</h4>
<pre>public abstract&nbsp;void&nbsp;executeImpl(boolean&nbsp;block)
throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block">Execute the MEP. What this does depends on the specific operation client.
The basic idea is to have the operation client execute and do something
with the messages that have been added to it so far. For example, if its
an Out-In MEP, then if the Out message has been set, then executing the
client asks it to send the message and get the In message, possibly using
a different thread.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>block</code> - Indicates whether execution should block or return ASAP. What
block means is of course a function of the specific operation
client.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - if something goes wrong during the execution of the operation
client.</dd>
</dl>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public&nbsp;void&nbsp;reset()
throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block">Reset the operation client to a clean status after the MEP has completed.
This is how you can reuse an operation client. NOTE: this does not reset
the options; only the internal state so the client can be used again.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - if reset is called before the MEP client has completed an
interaction.</dd>
</dl>
</li>
</ul>
<a name="complete-org.apache.axis2.context.MessageContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>complete</h4>
<pre>public&nbsp;void&nbsp;complete(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgCtxt)
throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block">To close the transport if necessary , can call this method. The main
usage of this method is when client uses two tarnsports for sending and
receiving , and we need to remove entries for waiting calls in the
transport listener queue.
Note : DO NOT call this method if you are not using two transports to
send and receive</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>msgCtxt</code> - : MessageContext# which has all the transport information</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - : throws AxisFault if something goes wrong</dd>
</dl>
</li>
</ul>
<a name="getOperationContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperationContext</h4>
<pre>public&nbsp;<a href="../../../../org/apache/axis2/context/OperationContext.html" title="class in org.apache.axis2.context">OperationContext</a>&nbsp;getOperationContext()</pre>
<div class="block">To get the operation context of the operation client</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>OperationContext</dd>
</dl>
</li>
</ul>
<a name="setMessageID-org.apache.axis2.context.MessageContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMessageID</h4>
<pre>protected&nbsp;void&nbsp;setMessageID(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;mc)</pre>
<div class="block">Create a message ID for the given message context if needed. If user gives an option with
MessageID then just copy that into MessageContext , and with that there can be multiple
message with same MessageID unless user call setOption for each invocation.
<p/>
If user want to give message ID then the better way is to set the message ID in the option and
call setOption for each invocation then the right thing will happen.
<p/>
If user does not give a message ID then the new one will be created and set that into Message
Context.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mc</code> - the message context whose id is to be set</dd>
</dl>
</li>
</ul>
<a name="addReferenceParameters-org.apache.axis2.context.MessageContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addReferenceParameters</h4>
<pre>protected&nbsp;void&nbsp;addReferenceParameters(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgctx)</pre>
</li>
</ul>
<a name="prepareMessageContext-org.apache.axis2.context.ConfigurationContext-org.apache.axis2.context.MessageContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>prepareMessageContext</h4>
<pre>protected&nbsp;void&nbsp;prepareMessageContext(<a href="../../../../org/apache/axis2/context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a>&nbsp;configurationContext,
<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;mc)
throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block">prepareMessageContext gets a fresh new MessageContext ready to be sent.
It sets up the necessary properties, transport information, etc.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configurationContext</code> - the active ConfigurationContext</dd>
<dd><code>mc</code> - the MessageContext to be configured</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - if there is a problem</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="class-use/OperationClient.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><a href="../../../../org/apache/axis2/client/FaultMapKey.html" title="class in org.apache.axis2.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/axis2/client/Options.html" title="class in org.apache.axis2.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis2/client/OperationClient.html" target="_top">Frames</a></li>
<li><a href="OperationClient.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>