| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ServiceClient (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="ServiceClient (Apache Axis2)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/ServiceClient.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 ServiceClient" class="title">Class ServiceClient</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.ServiceClient</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../dataretrieval/client/MexClient.html" title="class in org.apache.axis2.dataretrieval.client">MexClient</a></code>, <code><a href="../rpc/client/RPCServiceClient.html" title="class in org.apache.axis2.rpc.client">RPCServiceClient</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">ServiceClient</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">Client access to a service. Each instance of this class is associated with a particular <a href="../description/AxisService.html" title="class in org.apache.axis2.description"><code>AxisService</code></a>, and the methods support operations using that service. Note that |
| these instances are not intended to be thread-safe. |
| <a href="Options.html" title="class in org.apache.axis2.client"><code>Options</code></a> instances are used to configure various aspects of the service access.</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>static <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ANON_OUT_IN_OP">ANON_OUT_IN_OP</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Operation name used for an anonymous in-out operation (meaning we sent a message and receive |
| a response, equivalent to a WSDL In-Out operation).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ANON_OUT_ONLY_OP">ANON_OUT_ONLY_OP</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Operation name used for an anonymous out-only operation (meaning we send a message with no |
| response allowed from the service, equivalent to a WSDL In-Only operation).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ANON_ROBUST_OUT_ONLY_OP">ANON_ROBUST_OUT_ONLY_OP</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Operation name used for an anonymous robust-out-only operation (meaning we send a message, |
| with the only possible response a fault, equivalent to a WSDL Robust-In-Only operation).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ANON_SERVICE">ANON_SERVICE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Base name used for a service created without an existing configuration.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#AUTO_OPERATION_CLEANUP">AUTO_OPERATION_CLEANUP</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Option property name for automatically cleaning up old OperationContexts</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static org.apache.commons.logging.Log</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#log">log</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">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ServiceClient</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Create a service client by assuming an anonymous service and any other necessary |
| information.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.axis2.context.ConfigurationContext,java.net.URL,javax.xml.namespace.QName,java.lang.String)">ServiceClient</a></span>​(<a href="../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configContext, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a> wsdlURL, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> wsdlServiceName, |
| <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> portName)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a service client for WSDL service identified by the QName of the wsdl:service element |
| in a WSDL document.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.axis2.context.ConfigurationContext,javax.wsdl.Definition,javax.xml.namespace.QName,java.lang.String)">ServiceClient</a></span>​(<a href="../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configContext, |
| javax.wsdl.Definition wsdl4jDefinition, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> wsdlServiceName, |
| <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> portName)</code></th> |
| <td class="colLast"> |
| <div class="block">This is WSDL4J based constructor to configure the Service Client/ TODO: make this policy |
| aware</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.axis2.context.ConfigurationContext,org.apache.axis2.description.AxisService)">ServiceClient</a></span>​(<a href="../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configContext, |
| <a href="../description/AxisService.html" title="class in org.apache.axis2.description">AxisService</a> axisService)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a service client configured to work with a specific AxisService.</div> |
| </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="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>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addHeader(org.apache.axiom.om.OMElement)">addHeader</a></span>​(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> header)</code></th> |
| <td class="colLast"> |
| <div class="block">Add an arbitrary XML element as a header to be sent with outgoing messages.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addHeader(org.apache.axiom.soap.SOAPHeaderBlock)">addHeader</a></span>​(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/soap/SOAPHeaderBlock.html?is-external=true" title="class or interface in org.apache.axiom.soap" class="externalLink">SOAPHeaderBlock</a> header)</code></th> |
| <td class="colLast"> |
| <div class="block">Add SOAP Header to be sent with outgoing messages.</div> |
| </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="#addHeadersToEnvelope(org.apache.axiom.soap.SOAPEnvelope)">addHeadersToEnvelope</a></span>​(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/soap/SOAPEnvelope.html?is-external=true" title="class or interface in org.apache.axiom.soap" class="externalLink">SOAPEnvelope</a> envelope)</code></th> |
| <td class="colLast"> |
| <div class="block">Add all configured headers to a SOAP envelope.</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="#addStringHeader(javax.xml.namespace.QName,java.lang.String)">addStringHeader</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> headerName, |
| <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> headerText)</code></th> |
| <td class="colLast"> |
| <div class="block">Add a simple header containing some text to be sent with interactions.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cleanup()">cleanup</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Clean up configuration created with this client.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cleanupTransport()">cleanupTransport</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Release resources allocated by the transport during the last service invocation.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="OperationClient.html" title="class in org.apache.axis2.client">OperationClient</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createClient(javax.xml.namespace.QName)">createClient</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> operationQName)</code></th> |
| <td class="colLast"> |
| <div class="block">Create an operation client with the appropriate message exchange pattern (MEP).</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disengageModule(java.lang.String)">disengageModule</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> moduleName)</code></th> |
| <td class="colLast"> |
| <div class="block">Disengage a module for this service client</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#engageModule(java.lang.String)">engageModule</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> moduleName)</code></th> |
| <td class="colLast"> |
| <div class="block">Engage a module for this service client.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(<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> obj)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#finalize()">finalize</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireAndForget(javax.xml.namespace.QName,org.apache.axiom.om.OMElement)">fireAndForget</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> operation, |
| <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> elem)</code></th> |
| <td class="colLast"> |
| <div class="block">Directly invoke a named operation with an In-Only MEP.</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="#fireAndForget(org.apache.axiom.om.OMElement)">fireAndForget</a></span>​(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> elem)</code></th> |
| <td class="colLast"> |
| <div class="block">Directly invoke an anonymous operation with an In-Only MEP.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../engine/AxisConfiguration.html" title="class in org.apache.axis2.engine">AxisConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAxisConfiguration()">getAxisConfiguration</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the AxisConfiguration</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../description/AxisService.html" title="class in org.apache.axis2.description">AxisService</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAxisService()">getAxisService</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the AxisService this is a client for.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <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="#getLastOperationContext()">getLastOperationContext</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the last OperationContext</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../addressing/EndpointReference.html" title="class in org.apache.axis2.addressing">EndpointReference</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMyEPR(java.lang.String)">getMyEPR</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> transport)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the endpoint reference for this client using a particular transport.</div> |
| </td> |
| </tr> |
| <tr id="i17" 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">Get the basic client configuration from this service interaction.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <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="#getOverrideOptions()">getOverrideOptions</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the client configuration used to override the normal options set by an operation client.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><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="#getServiceContext()">getServiceContext</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the service context.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../addressing/EndpointReference.html" title="class in org.apache.axis2.addressing">EndpointReference</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTargetEPR()">getTargetEPR</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the endpoint reference for the service.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeHeaders()">removeHeaders</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Remove all headers for outgoing message.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendReceive(javax.xml.namespace.QName,org.apache.axiom.om.OMElement)">sendReceive</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> operationQName, |
| <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> xmlPayload)</code></th> |
| <td class="colLast"> |
| <div class="block">Directly invoke a named operationQName with an In-Out MEP.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendReceive(org.apache.axiom.om.OMElement)">sendReceive</a></span>​(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> elem)</code></th> |
| <td class="colLast"> |
| <div class="block">Directly invoke an anonymous operation with an In-Out MEP.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendReceiveNonBlocking(javax.xml.namespace.QName,org.apache.axiom.om.OMElement,org.apache.axis2.client.async.AxisCallback)">sendReceiveNonBlocking</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> operation, |
| <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> elem, |
| <a href="async/AxisCallback.html" title="interface in org.apache.axis2.client.async">AxisCallback</a> callback)</code></th> |
| <td class="colLast"> |
| <div class="block">Directly invoke a named operation with an In-Out MEP without waiting for a response.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendReceiveNonBlocking(org.apache.axiom.om.OMElement,org.apache.axis2.client.async.AxisCallback)">sendReceiveNonBlocking</a></span>​(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> elem, |
| <a href="async/AxisCallback.html" title="interface in org.apache.axis2.client.async">AxisCallback</a> callback)</code></th> |
| <td class="colLast"> |
| <div class="block">Directly invoke an anonymous operation with an In-Out MEP without waiting for a response.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendRobust(javax.xml.namespace.QName,org.apache.axiom.om.OMElement)">sendRobust</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> operation, |
| <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> elem)</code></th> |
| <td class="colLast"> |
| <div class="block">Directly invoke a named operation with a Robust In-Only MEP.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendRobust(org.apache.axiom.om.OMElement)">sendRobust</a></span>​(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> elem)</code></th> |
| <td class="colLast"> |
| <div class="block">Directly invoke an anonymous operation with a Robust In-Only MEP.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAxisService(org.apache.axis2.description.AxisService)">setAxisService</a></span>​(<a href="../description/AxisService.html" title="class in org.apache.axis2.description">AxisService</a> axisService)</code></th> |
| <td class="colLast"> |
| <div class="block">Configure the ServiceClient to interact with the Web service described by the specified |
| AxisService object.</div> |
| </td> |
| </tr> |
| <tr id="i30" 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">Set the basic client configuration related to this service interaction.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOverrideOptions(org.apache.axis2.client.Options)">setOverrideOptions</a></span>​(<a href="Options.html" title="class in org.apache.axis2.client">Options</a> overrideOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">Set a client configuration to override the normal options used by an operation client.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTargetEPR(org.apache.axis2.addressing.EndpointReference)">setTargetEPR</a></span>​(<a href="../addressing/EndpointReference.html" title="class in org.apache.axis2.addressing">EndpointReference</a> targetEpr)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the endpoint reference for the service.</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#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#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="log"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>log</h4> |
| <pre>protected static final org.apache.commons.logging.Log log</pre> |
| </li> |
| </ul> |
| <a id="ANON_SERVICE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ANON_SERVICE</h4> |
| <pre>public static final <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> ANON_SERVICE</pre> |
| <div class="block">Base name used for a service created without an existing configuration.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.axis2.client.ServiceClient.ANON_SERVICE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="AUTO_OPERATION_CLEANUP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>AUTO_OPERATION_CLEANUP</h4> |
| <pre>public static final <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> AUTO_OPERATION_CLEANUP</pre> |
| <div class="block">Option property name for automatically cleaning up old OperationContexts</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.axis2.client.ServiceClient.AUTO_OPERATION_CLEANUP">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="ANON_OUT_ONLY_OP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ANON_OUT_ONLY_OP</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> ANON_OUT_ONLY_OP</pre> |
| <div class="block">Operation name used for an anonymous out-only operation (meaning we send a message with no |
| response allowed from the service, equivalent to a WSDL In-Only operation).</div> |
| </li> |
| </ul> |
| <a id="ANON_ROBUST_OUT_ONLY_OP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ANON_ROBUST_OUT_ONLY_OP</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> ANON_ROBUST_OUT_ONLY_OP</pre> |
| <div class="block">Operation name used for an anonymous robust-out-only operation (meaning we send a message, |
| with the only possible response a fault, equivalent to a WSDL Robust-In-Only operation).</div> |
| </li> |
| </ul> |
| <a id="ANON_OUT_IN_OP"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ANON_OUT_IN_OP</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> ANON_OUT_IN_OP</pre> |
| <div class="block">Operation name used for an anonymous in-out operation (meaning we sent a message and receive |
| a response, equivalent to a WSDL In-Out operation).</div> |
| </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.context.ConfigurationContext,org.apache.axis2.description.AxisService)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ServiceClient</h4> |
| <pre>public ServiceClient​(<a href="../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configContext, |
| <a href="../description/AxisService.html" title="class in org.apache.axis2.description">AxisService</a> axisService) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Create a service client configured to work with a specific AxisService. If this service is |
| already in the world that's handed in (in the form of a ConfigurationContext) then I will |
| happily work in it. If not I will create a small little virtual world and live there.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configContext</code> - The configuration context under which this service lives (may be null, |
| in which case a new local one will be created)</dd> |
| <dd><code>axisService</code> - The service for which this is the client (may be <code>null</code>, in |
| which case an anonymous service will be created)</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 while creating a config context (if needed)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.axis2.context.ConfigurationContext,javax.wsdl.Definition,javax.xml.namespace.QName,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ServiceClient</h4> |
| <pre>public ServiceClient​(<a href="../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configContext, |
| javax.wsdl.Definition wsdl4jDefinition, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> wsdlServiceName, |
| <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> portName) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">This is WSDL4J based constructor to configure the Service Client/ TODO: make this policy |
| aware</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configContext</code> - active ConfigurationContext</dd> |
| <dd><code>wsdl4jDefinition</code> - the WSDL we're going to be using to configure ourselves</dd> |
| <dd><code>wsdlServiceName</code> - QName of the WSDL service we'd like to access</dd> |
| <dd><code>portName</code> - name of the WSDL port we'd like to access</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - in case of error</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.axis2.context.ConfigurationContext,java.net.URL,javax.xml.namespace.QName,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ServiceClient</h4> |
| <pre>public ServiceClient​(<a href="../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configContext, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a> wsdlURL, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> wsdlServiceName, |
| <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> portName) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Create a service client for WSDL service identified by the QName of the wsdl:service element |
| in a WSDL document.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configContext</code> - The configuration context under which this service lives (may be |
| <code>null</code>, in which case a new local one will be created) *</dd> |
| <dd><code>wsdlURL</code> - The URL of the WSDL document to read</dd> |
| <dd><code>wsdlServiceName</code> - The QName of the WSDL service in the WSDL document to create a client |
| for</dd> |
| <dd><code>portName</code> - The name of the WSDL 1.1 port to create a client for. May be null (if |
| WSDL 2.0 is used or if only one port is there). .</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 while creating a config context (if needed)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ServiceClient</h4> |
| <pre>public ServiceClient() |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Create a service client by assuming an anonymous service and any other necessary |
| information.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - in case of error</dd> |
| </dl> |
| </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="getAxisConfiguration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAxisConfiguration</h4> |
| <pre class="methodSignature">public <a href="../engine/AxisConfiguration.html" title="class in org.apache.axis2.engine">AxisConfiguration</a> getAxisConfiguration()</pre> |
| <div class="block">Get the AxisConfiguration</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the AxisConfiguration associated with the client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAxisService()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAxisService</h4> |
| <pre class="methodSignature">public <a href="../description/AxisService.html" title="class in org.apache.axis2.description">AxisService</a> getAxisService()</pre> |
| <div class="block">Return the AxisService this is a client for. This is primarily useful when the AxisService is |
| created anonymously or from WSDL as otherwise the user had the AxisService to start with.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the axisService</dd> |
| </dl> |
| </li> |
| </ul> |
| <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">Set the basic client configuration related to this service interaction.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>options</code> - (non-<code>null</code>)</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">Get the basic client configuration from this service interaction.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>options</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setOverrideOptions(org.apache.axis2.client.Options)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOverrideOptions</h4> |
| <pre class="methodSignature">public void setOverrideOptions​(<a href="Options.html" title="class in org.apache.axis2.client">Options</a> overrideOptions)</pre> |
| <div class="block">Set a client configuration to override the normal options used by an operation client. Any |
| values set in this configuration will be used for each client, with the standard values for |
| the client still used for any values not set in the override configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>overrideOptions</code> - the Options to use</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOverrideOptions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOverrideOptions</h4> |
| <pre class="methodSignature">public <a href="Options.html" title="class in org.apache.axis2.client">Options</a> getOverrideOptions()</pre> |
| <div class="block">Get the client configuration used to override the normal options set by an operation client.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>override options</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="engageModule(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>engageModule</h4> |
| <pre class="methodSignature">public void engageModule​(<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> moduleName) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Engage a module for this service client.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>moduleName</code> - name of the module to engage</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</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="disengageModule(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>disengageModule</h4> |
| <pre class="methodSignature">public void disengageModule​(<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> moduleName)</pre> |
| <div class="block">Disengage a module for this service client</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>moduleName</code> - name of Module to disengage</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addHeader(org.apache.axiom.om.OMElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addHeader</h4> |
| <pre class="methodSignature">public void addHeader​(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> header)</pre> |
| <div class="block">Add an arbitrary XML element as a header to be sent with outgoing messages.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>header</code> - header to be sent (non-<code>null</code>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addHeader(org.apache.axiom.soap.SOAPHeaderBlock)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addHeader</h4> |
| <pre class="methodSignature">public void addHeader​(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/soap/SOAPHeaderBlock.html?is-external=true" title="class or interface in org.apache.axiom.soap" class="externalLink">SOAPHeaderBlock</a> header)</pre> |
| <div class="block">Add SOAP Header to be sent with outgoing messages.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>header</code> - header to be sent (non-<code>null</code>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeHeaders()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeHeaders</h4> |
| <pre class="methodSignature">public void removeHeaders()</pre> |
| <div class="block">Remove all headers for outgoing message.</div> |
| </li> |
| </ul> |
| <a id="addStringHeader(javax.xml.namespace.QName,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addStringHeader</h4> |
| <pre class="methodSignature">public void addStringHeader​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> headerName, |
| <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> headerText) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Add a simple header containing some text to be sent with interactions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>headerName</code> - name of header to add</dd> |
| <dd><code>headerText</code> - text content for header</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - in case of error</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sendRobust(org.apache.axiom.om.OMElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendRobust</h4> |
| <pre class="methodSignature">public void sendRobust​(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> elem) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Directly invoke an anonymous operation with a Robust In-Only MEP. This method just sends your |
| supplied XML and possibly receives a fault. For more control, you can instead create a client |
| for the operation and use that client to execute the send.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>elem</code> - XML to send</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 while sending, or if a fault is received in |
| response (per the Robust In-Only MEP).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#createClient(javax.xml.namespace.QName)"><code>createClient(QName)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sendRobust(javax.xml.namespace.QName,org.apache.axiom.om.OMElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendRobust</h4> |
| <pre class="methodSignature">public void sendRobust​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> operation, |
| <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> elem) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Directly invoke a named operation with a Robust In-Only MEP. This method just sends your |
| supplied XML and possibly receives a fault. For more control, you can instead create a client |
| for the operation and use that client to execute the send.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>operation</code> - name of operation to be invoked (non-<code>null</code>)</dd> |
| <dd><code>elem</code> - XML to send</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 while sending it or if a fault is received in |
| response (per the Robust In-Only MEP).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#createClient(javax.xml.namespace.QName)"><code>createClient(QName)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fireAndForget(org.apache.axiom.om.OMElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireAndForget</h4> |
| <pre class="methodSignature">public void fireAndForget​(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> elem) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Directly invoke an anonymous operation with an In-Only MEP. This method just sends your |
| supplied XML without the possibility of any response from the service (even an error - though |
| you can still get client-side errors such as "Host not found"). For more control, you can |
| instead create a client for the operation and use that client to execute the send.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>elem</code> - XML to send</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - ff something goes wrong trying to send the XML</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#createClient(javax.xml.namespace.QName)"><code>createClient(QName)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fireAndForget(javax.xml.namespace.QName,org.apache.axiom.om.OMElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireAndForget</h4> |
| <pre class="methodSignature">public void fireAndForget​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> operation, |
| <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> elem) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Directly invoke a named operation with an In-Only MEP. This method just sends your supplied |
| XML without the possibility of any response from the service (even an error - though you can |
| still get client-side errors such as "Host not found"). For more control, you can instead |
| create a client for the operation and use that client to execute the send.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>operation</code> - name of operation to be invoked (non-<code>null</code>)</dd> |
| <dd><code>elem</code> - XML to send</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 trying to send the XML</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#createClient(javax.xml.namespace.QName)"><code>createClient(QName)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sendReceive(org.apache.axiom.om.OMElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendReceive</h4> |
| <pre class="methodSignature">public <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> sendReceive​(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> elem) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Directly invoke an anonymous operation with an In-Out MEP. This method sends your supplied |
| XML and receives a response. For more control, you can instead create a client for the |
| operation and use that client to execute the exchange. |
| <p> |
| Unless the <code>callTransportCleanup</code> property on the <a href="Options.html" title="class in org.apache.axis2.client"><code>Options</code></a> object has been |
| set to <code>true</code>, the caller must invoke <a href="#cleanupTransport()"><code>cleanupTransport()</code></a> after |
| processing the response.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>elem</code> - the data to send (becomes the content of SOAP body)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>response</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - in case of error</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#createClient(javax.xml.namespace.QName)"><code>createClient(QName)</code></a>, |
| <a href="#cleanupTransport()"><code>cleanupTransport()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sendReceive(javax.xml.namespace.QName,org.apache.axiom.om.OMElement)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendReceive</h4> |
| <pre class="methodSignature">public <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> sendReceive​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> operationQName, |
| <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> xmlPayload) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Directly invoke a named operationQName with an In-Out MEP. This method sends your supplied |
| XML and receives a response. For more control, you can instead create a client for the |
| operationQName and use that client to execute the exchange. |
| <p> |
| Unless the <code>callTransportCleanup</code> property on the <a href="Options.html" title="class in org.apache.axis2.client"><code>Options</code></a> object has been |
| set to <code>true</code>, the caller must invoke <a href="#cleanupTransport()"><code>cleanupTransport()</code></a> after |
| processing the response.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>operationQName</code> - name of operationQName to be invoked (non-<code>null</code>)</dd> |
| <dd><code>xmlPayload</code> - the data to send (becomes the content of SOAP body)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>response OMElement</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - in case of error</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#cleanupTransport()"><code>cleanupTransport()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sendReceiveNonBlocking(org.apache.axiom.om.OMElement,org.apache.axis2.client.async.AxisCallback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendReceiveNonBlocking</h4> |
| <pre class="methodSignature">public void sendReceiveNonBlocking​(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> elem, |
| <a href="async/AxisCallback.html" title="interface in org.apache.axis2.client.async">AxisCallback</a> callback) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Directly invoke an anonymous operation with an In-Out MEP without waiting for a response. |
| This method sends your supplied XML with response notification to your callback handler. For |
| more control, you can instead create a client for the operation and use that client to |
| execute the exchange.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>elem</code> - the data to send (becomes the content of SOAP body)</dd> |
| <dd><code>callback</code> - a Callback which will be notified upon completion</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - in case of error</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#createClient(javax.xml.namespace.QName)"><code>createClient(QName)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sendReceiveNonBlocking(javax.xml.namespace.QName,org.apache.axiom.om.OMElement,org.apache.axis2.client.async.AxisCallback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendReceiveNonBlocking</h4> |
| <pre class="methodSignature">public void sendReceiveNonBlocking​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> operation, |
| <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> elem, |
| <a href="async/AxisCallback.html" title="interface in org.apache.axis2.client.async">AxisCallback</a> callback) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Directly invoke a named operation with an In-Out MEP without waiting for a response. This |
| method sends your supplied XML with response notification to your callback handler. For more |
| control, you can instead create a client for the operation and use that client to execute the |
| exchange.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>operation</code> - name of operation to be invoked (non-<code>null</code>)</dd> |
| <dd><code>elem</code> - the data to send (becomes the content of SOAP body)</dd> |
| <dd><code>callback</code> - a Callback which will be notified upon completion</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - in case of error</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#createClient(javax.xml.namespace.QName)"><code>createClient(QName)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createClient(javax.xml.namespace.QName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createClient</h4> |
| <pre class="methodSignature">public <a href="OperationClient.html" title="class in org.apache.axis2.client">OperationClient</a> createClient​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> operationQName) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Create an operation client with the appropriate message exchange pattern (MEP). This method |
| creates a full-function MEP client which can be used to exchange messages for a specific |
| operation. It configures the constructed operation client to use the current normal and |
| override options. This method is used internally, and also by generated client stub code.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>operationQName</code> - qualified name of operation (local name is operation name, namespace |
| URI is just the empty string)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>client configured to talk to the given operation</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 operation is not found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addHeadersToEnvelope(org.apache.axiom.soap.SOAPEnvelope)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addHeadersToEnvelope</h4> |
| <pre class="methodSignature">public void addHeadersToEnvelope​(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/soap/SOAPEnvelope.html?is-external=true" title="class or interface in org.apache.axiom.soap" class="externalLink">SOAPEnvelope</a> envelope)</pre> |
| <div class="block">Add all configured headers to a SOAP envelope.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>envelope</code> - the SOAPEnvelope in which to write the headers</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMyEPR(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMyEPR</h4> |
| <pre class="methodSignature">public <a href="../addressing/EndpointReference.html" title="class in org.apache.axis2.addressing">EndpointReference</a> getMyEPR​(<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> transport) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Get the endpoint reference for this client using a particular transport.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>transport</code> - transport name (non-<code>null</code>)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>local endpoint</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - in case of error</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTargetEPR()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTargetEPR</h4> |
| <pre class="methodSignature">public <a href="../addressing/EndpointReference.html" title="class in org.apache.axis2.addressing">EndpointReference</a> getTargetEPR()</pre> |
| <div class="block">Get the endpoint reference for the service.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>service endpoint</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTargetEPR(org.apache.axis2.addressing.EndpointReference)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTargetEPR</h4> |
| <pre class="methodSignature">public void setTargetEPR​(<a href="../addressing/EndpointReference.html" title="class in org.apache.axis2.addressing">EndpointReference</a> targetEpr)</pre> |
| <div class="block">Set the endpoint reference for the service.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>targetEpr</code> - the EPR this ServiceClient should target</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLastOperationContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastOperationContext</h4> |
| <pre class="methodSignature">public <a href="../context/OperationContext.html" title="class in org.apache.axis2.context">OperationContext</a> getLastOperationContext()</pre> |
| <div class="block">Gets the last OperationContext</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the last OperationContext that was invoked by this ServiceClient</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getServiceContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServiceContext</h4> |
| <pre class="methodSignature">public <a href="../context/ServiceContext.html" title="class in org.apache.axis2.context">ServiceContext</a> getServiceContext()</pre> |
| <div class="block">Get the service context.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>context</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="finalize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>finalize</h4> |
| <pre class="methodSignature">protected void finalize() |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="cleanup()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cleanup</h4> |
| <pre class="methodSignature">public void cleanup() |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Clean up configuration created with this client. Call this method when you're done using the |
| client, in order to discard any associated resources.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - in case of error</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="cleanupTransport()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cleanupTransport</h4> |
| <pre class="methodSignature">public void cleanupTransport() |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Release resources allocated by the transport during the last service invocation. |
| This method will call |
| <code>org.apache.axis2.transport.TransportSender#cleanup(MessageContext)</code> on the |
| transport sender used during that invocation. |
| <p> |
| If the <code>callTransportCleanup</code> property on the <a href="Options.html" title="class in org.apache.axis2.client"><code>Options</code></a> object is |
| set to <code>false</code> (which is the default), then this method must be called |
| after each invocation of an operation with an in-out MEP, but not before the response |
| from that operation has been completely processed (or <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMSerializable.html?is-external=true#build()" title="class or interface in org.apache.axiom.om" class="externalLink"><code>OMSerializable.build()</code></a> |
| has been called on the response element). |
| <p> |
| If the <code>callTransportCleanup</code> property is set to <code>true</code>, |
| then this method is called automatically. Note that in this case, <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMSerializable.html?is-external=true#build()" title="class or interface in org.apache.axiom.om" class="externalLink"><code>OMSerializable.build()</code></a> |
| will be called on the response element before is returned. This effectively disables |
| deferred parsing of the response and prevents the code from starting to process the |
| response before it has been completely received. Therefore this approach is not recommended |
| whenever performance is important.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setAxisService(org.apache.axis2.description.AxisService)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAxisService</h4> |
| <pre class="methodSignature">public void setAxisService​(<a href="../description/AxisService.html" title="class in org.apache.axis2.description">AxisService</a> axisService) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Configure the ServiceClient to interact with the Web service described by the specified |
| AxisService object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>axisService</code> - the AxisService that represents the new Web service.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - if an error occurs while configuring the ServiceClient.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre class="methodSignature">public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><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"><code>Object.hashCode()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">public boolean equals​(<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> obj)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><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"><code>Object.equals(java.lang.Object)</code></a></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/ServiceClient.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> |