| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>OperationClient (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="OperationClient (Apache Axis2)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"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"; |
| 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/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" 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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.client</a></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" class="externalLink">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> |
| <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" class="externalLink">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 =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="async/AxisCallback.html" title="interface in org.apache.axis2.client.async">AxisCallback</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#axisCallback">axisCallback</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../description/AxisOperation.html" title="class in org.apache.axis2.description">AxisOperation</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#axisOp">axisOp</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#completed">completed</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../context/OperationContext.html" title="class in org.apache.axis2.context">OperationContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#oc">oc</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="Options.html" title="class in org.apache.axis2.client">Options</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#options">options</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../context/ServiceContext.html" title="class in org.apache.axis2.context">ServiceContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sc">sc</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.axis2.description.AxisOperation,org.apache.axis2.context.ServiceContext,org.apache.axis2.client.Options)">OperationClient</a></span>​(<a href="../description/AxisOperation.html" title="class in org.apache.axis2.description">AxisOperation</a> axisOp, |
| <a href="../context/ServiceContext.html" title="class in org.apache.axis2.context">ServiceContext</a> sc, |
| <a href="Options.html" title="class in org.apache.axis2.client">Options</a> options)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== 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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addMessageContext(org.apache.axis2.context.MessageContext)">addMessageContext</a></span>​(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> messageContext)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addReferenceParameters(org.apache.axis2.context.MessageContext)">addReferenceParameters</a></span>​(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> msgctx)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#complete(org.apache.axis2.context.MessageContext)">complete</a></span>​(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> msgCtxt)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute(boolean)">execute</a></span>​(boolean block)</code></th> |
| <td class="colLast"> |
| <div class="block">Execute the MEP.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeImpl(boolean)">executeImpl</a></span>​(boolean block)</code></th> |
| <td class="colLast"> |
| <div class="block">Execute the MEP.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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" class="externalLink">String</a> messageLabel)</code></th> |
| <td class="colLast"> |
| <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="../context/OperationContext.html" title="class in org.apache.axis2.context">OperationContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperationContext()">getOperationContext</a></span>()</code></th> |
| <td class="colLast"> |
| <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="Options.html" title="class in org.apache.axis2.client">Options</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOptions()">getOptions</a></span>()</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prepareMessageContext(org.apache.axis2.context.ConfigurationContext,org.apache.axis2.context.MessageContext)">prepareMessageContext</a></span>​(<a href="../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configurationContext, |
| <a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> mc)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset()">reset</a></span>()</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCallback(org.apache.axis2.client.async.AxisCallback)">setCallback</a></span>​(<a href="async/AxisCallback.html" title="interface in org.apache.axis2.client.async">AxisCallback</a> callback)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMessageID(org.apache.axis2.context.MessageContext)">setMessageID</a></span>​(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> mc)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOptions(org.apache.axis2.client.Options)">setOptions</a></span>​(<a href="Options.html" title="class in org.apache.axis2.client">Options</a> options)</code></th> |
| <td class="colLast"> |
| <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 id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="axisOp"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>axisOp</h4> |
| <pre>protected <a href="../description/AxisOperation.html" title="class in org.apache.axis2.description">AxisOperation</a> axisOp</pre> |
| </li> |
| </ul> |
| <a id="sc"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sc</h4> |
| <pre>protected <a href="../context/ServiceContext.html" title="class in org.apache.axis2.context">ServiceContext</a> sc</pre> |
| </li> |
| </ul> |
| <a id="options"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>options</h4> |
| <pre>protected <a href="Options.html" title="class in org.apache.axis2.client">Options</a> options</pre> |
| </li> |
| </ul> |
| <a id="oc"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>oc</h4> |
| <pre>protected <a href="../context/OperationContext.html" title="class in org.apache.axis2.context">OperationContext</a> oc</pre> |
| </li> |
| </ul> |
| <a id="axisCallback"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>axisCallback</h4> |
| <pre>protected <a href="async/AxisCallback.html" title="interface in org.apache.axis2.client.async">AxisCallback</a> axisCallback</pre> |
| </li> |
| </ul> |
| <a id="completed"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>completed</h4> |
| <pre>protected boolean completed</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(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 OperationClient​(<a href="../description/AxisOperation.html" title="class in org.apache.axis2.description">AxisOperation</a> axisOp, |
| <a href="../context/ServiceContext.html" title="class in org.apache.axis2.context">ServiceContext</a> sc, |
| <a href="Options.html" title="class in org.apache.axis2.client">Options</a> options)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="setOptions(org.apache.axis2.client.Options)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOptions</h4> |
| <pre class="methodSignature">public void setOptions​(<a href="Options.html" title="class in org.apache.axis2.client">Options</a> 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 id="getOptions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOptions</h4> |
| <pre class="methodSignature">public <a href="Options.html" title="class in org.apache.axis2.client">Options</a> 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 id="addMessageContext(org.apache.axis2.context.MessageContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMessageContext</h4> |
| <pre class="methodSignature">public abstract void addMessageContext​(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> messageContext) |
| throws <a href="../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="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - if this is called inappropriately.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMessageContext(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageContext</h4> |
| <pre class="methodSignature">public abstract <a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> 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" class="externalLink">String</a> messageLabel) |
| throws <a href="../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="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - if the message label is invalid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCallback(org.apache.axis2.client.async.AxisCallback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCallback</h4> |
| <pre class="methodSignature">public final void setCallback​(<a href="async/AxisCallback.html" title="interface in org.apache.axis2.client.async">AxisCallback</a> 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 id="execute(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre class="methodSignature">public final void execute​(boolean block) |
| throws <a href="../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="../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 id="executeImpl(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>executeImpl</h4> |
| <pre class="methodSignature">public abstract void executeImpl​(boolean block) |
| throws <a href="../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="../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 id="reset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre class="methodSignature">public void reset() |
| throws <a href="../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="../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 id="complete(org.apache.axis2.context.MessageContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>complete</h4> |
| <pre class="methodSignature">public void complete​(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> msgCtxt) |
| throws <a href="../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="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - : throws AxisFault if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOperationContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOperationContext</h4> |
| <pre class="methodSignature">public <a href="../context/OperationContext.html" title="class in org.apache.axis2.context">OperationContext</a> 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 id="setMessageID(org.apache.axis2.context.MessageContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMessageID</h4> |
| <pre class="methodSignature">protected void setMessageID​(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> 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 id="addReferenceParameters(org.apache.axis2.context.MessageContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addReferenceParameters</h4> |
| <pre class="methodSignature">protected void addReferenceParameters​(<a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> msgctx)</pre> |
| </li> |
| </ul> |
| <a id="prepareMessageContext(org.apache.axis2.context.ConfigurationContext,org.apache.axis2.context.MessageContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>prepareMessageContext</h4> |
| <pre class="methodSignature">protected void prepareMessageContext​(<a href="../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configurationContext, |
| <a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> mc) |
| throws <a href="../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="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - if there is a problem</dd> |
| </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/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" 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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |