blob: 3d130b4c570d8dd7ff5c10cf3ec5f7e5c6b23681 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by Apache Maven Doxia Site Renderer 1.3 at Jun 28, 2015 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Apache Axis2 -
</title>
<style type="text/css" media="all">
@import url("../../css/maven-base.css");
@import url("../../css/maven-theme.css");
@import url("../../css/site.css");
</style>
<link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" />
<meta name="Date-Revision-yyyymmdd" content="20150628" />
<meta http-equiv="Content-Language" content="en" />
<meta http-equiv="content-type" content="" />
</head>
<body class="composite">
<div id="banner">
<a href="http://www.apache.org/" id="bannerLeft">
<img src="http://www.apache.org/images/asf_logo_wide.png" alt="Apache Axis2" />
</a>
<a href="../.././" id="bannerRight">
<img src="../../images/axis.jpg" alt="Apache Axis2" />
</a>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xleft">
<span id="publishDate">Last Published: 2015-06-28</span>
&nbsp;| <span id="projectVersion">Version: 1.6.3</span>
</div>
<div class="xright"> <a href="../../index.html" title="Axis2/Java">Axis2/Java</a>
|
<a href="http://www.apache.org" class="externalLink" title="Apache">Apache</a>
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>Axis2/Java</h5>
<ul>
<li class="none">
<a href="../../index.html" title="Home">Home</a>
</li>
</ul>
<h5>Downloads</h5>
<ul>
<li class="none">
<a href="../../download.cgi" title="Releases">Releases</a>
</li>
<li class="none">
<a href="../../modules/index.html" title="Modules">Modules</a>
</li>
<li class="none">
<a href="../../tools/index.html" title="Tools">Tools</a>
</li>
</ul>
<h5>Documentation</h5>
<ul>
<li class="none">
<a href="../../docs/toc.html" title="Table of Contents">Table of Contents</a>
</li>
<li class="none">
<a href="../../docs/installationguide.html" title="Installation Guide">Installation Guide</a>
</li>
<li class="none">
<a href="../../docs/quickstartguide.html" title="QuickStart Guide">QuickStart Guide</a>
</li>
<li class="none">
<a href="../../docs/userguide.html" title="User Guide">User Guide</a>
</li>
<li class="none">
<a href="../../docs/jaxws-guide.html" title="JAXWS Guide">JAXWS Guide</a>
</li>
<li class="none">
<a href="../../docs/pojoguide.html" title="POJO Guide">POJO Guide</a>
</li>
<li class="none">
<a href="../../docs/spring.html" title="Spring Guide">Spring Guide</a>
</li>
<li class="none">
<a href="../../docs/webadminguide.html" title="Web Administrator's Guide">Web Administrator's Guide</a>
</li>
<li class="none">
<a href="../../docs/migration.html" title="Migration Guide (from Axis1)">Migration Guide (from Axis1)</a>
</li>
</ul>
<h5>Resources</h5>
<ul>
<li class="none">
<a href="../../faq.html" title="FAQ">FAQ</a>
</li>
<li class="none">
<a href="../../articles.html" title="Articles">Articles</a>
</li>
<li class="none">
<a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink" title="Wiki">Wiki</a>
</li>
<li class="none">
<a href="../../refLib.html" title="Reference Library">Reference Library</a>
</li>
<li class="none">
<a href="../../api/index.html" title="Online Java Docs">Online Java Docs</a>
</li>
</ul>
<h5>Get Involved</h5>
<ul>
<li class="none">
<a href="../../overview.html" title="Overview">Overview</a>
</li>
<li class="none">
<a href="../../svn.html" title="Checkout the Source">Checkout the Source</a>
</li>
<li class="none">
<a href="../../mail-lists.html" title="Mailing Lists">Mailing Lists</a>
</li>
<li class="none">
<a href="../../release-process.html" title="Release Process">Release Process</a>
</li>
<li class="none">
<a href="../../guidelines.html" title="Developer Guidelines">Developer Guidelines</a>
</li>
<li class="none">
<a href="../../siteHowTo.html" title="Build the Site">Build the Site</a>
</li>
</ul>
<h5>Project Information</h5>
<ul>
<li class="none">
<a href="../../team-list.html" title="Project Team">Project Team</a>
</li>
<li class="none">
<a href="../../issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
</li>
<li class="none">
<a href="http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/" class="externalLink" title="Source Code">Source Code</a>
</li>
<li class="none">
<a href="../../thanks.html" title="Acknowledgements">Acknowledgements</a>
</li>
<li class="none">
<a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink" title="License">License</a>
</li>
<li class="none">
<a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">Sponsorship</a>
</li>
<li class="none">
<a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">Thanks</a>
</li>
<li class="none">
<a href="http://www.apache.org/security/" class="externalLink" title="Security">Security</a>
</li>
</ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="poweredBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" />
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<!-- ~ Licensed to the Apache Software Foundation (ASF) under one
~ or more contributor license agreements. See the NOTICE file
~ distributed with this work for additional information
~ regarding copyright ownership. The ASF licenses this file
~ to you under the Apache License, Version 2.0 (the
~ "License"); you may not use this file except in compliance
~ with the License. You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing,
~ software distributed under the License is distributed on an
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~ KIND, either express or implied. See the License for the
~ specific language governing permissions and limitations
~ under the License. --><html>
<h1>Code Listing For Axis2SampleDocLitService Service</h1>
<div class="section"><h2>Server:<a name="Server:"></a></h2>
<div class="section"><h3>echoString<a name="echoString"></a></h3>
<p>Locate the following code segment in &quot;Axis2SampleDocLitServiceSkeleton.java&quot;.<br />
</p>
<div class="source"><pre><div><pre>public org.apache.axis2.userguide.xsd.EchoStringReturnDocument
echoString(org.apache.axis2.userguide.xsd.EchoStringParamDocument param4 ){
//Todo: fill this with the necessary business logic
throw new java.lang.UnsupportedOperationException();
}
</pre></div></pre></div>
<p>Then complete the code by adding the business logic as shown below:</p>
<div class="source"><pre>
<div><pre>public org.apache.axis2.userguide.xsd.EchoStringReturnDocument
echoString(org.apache.axis2.userguide.xsd.EchoStringParamDocument param4) throws Exception {
//Use the factory to create the output document
org.apache.axis2.userguide.xsd.EchoStringReturnDocument retDoc =
org.apache.axis2.userguide.xsd.EchoStringReturnDocument.Factory.newInstance();
//send the string back.
retDoc.setEchoStringReturn(param4.getEchoStringParam());
return retDoc;
}</pre></div>
</pre></div>
</div><div class="section"><h3>echoStringArray<a name="echoStringArray"></a></h3>
<p>The code segment for echoStringArray is shown below:</p>
<div class="source"><pre>
<div><pre>public org.apache.axis2.userguide.xsd.EchoStringArrayReturnDocument
echoStringArray(org.apache.axis2.userguide.xsd.EchoStringArrayParamDocument param0) throws Exception {
//Use the factory to create the output document.
org.apache.axis2.userguide.xsd.EchoStringArrayReturnDocument retDoc =
org.apache.axis2.userguide.xsd.EchoStringArrayReturnDocument.Factory.newInstance();
//Get the String array from the input parameters.
String[] inParams = param0.getEchoStringArrayParam().getStringArray();
org.apache.axis2.userguide.xsd.ArrayOfstringLiteral retParams =
org.apache.axis2.userguide.xsd.ArrayOfstringLiteral.Factory.newInstance();
//Set the input parameters to the output parameters for echoing.
for (int i = 0; i &lt; inParams.length; i++) {
retParams.addString(inParams[i]); }
//return the output document.
retDoc.setEchoStringArrayReturn(retParams);
return retDoc;
}</pre></div>
</pre></div>
</div><div class="section"><h3>echoStruct<a name="echoStruct"></a></h3>
<p>The code segment for echoStruct is shown below:</p>
<div class="source"><pre><div><pre>
public org.apache.axis2.userguide.xsd.EchoStructReturnDocument
echoStruct(org.apache.axis2.userguide.xsd.EchoStructParamDocument param2) throws Exception {
//Use the factory to create the output document.
org.apache.axis2.userguide.xsd.EchoStructReturnDocument retDoc =
org.apache.axis2.userguide.xsd.EchoStructReturnDocument.Factory.newInstance();
//Get the SOAPStrcut from the incoming parameters
org.apache.axis2.userguide.xsd.SOAPStruct inStruct = param2.getEchoStructParam();
//Struct for the sending back
org.apache.axis2.userguide.xsd.SOAPStruct outStruct =
org.apache.axis2.userguide.xsd.SOAPStruct.Factory.newInstance();
//Fill the outgoing struct
outStruct.setVarFloat(inStruct.getVarFloat());
outStruct.setVarInt(inStruct.getVarInt());
outStruct.setVarString(inStruct.getVarString());
//Set the outgoing document.
retDoc.setEchoStructReturn(outStruct);
return retDoc;
}
</pre></div></pre></div>
</div><div class="section"><h2>Client:<a name="Client:"></a></h2>
<div class="section"><h3>Client for echoString Operation<a name="Client_for_echoString_Operation"></a></h3>
<p>The following code fragment shows the necessary code for utilizing the
echoString operation of the Axis2SampleDocLitService that we have already
deployed. The code is very simple to understand and the explanations are in
the form of comments.</p>
<div class="source"><pre><div><pre> try {
org.apache.axis2.userguide.Axis2SampleDocLitServiceStub stub
= new org.apache.axis2.userguide.Axis2SampleDocLitServiceStub(null,
&quot;http://localhost:8080/axis2/services/Axis2SampleDocLitService&quot;);
//Create the request document to be sent.
org.apache.axis2.userguide.xsd.EchoStringParamDocument reqDoc =
org.apache.axis2.userguide.xsd.EchoStringParamDocument.Factory.newInstance();
reqDoc.setEchoStringParam(&quot;Axis2 Echo&quot;);
//invokes the Web service.
org.apache.axis2.userguide.xsd.EchoStringReturnDocument resDoc =
stub.echoString(reqDoc);
System.out.println(resDoc.getEchoStringReturn());
} catch (java.rmi.RemoteException e) {
e.printStackTrace();
}
</pre></div></pre></div>
<p>Similarly the following code fragments show client side code for
echoStringArray operation and echoStruct operation respectively.</p>
</div><div class="section"><h3>Client for echoStringArray Operation<a name="Client_for_echoStringArray_Operation"></a></h3>
<div class="source"><pre><div><pre> try {
//Create the stub by passing the AXIS_HOME and target EPR.
//We pass null to the AXIS_HOME and hence the stub will use the current directory as the AXIS_HOME
org.apache.axis2.userguide.Axis2SampleDocLitServiceStub stub =
new org.apache.axis2.userguide.Axis2SampleDocLitServiceStub(null,
&quot;http://localhost:8080/axis2/services/Axis2SampleDocLitService&quot;);
//Create the request document to be sent.
org.apache.axis2.userguide.xsd.EchoStringArrayParamDocument reqDoc =
org.apache.axis2.userguide.xsd.EchoStringArrayParamDocument.Factory.newInstance();
org.apache.axis2.userguide.xsd.ArrayOfstringLiteral paramArray =
org.apache.axis2.userguide.xsd.ArrayOfstringLiteral.Factory.newInstance();
paramArray.addString(&quot;Axis2&quot;);
paramArray.addString(&quot;Echo&quot;);
reqDoc.setEchoStringArrayParam(paramArray);
org.apache.axis2.userguide.xsd.EchoStringArrayReturnDocument resDoc =
stub.echoStringArray(reqDoc);
//Get the response params
String[] resParams = resDoc.getEchoStringArrayReturn().getStringArray();
for (int i = 0; i &lt; resParams.length; i++) {
System.out.println(resParams[i]);
}
} catch (java.rmi.RemoteException e) {
e.printStackTrace();
}
</pre></div>
</pre></div>
</div><div class="section"><h3>Client for echoStruct Operation<a name="Client_for_echoStruct_Operation"></a></h3>
<div class="source"><pre><div><pre>try {
//Create the stub by passing the AXIS_HOME and target EPR.
//We pass null to the AXIS_HOME and hence the stub will use the current directory as the AXIS_HOME
org.apache.axis2.userguide.Axis2SampleDocLitServiceStub stub =
new org.apache.axis2.userguide.Axis2SampleDocLitServiceStub(null,
&quot;http://localhost:8080/axis2/services/Axis2SampleDocLitService&quot;);
//Create the request Document
org.apache.axis2.userguide.xsd.EchoStructParamDocument reqDoc =
org.apache.axis2.userguide.xsd.EchoStructParamDocument.Factory.newInstance();
//Create the complex type
org.apache.axis2.userguide.xsd.SOAPStruct reqStruct =
org.apache.axis2.userguide.xsd.SOAPStruct.Factory.newInstance();
reqStruct.setVarFloat(100.50F);
reqStruct.setVarInt(10);
reqStruct.setVarString(&quot;High&quot;);
reqDoc.setEchoStructParam(reqStruct);
//Service invocation
org.apache.axis2.userguide.xsd.EchoStructReturnDocument resDoc =
stub.echoStruct(reqDoc);
org.apache.axis2.userguide.xsd.SOAPStruct resStruct =
resDoc.getEchoStructReturn();
System.out.println(&quot;floot Value :&quot; + resStruct.getVarFloat());
System.out.println(&quot;int Value :&quot; + resStruct.getVarInt());
System.out.println(&quot;String Value :&quot; + resStruct.getVarString());
} catch (java.rmi.RemoteException e) {
e.printStackTrace();
}
</pre></div></pre></div>
</div>
</html>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">
Copyright &#169; 2004-2015
<a href="http://www.apache.org/">The Apache Software Foundation</a>.
All Rights Reserved.
</div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>