You are viewing a plain text version of this content. The canonical link for it is here.
Posted to axis-cvs@ws.apache.org by ch...@apache.org on 2006/01/03 16:26:34 UTC
svn commit: r365662 [2/3] - in /webservices/axis2/trunk/java/xdocs:
installationguide.html userguide.html webadminguide.html
Modified: webservices/axis2/trunk/java/xdocs/userguide.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/xdocs/userguide.html?rev=365662&r1=365661&r2=365662&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/userguide.html (original)
+++ webservices/axis2/trunk/java/xdocs/userguide.html Tue Jan 3 07:26:23 2006
@@ -2,193 +2,345 @@
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=windows-1252">
- <title>Axis 2.0 User's Guide</title>
+ <title>Axis2 User's Guide</title>
<meta name="CREATED" content="20050918;20224042">
<meta name="CHANGEDBY" content="Chamikara Jayalath">
<meta name="CHANGED" content="20050919;1140420">
</head>
<body lang="en-US" dir="ltr">
-<h1 align="center"><a name="_Toc96697849"></a>Axis 2.0 User's Guide</h1>
+<h1 align="center"><a name="_Toc96697849" id="_Toc96697849"></a>Axis2 User's
+Guide</h1>
+
+<p><i>Version 0.94</i></p>
+<i>User Feedback: <a
+href="mailto:axis-user@ws.apache.org">axis-user@ws.apache.org</a></i>
<h2>Contents</h2>
<ul>
<li><p><a href="#Introduction">Introduction</a></p>
+ <ul>
+ <li><a href="#Attention">Attention</a></li>
+ <li><a href="#What_is_Axis_2_0__">What is Axis2?</a></li>
+ <li><a href="#Featurelist">Axis2 Complete Features List</a>
+ <ul>
+ <li><a href="#experimental">Experimental Features List</a></li>
+ <li><a href="#majorchanges">Major Changes Since Last
+ Release</a></li>
+ </ul>
+ </li>
+ <li><a href="#toolsinrelease">Tools included in this Release</a></li>
+ <li><a href="#WhatsStillToDo">What's still to do?</a></li>
+ </ul>
+ </li>
+ <li><p><a href="#samples">Samples</a></p>
+ </li>
+ <li><p><a href="#WS">Web Services Using Axis2</a></p>
+ <ul>
+ <li><a href="#WSapi">Writing Web Services using Axis2 APIs</a>
+ <ul>
+ <li><a href="#CreateWS">Creating Web Service (MyService)</a></li>
+ <li><a href="#WriteWS">How to write the Web Service?</a>
+ <ul>
+ <li><a href="#step1">Step1 :Write the Implementation
+ Class</a></li>
+ <li><a href="#step2">Step2 :Write the services.xml file</a></li>
+ <li><a href="#step3">Step3 :Create the Web Service
+ Archive</a></li>
+ <li><a href="#step4">Step4 :Deploy the Web Service</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li><p><a href="#generateskl">Writing Web Services by Code Generating
+ Skeleton</a></p>
+ <ul>
+ <li><a href="#WSDL2JavaTool">WSDL2Java Tool</a></li>
+ <li><a href="#businesslogic">Implement the Business Logic</a></li>
+ <li><a href="#echostring">echoString</a></li>
+ <li><a href="#echostringarray">echoStringArray</a></li>
+ <li><a href="#echostruct">echoStruct</a></li>
+ <li><a href="#servicesxml">services.xml</a></li>
+ <li><a href="#packaging">Packaging</a></li>
+ </ul>
+ </li>
+ </ul>
</li>
- <li><p><a href="#What_is_Axis_2_0__">What is Axis 2.0 ?</a></p>
- </li>
- <li><p><a href="#Web_Services_Using_Axis2">Web Services Using Axis2</a></p>
- </li>
- <li><p><a href="#Web_Service_Clients_Using_Axis2">Web Service Clients Using Axis2</a></p>
+</ul>
+<ul>
+ <li><p><a href="#Web_Service_Clients_Using_Axis2">Web Service Clients Using
+ Axis2</a></p>
+ <ul>
+ <li><a href="#primaryAPIs">Writing Web Service Clients using Axis2's
+ Primary APIs</a>
+ <ul>
+ <li><a href="#echoblocking">EchoBlockingClient</a></li>
+ <li><a href="#ping">PingClient</a></li>
+ <li><a href="#echononblocking">EchoNonBlockingClient</a></li>
+ <li><a
+ href="#echononblockingdual">EchoNonBlockingDualClient</a></li>
+ <li><a href="#echoblockingdual">EchoBlockingDualClient</a></li>
+ </ul>
+ </li>
+ <li><p><a href="#databinding">Writing Web Service Clients using Code
+ Generation</a></p>
+ <ul>
+ <li><a href="#echovoid">Client for echoVoid Operation</a></li>
+ <li><a href="#clientechostring">Client for echoString
+ Operation</a></li>
+ <li><a href="#clientechostringarray">Cient for
+ echoStringArray</a></li>
+ <li><a href="#clientechostruct">Client for echoStruct
+ Operation</a></li>
+ </ul>
+ </li>
+ </ul>
</li>
<li><p><a href="#Modules">Modules</a></p>
+ <ul>
+ <li><a href="#logging">MyService with a Logging Module</a>
+ <ul>
+ <li><a href="#step1loggingmodule">Step1 : LoggingModule
+ Class</a></li>
+ <li><a href="#step2loggingmodule">Step2 : LogHandler</a></li>
+ <li><a href="#step3loggingmodule">Step3 : module.xml</a></li>
+ <li><a href="#step4loggingmodule">Step 4: Modify the
+ "axis2.xml"</a></li>
+ <li><a href="#step5loggingmodule">Step5 : Modify the
+ "services.xml"</a></li>
+ <li><a href="#step6loggingmodule">Step6 : Packaging</a></li>
+ <li><a href="#step7loggingmodule">Step7 : Deploy the Module in
+ Axis2</a></li>
+ </ul>
+ </li>
+ </ul>
</li>
<li><p><a href="#Other_Samples">Other Samples</a></p>
- </li>
- <li><p><a href="#Tools">Tools</a></p>
+ <ul>
+ <li><a href="#googlespell">Google Spell Checker Sample</a></li>
+ <li><a href="#googlesearch">Google Search Sample</a></li>
+ <li><a href="#amazonqueuing">Amazon Queuing Service</a></li>
+ </ul>
</li>
<li><p><a href="#Advanced_Topics">Advanced Topics</a></p>
+ <ul>
+ <li><a href="rest-ws.html">RESTful Web Services</a></li>
+ <li><a href="tcp-transport.html">TCP transport</a></li>
+ <li><a href="mail-transport.html">Mail Transport</a></li>
+ <li><a href="http-transport.html">HTTP Transports</a></li>
+ <li><a href="mtom-guide.html">MTOM with Axis2</a></li>
+ <li><a href="security-module.html">Securing SOAP Messages with
+ WSS4J</a></li>
+ </ul>
</li>
</ul>
-<p><br>
-<br>
-</p>
-
<h2><a name="_Toc96698076"></a><a name="Introduction"></a>Introduction</h2>
-<p>Welcome to Axis 2.0, the next generation of Apache Axis !!! This User
-Guide will help you to understand what you will get from Axis 2.0 and how to
-get started. We hope you will benefit from the power of Axis 2.0.</p>
+<p>Welcome to Axis2, the next generation of Apache Axis!!! This User's Guide
+will help you to understand what Axis2 has to offer and how to get started
+with it. We hope you will benefit from the power of Axis2.</p>
-<h2>Attention</h2>
+<h3><a name="Attention"></a>Attention</h3>
<ul>
- <li><p style="margin-bottom: 0in">This User Guide is written based on the
- Axis2 binary distribution, the Binary distribution can be created from
- the source distribution using the maven goal <code>$maven
- dist-bin</code></p>
- </li>
- <li><p>Before we start, its highly recommended to read <a
- href="http://ws.apache.org/axis/java/user-guide.html">Axis 1.x User's
- guide </a>, if you are new to Axis.</p>
+ <li><p style="margin-bottom: 0in">This User's Guide is written based on
+ <em>Axis2 binary distribution</em>. (The binary distribution can also be
+ created from the source distribution using the maven goal <code>$maven
+ dist-bin)</code></p>
+ </li>
+ <li><p>If you are new to Axis, it's highly recommended that you read <a
+ href="http://ws.apache.org/axis/java/user-guide.html"
+ target="_blank">Axis 1.x User's Guide</a> before you go any further in
+ this guide.</p>
</li>
</ul>
-<h2><a name="_Toc96698077"></a><a name="What_is_Axis_2_0__"></a>What is Axis 2.0 ?</h2>
+<h3><a name="_Toc96698077"></a><a name="What_is_Axis_2_0__"></a>What is
+Axis2?</h3>
-<p>Axis 2.0 is the next generation of Apache Axis. In late August 2004,
-during the Axis Summit held in Colombo, Sri Lanka, a new architecture was
-introduced to have a much more flexible, efficient and configurable Axis.
-Even though the architecture is new, some of the well established concepts
-from Axis 1.x, like handlers are preserved in Axis 2.0 also. Axis 2.0 comes
-with lots of new features, enhancements and new industry specification
-implementations.</p>
+<p>Axis2 is the next generation of Apache Axis. In late August 2004, during
+the Axis2 Summit held in Colombo, Sri Lanka, a new architecture for Axis was
+introduced which was much more flexible, efficient and configurable. Although
+the architecture is new, some of the well established concepts from Axis 1.x
+like handlers are preserved in Axis2. Axis2 comes with many new features,
+enhancements and industry specification implementations.</p>
-<p>After months of continued discussion and coding effort in this direction,
-Axis 2.0 now delivers the following key features:</p>
+<p>After months of continued discussion and coding in this direction, Axis2
+now delivers the following key features:</p>
<ul>
- <li><p style="margin-bottom: 0in"><strong>Speed</strong>. Axis uses its own
- object model and StAX (streaming) parsing to achieve significantly
- greater speed than earlier versions of Apache AXIS.</p>
- </li>
- <li><p style="margin-bottom: 0in"><strong>Low memory foot print</strong>.
- Axis 2.0 was designed ground-up keeping low memory foot print in mind.</p>
- </li>
- <li><p style="margin-bottom: 0in"><strong>AXIOM</strong>. Axis 2.0 comes
- with its own light-weight object model, AXIOM, for message processing
- which is extensible, high performance and developer convenient</p>
- </li>
- <li><p style="margin-bottom: 0in"><strong>Hot Deployment.</strong> One can
- now hot deploy web services and handlers.</p>
+ <li><p style="margin-bottom: 0in"><strong>Speed</strong>- Axis2 uses its
+ own object model and StAX (Streaming API for XML) parsing to achieve
+ significantly greater speed than earlier versions of Apache Axis.</p>
+ </li>
+ <li><p style="margin-bottom: 0in"><strong>Low memory foot print</strong>-
+ Axis2 was designed ground-up keeping low memory foot print in mind.</p>
+ </li>
+ <li><p style="margin-bottom: 0in"><strong>AXIOM</strong>- Axis2 comes with
+ its own light-weight object model, AXIOM, for message processing which is
+ extensible, high performance and developer convenient</p>
+ </li>
+ <li><p style="margin-bottom: 0in"><strong><a name="hotdeployment">Hot
+ Deployment</a>-</strong> Axis2 is equipped with the capability of
+ deploying web service & handlers while system is up and running. In
+ other words, new services can be added to the system without having to
+ shut down server.Drop the required Web service archive into the services
+ directory in the repository and deployment model will automatically
+ deploy the service and make it available for use.</p>
</li>
<li><p style="margin-bottom: 0in"><strong>Asynchronous Web
- Services</strong>. Axis 2.0 now support asynchronous web services
- invocation and asynchronous web services.</p>
- </li>
- <li><p style="margin-bottom: 0in"><strong>MEP Support. </strong>Axis 2.0
- now comes handy with support for Message Exchange Patterns.</p>
+ Services</strong>- Axis2 now supports asynchronous web services &
+ asynchronous web services invocation using non-blocking clients and
+ transports .</p>
+ </li>
+ <li><p style="margin-bottom: 0in"><strong>MEP Support-</strong> Axis2 now
+ comes handy with the flexibility to support Message Exchange Patterns
+ (MEPs) with in-built support for basic MEPs defined in WSDL 2.0.</p>
</li>
- <li><p style="margin-bottom: 0in"><strong>Flexibility</strong>. The Axis
+ <li><p style="margin-bottom: 0in"><strong>Flexibility</strong>- The Axis2
architecture gives the developer complete freedom to insert extensions
into the engine for custom header processing, system management, or
- anything else you can imagine.</p>
+ <em>anything else you can imagine</em>.</p>
</li>
- <li><p style="margin-bottom: 0in"><strong>Stability</strong>. Axis defines
+ <li><p style="margin-bottom: 0in"><strong>Stability</strong>- Axis2 defines
a set of published interfaces which change relatively slowly compared to
the rest of Axis.</p>
</li>
<li><p style="margin-bottom: 0in"><strong>Component-oriented
- deployment</strong>. You can easily define reusable networks of Handlers
+ Deployment</strong>- You can easily define reusable networks of Handlers
to implement common patterns of processing for your applications, or to
distribute to partners.</p>
</li>
- <li><p style="margin-bottom: 0in"><strong>Transport framework</strong>. We
- have a clean and simple abstraction for designing transports (i.e.,
- senders and listeners for SOAP over various protocols such as SMTP, FTP,
- message-oriented middleware, etc), and the core of the engine is
- completely transport-independent.</p>
- </li>
- <li><p><strong>WSDL support.</strong> Axis 2.0 supports the <a
- href="http://www.w3.org/TR/wsdl">Web Service Description Language </a>,
- version 1.1 and 2.0, which allows you to easily build stubs to access
- remote services, and also to automatically export machine-readable
- descriptions of your deployed services from Axis.</p>
+ <li><p style="margin-bottom: 0in"><strong>Transport Framework</strong>- We
+ have a clean and simple abstraction for integrating and using Transports
+ (i.e., senders and listeners for SOAP over various protocols such as
+ SMTP, FTP, message-oriented middleware, etc), and the core of the engine
+ is completely transport-independent.</p>
+ </li>
+ <li><p style="margin-bottom: 0in"><strong>WSDL support-</strong> Axis2
+ supports the <a href="http://www.w3.org/TR/wsdl" target="_blank">Web
+ Service Description Language</a>, version 1.1 and 2.0, which allows you
+ to easily build stubs to access remote services, and also to
+ automatically export machine-readable descriptions of your deployed
+ services from Axis2.</p>
+ </li>
+ <li><p style="margin-bottom: 0in"><strong>Add-ons </strong> Several web
+ services have been incorporated including <a
+ href="http://ws.apache.org/wss4j/" target="_blank">WSS4J</a> for
+ security, <a href="http://ws.apache.org/sandesha/"
+ target="_blank">Sandesha</a> for reliable messaging, <a
+ href="http://ws.apache.org/kandula/" target="_blank">Kandula</a> which is
+ an encapsulation of WS- coordination, Atomic Transaction and Business
+ Activity.</p>
+ </li>
+ <li><p style="margin-bottom: 0in"><strong>Composition and Extensibility
+ -</strong> modules and phases improve support for composability and
+ extensibility. Modules supports composability and is able to add support
+ for new WS-* specifications in a simple and clean manner. They are
+ however not <a href="#hotdeployment">hot deployable</a> as they change
+ the overall behavior of the system.</p>
</li>
</ul>
-<p>We hope you enjoy using Axis. Please note that this is an open-source
-effort - if you feel the code could use some new features or fixes, please
-get involved and lend a hand! The Axis developer community welcomes your
-participation .</p>
+<p>We hope you enjoy using Axis2. Please note that this is an open-source
+effort. If you feel the code could use some new features or fixes, please get
+involved and lend a hand! The Axis developer community welcomes your
+participation.</p>
<p>Let us know what you think!</p>
-<p>Please send feedback about the package to " <a
-href="mailto:axis-user@ws.apache.org">axis-user@ws.apache.org </a>" and make
+<p>Please send your feedback on Axis2 to "<a
+href="mailto:axis-user@ws.apache.org">axis-user@ws.apache.org</a>" and make
sure to prefix the subject of the mail with [Axis2].</p>
-<h2><a name="_Toc96698078"></a>What's in this release?</h2>
-
-<p>This release includes the following features:</p>
+<h3><a name="_Toc96698078"></a><a name="Featurelist"></a>Axis2 Complete
+Features List</h3>
+This release includes the following features:
<ul>
- <li><p style="margin-bottom: 0in">AXIOM, a SOAP specific streaming XML
- infoset model for SOAP 1.1/1.2 Messages</p>
+ <li><style="margin-bottom: 0in">AXIOM, an XML object model working on StAX
+ (Streaming API for XML) parsing optimized for SOAP 1.1/1.2 Messages. This
+ has complete XML infoset support.</li>
+ <li><p style="margin-bottom: 0in">Support for One-Way Messaging (In-Only)
+ and Request Response Messaging (In-Out)</p>
</li>
- <li>Complete XML infoset support for AXIOM</li>
- <li><p style="margin-bottom: 0in">Support for One-Way Messaging and Request
- Response Messaging</p>
+ <li><p style="margin-bottom: 0in">Module Architecture, mechanism to extend
+ the SOAP Processing Model</p>
</li>
- <li><p style="margin-bottom: 0in">Modules, mechanism to extend the SOAP
- Processing Model</p>
+ <li><p style="margin-bottom: 0in">Content hierarchy</p>
</li>
- <li><p style="margin-bottom: 0in">Archives based deployment Model</p>
+ <li><p style="margin-bottom: 0in">Archive based deployment Model</p>
</li>
<li><p style="margin-bottom: 0in">WSDL Code Generation Tool for Stub and
skeletons</p>
</li>
- <li><p style="margin-bottom: 0in">XML Beans based data binding support</p>
+ <li><p style="margin-bottom: 0in">WS-Addressing, both the submission
+ (2004/08) and final (2005/08) versions</p>
+ </li>
+ <li><p style="margin-bottom: 0in">WSS4J module for security</p>
</li>
- <li><p style="margin-bottom: 0in">Support for WS-Addressing, both the
- submission and final versions</p>
+ <li><p style="margin-bottom: 0in">Improved and user friendly Client API</p>
</li>
- <li><p style="margin-bottom: 0in">Client API</p>
+ <li><p style="margin-bottom: 0in">WSDL2Java and Java2WSDL</p>
</li>
<li><p style="margin-bottom: 0in">REST Web Service Support</p>
</li>
- <li><p style="margin-bottom: 0in">HTTP transport Support</p>
+ <li><p style="margin-bottom: 0in">Transports supports: HTTP, SMTP, TCP,
+ JMS</p>
+ </li>
+ <li><p style="margin-bottom: 0in">Raw XML providers</p>
</li>
- <li><p style="margin-bottom: 0in">SMTP transport Support</p>
+ <li><p style="margin-bottom: 0in">Support for MTOM/ MIME/ SwA</p>
</li>
- <li><p style="margin-bottom: 0in">TCP transport Support</p>
+ <li><p style="margin-bottom: 0in">SAAJ implementation</p>
</li>
- <li><p style="margin-bottom: 0in">MTOM/SWA attachments support</p>
+ <li><p style="margin-bottom: 0in">DOOM <sup><span
+ style="color: #FF0000; background-color: #FFFFFF">new</span></sup></p>
</li>
- <li><p>SAAJ implementation</p>
+ <li><p style="margin-bottom: 0in">Wrap/Unwrap capability for the generated
+ code <sup><span
+ style="color: #FF0000; background-color: #FFFFFF">new</span></sup></p>
</li>
</ul>
-<p>The release include following tools</p>
-<ol>
- <li><p style="margin-bottom: 0in">Admin Web App</p>
+<h4><a name="experimental">Experimental Features List</a></h4>
+<ul>
+ <li><style="margin-bottom: 0in">Sessions scoping for Application, SOAP,
+ Transport and Request levels</li>
+ <li><p style="margin-bottom: 0in">Web Service Policy Support</p>
</li>
+</ul>
+
+<h4><a name="majorchanges">Major Changes Since Last Release</a></h4>
+<ul>
+ <li>Fixing of memory leaks</li>
+</ul>
+
+<h3><a name="toolsinrelease">Tools included in this Release</a></h3>
+<ol>
+ <li><style="margin-bottom: 0in">Axis2 Web Appplication (Web App)</li>
<li><p style="margin-bottom: 0in">WSDL2WS, eclipse Plugin/Command line
version</p>
</li>
<li><p style="margin-bottom: 0in">Service Archive Wizard, eclipse Plugin</p>
</li>
- <li><p>Module Archive Wizard, eclipse Plugin</p>
+ <li><p style="margin-bottom: 0in">Module Archive Wizard, eclipse Plugin</p>
</li>
+
+ <p>Axis2 is shipped with two standard tools. Both the tools are Eclipse
+ plug-ins, the Codegen tool even has the accompanying Ant task and the
+ command line tool.Documentation for the code generator tool is available
+ for the <a href="CodegenToolReference.html" target="_blank">Codegen
+ wizard</a> and the <a href="ServiceArchiveToolReference.html"
+ target="_blank">Service Archiver</a>.</p>
</ol>
-<h2><a name="_Toc96698079"></a>What's still to do?</h2>
+<h3><a name="_Toc96698079"></a><a name="WhatsStillToDo"></a>What's still to
+do?</h3>
<p>Please see a list of what we think needs doing - and please consider
helping out if you're interested & able!</p>
<ul>
<li><p style="margin-bottom: 0in">JAX-RPC 1.1 and/or JAX-WS compliance</p>
</li>
- <li><p style="margin-bottom: 0in">Pluggable Data binding support</p>
- </li>
<li><p style="margin-bottom: 0in">SOAP Encoding</p>
</li>
<li><p style="margin-bottom: 0in">Binary serialization and de-serialization
@@ -196,68 +348,41 @@
</li>
<li><p style="margin-bottom: 0in">Management Interface for Axis2</p>
</li>
- <li><p style="margin-bottom: 0in">Implementation of other transports. e.g.
- JMS..</p>
+ <li><p style="margin-bottom: 0in">Implementation of other Transports.</p>
</li>
- <li><p>Web Service Policy Support</p>
+ <li><p style="margin-bottom: 0in">Resource framework implementation (WS-RF)
+ and Enterprise web services such as JSR 109 support</p>
+ </li>
+ <li><p style="margin-bottom: 0in">Interop tests</p>
</li>
</ul>
-<h2><a name="_Toc96697863"></a><!-- Image goes here -->
-<!--<h3><a name="_Toc96698087"></a>Running the Axis2 standalone server </h3>
-<p>Since a J2EE servlet container can be heavy in certain cases, a simple socket server is provided with Axis2. </p>
-Start scripts are inluded in the bin directory of the binary distribution.</p>
-<p>For windows</p>
-<p class="command">>start.bat </p>
-<p>For Linux</p>
-<p class="command">$start.sh</p>
-<p>This will start the simple axis server in the default port (8080). To start the server in a non default port
-the server script can be used. The sever script however needs two parameters, the repository location and the port.</p>
-
-<p>For windows</p>
-<p class="command">>server <i>repository directory</i> <i>port</i> </p>
-<p>For Linux</p>
-<p class="command">$server <i>repository directory</i> <i>port</i> </p>
-
-<p><b>
-Note - the directory entered as the repository location needs to have a services directory inside. This is
-absolutely required and AXIS will not create it automatically in the case of the simple axis server.
-</b></p> -->
-Samples</h2>
-
-<p>In this section of the user guide we will look at how to write and deploy
-Web Services and how to write Web Service Clients using Axis2. All the user
-guide samples are located at the <b><font
-color="#000000">"samples/userguide/src"</font></b> directory of the binary
-distribution. So.. let's explore the samples.</p>
+<h2><a name="samples">Samples</a></h2>
-<p>Note: Please note that the rest of this user guide assumes that the user
-has downloaded the binary distribution of Axis2. If you have already
-downloaded the source tree of Axis2 then please create the binary
-distribution by simply using the maven command <strong>maven dist-bin
-</strong>This will create the "axis2-0.91-bin.zip" and "axis2-0.91-bin.tar"
-in the "target/dist" directory. Extract the zip or the tar ball to any
-directory in your machine and for the explanations purposes we will name this
-directory as "Axis2Home".</p>
+<p>In the following sections of the user's guide we will look at how to write
+and deploy Web Services and how to write Web Service Clients using Axis2. All
+the user's guide samples are located at the <b><font
+color="#000000">"samples/userguide/src"</font></b> directory of the binary
+distribution. So... let's explore the samples.</p>
-<h2><a name="Web_Services_Using_Axis2"></a>Web Services Using Axis2</h2>
+<h2><a name="WS">Web Services Using Axis2</a></h2>
<p>Before starting, please check whether you have deployed the "axis2.war" in
your servlet container and it is working properly. (See <a
-href="installationguide.html">Installation Guide</a>). User can select any of
-the following two ways of writing web services using Axis2. </p>
-<ul>
- <li><p style="margin-bottom: 0in">Use Axis2's primary interfaces and
- implement the business logic.</p>
- </li>
- <li><p>Start from the WSDL ->Code generate the Skeleton ->Implement
- the Business Logic.</p>
+href="installationguide.html" target="_blank">Installation Guide</a>). User
+can select any of the following two ways of writing web services using
+Axis2. </p>
+<ol>
+ <li><a href="#WSapi"><style="margin-bottom: 0in">Use Axis2's primary
+ interfaces (APIs) and implement the business logic.</a></li>
+ <li><p><a href="#generateskl">Start from the WSDL ->Code generate the
+ Skeleton ->Implement the Business Logic.</a></p>
</li>
-</ul>
+</ol>
-<h3>Write My Service using Axis2</h3>
+<h3><a name="WSapi">Writing Web Services Using Axis2's Primary APIs</a></h3>
-<h4>MyService</h4>
+<h4><a name="CreateWS">Creating Web Service (MyService)</a></h4>
<p>First let's see how we can write a simple Web Service (MyService) using
Axis2's primary interfaces and deploy it. For this purpose we will create a
@@ -269,26 +394,25 @@
<p>Complete code for this example Web Service (MyService) can be found in the
"Axis2Home/samples/userguide/src" directory under "userguide/example1"
package. As you can see, the two operations are very simple and need no
-explanations on what they are doing. So let's see how we can write the
-deployment descriptors for the service and deploy it.</p>
-
-<h4>How to write the Web Service?</h4>
+explanations on what they do. Now let's see how we can write the deployment
+descriptors for the service and deploy it.</p>
-<p>Write a new Web Service with Axis2 involve four steps</p>
+<h4><a name="WriteWS">How to write the Web Service?</a></h4>
+Writing a new Web Service with Axis2 involve four steps:
<ol>
<li><p style="margin-bottom: 0in">Write the Implementation Class</p>
</li>
<li><p style="margin-bottom: 0in">Write a services.xml file to explain the
Web Service</p>
</li>
- <li><p style="margin-bottom: 0in">create a *.aar archive for the Web
- Service</p>
+ <li><p style="margin-bottom: 0in">create a *.aar archive (Axis Archive) for
+ the Web Service</p>
</li>
<li><p>Deploy the Web Service</p>
</li>
</ol>
-<h4>Step1 :Write the Implementation Class</h4>
+<h4><a name="step1">Step1 :Write the Implementation Class</a></h4>
<p>Provides a implementation class that provide the business logic for the
Web Service, it should have methods that match the operations in the Web
@@ -303,12 +427,11 @@
}
}</pre>
-<h4>Step2 :Write the services.xml file</h4>
+<h4><a name="step2">Step2 :Write the services.xml file</a></h4>
<p>Axis2 uses "services.xml" to keep configurations for a Web Service. Each
Web Service deployed in Axis2 needs a "services.xml" containing the
-configurations. "services.xml" for MyService will be as follows; we will see
-what each parameter means later.</p>
+configurations. "services.xml" for MyService will be as follows.</p>
<pre><service name="MyService">
<description>
This is a sample Web Service with two operations, echo and ping.
@@ -322,20 +445,24 @@
</operation>
</service></pre>
+<p><em>The above XML tags can be explained as follows:</em></p>
+
<p>As it can be seen, first line of the "services.xml" gives the name of the
-Web Service. This is used in the URL to the service as the service name. Next
-comes the description and the service class. The next two xml tags describe
-the operations that are available in this service with respective message
-receivers. For the "echo" operation we have used a
-<strong>RawXMLINOutMessageReceiver</strong> since it is an IN-OUT operation.
-For IN-ONLY operation, "ping" we have used
+Web Service. This is used in the URL to the service as the service name.</p>
+
+<p>Next comes the description and the service class.</p>
+
+<p>The next two xml tags describe the operations that are available in this
+service with respective message receivers. For the "echo" operation we have
+used a <strong>RawXMLINOutMessageReceiver</strong> since it is an IN-OUT
+operation. For IN-ONLY operation "ping", we have used
<strong>RawXMLINOnlyMessageReceiver</strong> as the message receiver.</p>
<p>You can write a services.xml file to include a group of services instead
of a single service. This makes management and deployment of a set of related
services very easy. At runtime you can share information between these
-services within a single interaction, using the ServiceGroupContext. If you
-hope to use this functionality the services.xml file should have following
+services within a single interaction using the ServiceGroupContext. If you
+hope to use this functionality, the services.xml file should have following
format.</p>
<pre><serviceGroup>
<service name="Service1">
@@ -348,10 +475,10 @@
<parameter name="serviceGroupParam1" locked="false">value 1</parameter>
</serviceGroup></pre>
-<h4>Step3 :Create the Web Service Archive</h4>
+<h4><a name="step3">Step3 :Create the Web Service Archive</a></h4>
<p>Axis2 use ".aar" (Axis Archive) file as the deployment package for Web
-Services. So, for MyService we will use "MyService.aar" with the
+Services. Therefore, for MyService we will use "MyService.aar" with the
"services.xml" packaged in the META-INF as shown in the following picture.</p>
<p><img src="images/userguide/ServiceItems.jpg" name="Graphic1"
@@ -360,35 +487,38 @@
<p>To create "MyService.aar" user can first create a jar file containing all
the files necessary for the service and then rename the "jar" to "aar" so
that Axis2 understands it as a service archive. This has already been created
-in the "Axis2Home/samples/userguide" directory, and let's use it..</p>
+in the "Axis2Home/samples/userguide" directory. Now let's use it...</p>
-<h4>Step4 :Depoly the Web Service</h4>
+<h4><a name="step4">Step4 :Deploy the Web Service</a></h4>
<p>Deploying the service is just a matter of dropping the ".aar" in to
"services" directory that can be found in the "\webapps\axis2\WEB-INF" of
-your servlet container and hence please copy the "MyService.aar" into the
-"<b>services</b>" directory. Once these steps are completed, please start the
-servlet container (if you have not already started) and check the link "List
-Available services" in the page http://localhost:8080/axis2/index.jsp and see
-whether the MyService is deployed properly. If everything is ok, you will see
-the following out put..</p>
+your servlet container, hence copy the "MyService.aar" into the
+"<b>services</b>" directory. Once these steps are completed, start the
+servlet container (if you have not already started) and check the link
+"Services" on the <a href="http://localhost:8080/axis2/index.jsp"
+target="_blank">Home Page of Axis2 Web Application</a>
+(http://localhost:8080/axis2/index.jsp) and see whether the MyService is
+deployed properly. If you can see the following output then you have
+successfully deployed MyService on Axis2.</p>
<p align="center"><img src="images/userguide/MyServiceDeployed.jpg"
name="Graphic2" align="bottom" width="734" height="766" border="0"></p>
-<p>If you can see the above output then you have successfully deployed
-MyService on Axis2. Now let's see how we can write Web Service client to use
-this services. Axis2 provides an easy way to deploy a Web Services using,
-index.jsp. (See the installation guide for more information on this)</p>
-
-<h3>Axis2SampleDocLitPortType</h3>
-
-<p>Now let's see how we can generate the skeleton from a given WSDL and
-implement the business logic using Axis2. For this we use
-Axis2SampleDocLit.wsdl that can be found in the <b>wsdl</b> directory under
-samples.</p>
+<p>Note: Axis2 provides an easy way to deploy Web Services using the "Upload
+Service" tool on Axis2 Web Application's Administration module. (See the <a
+href="webadminguide.html" target="_blank">Web Administration Guide</a> for
+more information on this)</p>
+
+<h3><a name="generateskl">Writing Web Services by Code Generating
+Skeleton</a></h3>
+
+<p>This is the second method of writing Web Services using Axis2. Let's see
+how we can generate the skeleton from a given WSDL and implement the business
+logic using Axis2. For this we use Axis2SampleDocLit.wsdl that can be found
+in the <b>wsdl</b> directory under samples.</p>
-<h4>Generating Skeleton</h4>
+<h4><a name="WSDL2JavaTool">WSDL2Java Tool</a></h4>
<p>To generate the skeleton and the required classes you can use the
WSDL2Java tool provided in Axis2. This tool is located in the bin directory
@@ -407,61 +537,61 @@
<p>We will use the tool with the following parameters and generate the
skeleton and the other required classes.</p>
-<p>Windows users can use the following command in the console </p>
+
+<p>Windows users can use the following command in the console:</p>
<pre style="margin-bottom: 0.2in">WSDL2Java -uri ..\samples\wsdl\Axis2SampleDocLit.wsdl -ss -sd -o ..\samples\src -p org.apache.axis2.userguide</pre>
-<p>Linux users should switch the file seperator</p>
+<p>Linux users should switch the file separator:</p>
<pre style="margin-bottom: 0.2in">WSDL2Java -uri ../samples/wsdl/Axis2SampleDocLit.wsdl -ss -sd -o ../samples/src -p org.apache.axis2.userguide</pre>
<p>This will generate the required classes in the <b>src</b> directory inside
-samples. This will also generate the schema classes in a directory named
-<b>schema</b> and please note that these are not source files and should be
-availed in the class path in order to compile the generated classes</p>
+samples, and the schema classes in <strong>schema</strong> directory also
+inside samples. Note that these are not source files and should be availed in
+the class path in order to compile the generated classes</p>
-<h4>Implement the Business Logic</h4>
+<h4><a name="businesslogic">Implement the Business Logic</a></h4>
<p>Locate the skeleton class that can be found under src/userguide directory
with the name "Axis2SampleDocLitPortTypeSkeleton.java". This is the skeleton
-for our web service and we can easily fill the business logic now. The WSDL
-we have used has three operations as follows.</p>
+for our web service and we can now easily implement the business logic. The
+WSDL we have used has three operations:<!--<li><p style="margin-bottom: 0in">echoVoid - Operation that does not
+accept any input parameters and also provide no out put parameters. Just
+perform some task </p>
+</li>-->
+</p>
<ul>
- <!--<li><p style="margin-bottom: 0in">echoVoid - Operation that does not
- accept any input parameters and also provide no out put parameters. Just
- perform some task </p>
- </li>-->
- <li><p style="margin-bottom: 0in">echoString - Operation that echos a
+ <li><p style="margin-bottom: 0in">echoString - Operation that echoes a
String value </p>
</li>
<li><p style="margin-bottom: 0in">echoStringArray - Operation that accept
- string array as the input and echos them back</p>
+ string array as the input and echoes them back</p>
</li>
- <li><p>echoStruct - Operation that accept a Struct as the input and echos
+ <li><p>echoStruct - Operation that accept a Struct as the input and echoes
them back.</p>
</li>
</ul>
-
<!--<h4>echoVoid </h4>
<p>Locate the following code segment in the
"Axis2SampleDocLitPortTypeSkeleton.java" and fill the business logic. For
the explanation purpose we do not need anything to be implemented here.</p>
<pre>public void echoVoid(){
- //Todo fill this with the necessary business logic
+//Todo fill this with the necessary business logic
}</pre> -->
-<h4>echoString </h4>
+<h4><a name="echostring">echoString</a></h4>
<p>Locate the following code segment in the
"Axis2SampleDocLitPortTypeSkeleton.java" and fill the business logic as
shown below.</p>
<pre> public org.soapinterop.xsd.EchoStringArrayReturnDocument
echoStringArray(org.soapinterop.xsd.EchoStringArrayParamDocument param2){
- //Todo fill this with the necessary business logic
+ //To do fill this with the necessary business logic
return null;
}</pre>
<p>Once filled with the business logic it will be as follows. The code is
-simple and the explanations are given in the comments.</p>
+simple and the explanations are given as comments.</p>
<pre>public org.soapinterop.xsd.EchoStringReturnDocument
echoString(org.soapinterop.xsd.EchoStringParamDocument param6) {
//Use the factory to create the output document.
@@ -474,7 +604,7 @@
<p>Similarly following code fragments shows how you can fill the business
logic for our first web service.</p>
-<h4>echoStringArray</h4>
+<h4><a name="echostringarray">echoStringArray</a></h4>
<pre>public org.soapinterop.xsd.EchoStringArrayReturnDocument
echoStringArray(org.soapinterop.xsd.EchoStringArrayParamDocument param2) {
@@ -494,7 +624,7 @@
return retDoc;
}</pre>
-<h4>echoStruct</h4>
+<h4><a name="echostruct">echoStruct</a></h4>
<pre>public org.soapinterop.xsd.EchoStructReturnDocument
echoStruct(org.soapinterop.xsd.EchoStructParamDocument param4) {
@@ -517,133 +647,140 @@
return retDoc;
}</pre>
-<h4>services.xml</h4>
+<h4><a name="servicesxml">services.xml</a></h4>
-<p> Axis2 uses "services.xml" to hold the configuretions for a particular web
+<p> Axis2 uses "services.xml" to hold the configurations for a particular web
service deployed in the Axis2 engine. When we generate the skeleton using the
WSDL2Java tool, it will also generate the required services.xml for this web
-service as well and it can be found in the same directory as the skeleton.
-The generated services.xml is as follows.</p>
+service as well. This can be found in the same directory as the skeleton. The
+generated services.xml is as follows.</p>
<pre><!--Auto generated Axis Service XML-->
<service name="Axis2SampleDocLitPortTypeSkeletonTest">
-<parameter locked="xsd:false" name="ServiceClass">userguide.Axis2SampleDocLitPortTypeSkeleton</parameter>
-<!--Mounting the method echoStringArray-->
-<operation name="echoStringArray">
-<messageReceiver class="userguide.Axis2SampleDocLitPortTypeMessageReceiver"/>
-</operation>
-<!--Mounting the method echoStruct-->
-<operation name="echoStruct">
-<messageReceiver class="userguide.Axis2SampleDocLitPortTypeMessageReceiver"/>
-</operation>
-<!--Mounting the method echoString-->
-<operation name="echoString">
-<messageReceiver class="userguide.Axis2SampleDocLitPortTypeMessageReceiver"/>
-</operation>
+ <parameter locked="xsd:false" name="ServiceClass">userguide.Axis2SampleDocLitPortTypeSkeleton</parameter>
+ <!--Mounting the method echoStringArray-->
+ <operation name="echoStringArray">
+ <messageReceiver class="userguide.Axis2SampleDocLitPortTypeMessageReceiver"/>
+ </operation>
+ <!--Mounting the method echoStruct-->
+ <operation name="echoStruct">
+ <messageReceiver class="userguide.Axis2SampleDocLitPortTypeMessageReceiver"/>
+ </operation>
+ <!--Mounting the method echoString-->
+ <operation name="echoString">
+ <messageReceiver class="userguide.Axis2SampleDocLitPortTypeMessageReceiver"/>
+ </operation>
</service></pre>
-<p>As it can be seen, first line of the "services.xml" gives the name of the
-Web Service. This is used in the URL to the service as the service name. Next
-comes the description and the service class. The next xml tags describe the
-operations that are available in this service with respective message
-receivers.</p>
+<p>First line of the "services.xml" gives the name of the Web Service. This
+is used in the URL to the service as the service name. Next comes the
+description and the service class. The next xml tags describe the operations
+that are available in this service with respective message receivers.</p>
-<h4>Packaging</h4>
+<h4><a name="packaging">Packaging</a></h4>
<p>Next step in the process is to package the classes in a .aar (axis2
archive) and deploy it in Axis2. When the WSDL2Java tool generate the
-skeleton it will also generate the required data binding classes as well.
-These schema related classes are located in the <b>schema </b>directory of
-the generated code. Copy this to your class path and compile the skeleton and
-the supporting classes. In order to create the .aar file, let's create the
+skeleton it will also generate the required data binding classes. These
+schema related classes are located in the <b>schema </b>directory of the
+generated code. Copy this to your class path, compile the skeleton and the
+supporting classes. In order to create the .aar file, let's create the
following directory structure with the required files and then simply use jar
command to package it.</p>
-<p><img src="images/userguide/DirectoryStructure.JPG" name="Graphic3"
-align="bottom" width="164" height="142" border="0"></p>
+<p><img src="images/userguide/DirectoryStructure.JPG" align="bottom"
+width="164" height="142" border="0"></p>
<p>Go to the top level directory where you can find the class files for the
-above service (i.e. one level up in the directory structure shown above) and
-type the following command in a command line.</p>
+above service (i.e. one level up on the directory structure shown above),
+then type the following command in a command line.</p>
<pre style="margin-bottom: 0.2in">jar -cf Axis2SampleDocLitPortType.aar .</pre>
<p>Deploying the service is just a matter of dropping the ".aar" in to
"services" directory that can be found in the "\webapps\axis2\WEB-INF" of
-your servlet container and hence please copy the "echo.aar" into the
-"<b>services</b>" directory. Once these steps are completed, please start the
-servlet container (if you have not already started) and check the link "List
-Available services" in the page http://localhost:8080/axis2/index.jsp and see
-whether the Axis2SampleDocLitPortType is deployed properly. If everything is
-ok, you will see the following out put..</p>
+your servlet container, hence copy the "echo.aar" into the "<b>services</b>"
+directory. Once these steps are completed, please start the servlet container
+(if you have not already started) and check the link "Services" on the <a
+href="http://localhost:8080/axis2/index.jsp" target="_blank">Home Page of
+Axis2 Web Application</a> (http://localhost:8080/axis2/index.jsp) and see
+whether the Axis2SampleDocLitPortType is deployed properly. If you can see
+the following output then you have successfully deployed
+Axis2SampleDocLitPortType on Axis2.</p>
<p align="center"><img src="images/userguide/ServiceDeployed.JPG"
name="Graphic4" align="bottom" width="734" height="764" border="0"></p>
-<p>If you can see the above output then you have successfully deployed
-Axis2SampleDocLitPortType on Axis2. Now let's see how we can write Web
-Service client to use this services. Axis2 provides an easy way to deploy a
-Web Services using, index.jsp. (See the installation guide for more
-information on this)</p>
+<p>Note: Axis2 provides an easy way to deploy Web Services using the "Upload
+Service" tool on Axis2 Web Application's Administration module. (See the <a
+href="webadminguide.html" target="_blank">Web Administration Guide</a> for
+more information on this)</p>
+
+<h2><a name="Web_Service_Clients_Using_Axis2"></a>Web Service Clients Using
+Axis2</h2>
-<h2><a name="Web_Service_Clients_Using_Axis2"></a>Web Service Clients Using Axis2</h2>
+<p>Now let's see how we can write a Web Service Client to use this Web
+Service.</p>
<p>Web services can be used to provide wide range of functionality to the
-users ranging from simple less time consuming operations such as
+users ranging from simple, less time consuming operations such as
"getStockQuote" to time consuming business services. When we utilize (invoke
using client applications) these Web Service we cannot use some simple
generic invocation paradigm that suites all the timing complexities involved
in the service operations. For example, if we use a single transport channel
-(such as HTTP) to invoke a Web Service with and IN-OUT operation, that take
-long time to complete, then in most of the time we may end up with
-"connection time outs". On the other hand, if there are simultaneous service
-invocations that we need to perform from a single client application, then
-the use of a "blocking" client API will degrade the performance of the client
-application. Similarly there are various other consequences such as One-Way
-transports that come in to play when we need 's try<< to analyze some
-common service invocation paradigms.</p>
+(such as HTTP) to invoke a Web Service with and IN-OUT operation that take
+long time to complete, then most of the time we may end up with "connection
+time outs". On the other hand, if there are simultaneous service invocations
+that we need to perform from a single client application, then the use of a
+"blocking" client API will degrade the performance of the client application.
+Similarly there are various other consequences such as One-Way transports
+that come in to play when we need them. Let's try to analyze some common
+service invocation paradigms.</p>
<p>Many web service engines provide the users with a Blocking and
Non-Blocking client APIs.</p>
<ul>
<li><p style="margin-bottom: 0in"><b>Blocking API</b> -Once the service
- invocation is called, the client application hangs and gets the control
- back only when the operation completes and the client receives a response
- or a fault. This is the simplest way of invoking Web Services and suites
- many business situations.</p>
- </li>
- <li><p><b>Non-Blocking API </b>- A callback or polling based API and hence
- once a service invocation is called, the client application immediately
- gets the control back and the response is retrieved using the callback
- object provided. This approach provides the flexibility to the client
- application to invoke several Web Services simultaneously with out
- blocking on the operation already invoked.</p>
+ invocation is called, the client application hangs and only gets control
+ back when the operation completes, after which client receives a response
+ or a fault. This is the simplest way of invoking Web Services and it also
+ suites many business situations.</p>
+ </li>
+ <li><p><b>Non-Blocking API </b>- This is a callback or polling based API,
+ hence once a service invocation is called, the client application
+ immediately gets the control back and the response is retrieved using the
+ callback object provided. This approach provides the flexibility to the
+ client application to invoke several Web Services simultaneously without
+ blocking the operation already invoked.</p>
</li>
</ul>
-<p>Both these mechanism works in the API level and let's name the
-asynchronous behavior that we can get using the Non-Blocking API as <b>API
-Level Asynchrony.</b></p>
+<p>Both these mechanisms work in the API level. Let's name the asynchronous
+behavior that we can get using the <strong>Non-Blocking API</strong> as
+<b>API Level Asynchrony.</b></p>
<p>Both these mechanisms use single transport connection to send the request
and to receive the response. They severely lags the capability of using two
transport connections for the request and the response (either One-Way of
-Two-Way). So both of these mechanisms fail to address the problem of long
-running transactions (the transport connection may times-out before the
-operation completes). A possible solution would be to use two separate
-transport connections for request and response. The asynchronous behavior
-that we gain using can be called, <b>Transport Level Asynchrony</b>.</p>
-
-<p>By combining the two we can obtain four different invocation patterns for
-web services as shown in the following table.</p>
+Two-Way). So both these mechanisms fail to address the problem of long
+running transactions (the transport connection may time-out before the
+operation completes). A possible solution would be to use <strong>two
+separate transport connections for request and response</strong>. The
+asynchronous behavior that we gain using this solution can be called
+<b>Transport Level Asynchrony</b>.</p>
+
+<p>By combining API Level Asynchrony & Transport Level Asynchrony we can
+obtain four different invocation patterns for web services as shown in the
+following table.</p>
<a name="table1"></a>
<table width="100%" border="1" cellpadding="0" cellspacing="0">
<tbody>
<tr>
- <td width="33%" height="19"><p>API (Blocking/Non-Blocking)</p>
+ <td width="33%" height="19"><p><strong>API
+ (Blocking/Non-Blocking)</strong></p>
</td>
- <td width="33%"><p> Dual Transports (Yes/No)</p>
+ <td width="33%"><p><strong> Dual Transports (Yes/No)</strong></p>
</td>
- <td width="33%"><p>Description</p>
+ <td width="33%"><p><strong>Description</strong></p>
</td>
</tr>
<tr>
@@ -685,25 +822,32 @@
</table>
<p>Axis2 provides the user with all these possibilities to invoke Web
-Services. In addition Axis2 provides a data binding support making the life
-easy for developers writing Web Service client applications. In this user
-guide we will first see how we can write Web Service clients using the
-Axis2's primary APIs and later we will see how we can use generated stubs to
-simply write Web Service Clients.</p>
+Services.</p>
+
+<p>Below we describe how to write Web Services Clients using Axis2. This can
+be done in two methods:</p>
+<ol>
+ <li><a href="#primaryAPIs">Using the Axis2's primary APIs</a></li>
+ <li><p><a href="#databinding">Using stubs generated with data binding
+ support</a>, making the life easy for developers writing Web Service
+ client applications</p>
+ </li>
+</ol>
-<h3>Using Axis2's Primary APIs</h3>
+<h3><a name="primaryAPIs">Writing Web Service Clients Using Axis2's Primary
+APIs</a></h3>
-<h3>EchoBlockingClient</h3>
+<h4><a name="echoblocking">EchoBlockingClient</a></h4>
<p>Axis2 provides the user with several invocation patterns for Web Services,
ranging from pure blocking single channel invocations to a non-blocking dual
-channel invocations. First let's see how we can write a client to invoke
-"echo" operation of "MyService" using the simplest good old blocking
-invocation. The client code that you need to write will be as follows.</p>
+channel invocations. Let's first see how we can write a client to invoke
+"echo" operation of "MyService" using the simplest blocking invocation. The
+client code you need to write is as follows.</p>
<pre> try {
OMElement payload = ClientUtil.getEchoOMElement();
-<font color="#33cc00"> Options options = new Options();
- options.setTo(targetEPR);
+<font color="#33cc00"> Options options = new Options();
+ options.setTo(targetEPR);
options.setListenerTransportProtocol(Constants.TRANSPORT_HTTP);
options.setUseSeparateListener(false);
@@ -726,18 +870,18 @@
}</pre>
<p>The green lines shows the set of operations that you need to perform
-in-order to invoke a web service while the rest is used to create the
-OMElement that needs to be sent and to display the response OMElement. To
-test this client you can use the provided ant build file that can be found in
-the "Axis2Home/samples" directory. Run the "testEchoBlockingClient" target .
-if you can see the response OMElement printed in your command line then you
-have successfully tested the client as well. </p>
+inorder to invoke a web service. The rest is used to create the OMElement
+that needs to be sent and display the response OMElement. To test this
+client, use the provided ant build file that can be found in the
+"Axis2Home/samples" directory. Run the "testEchoBlockingClient" target . If
+you can see the response OMElement printed in your command line, then you
+have successfully tested the client. </p>
-<h3>PingClient</h3>
+<h4><a name="ping">PingClient</a></h4>
<p>In the Web Service "MyService" we had a IN-ONLY operation with the name
-"ping" (see Web Services Using Axis2). So let's write a client to invoke this
-operation as well. The client code will be as follows.</p>
+"ping" (see <a href="#WS">Web Services Using Axis2</a>). Let's write a client
+to invoke this operation. The client code is as follows:</p>
<pre> try {
OMElement payload = ClientUtil.getPingOMElement();
@@ -747,39 +891,39 @@
msgSender.send("ping", payload);
- } catch (AxisFault axisFault) {
+ }
+catch (AxisFault axisFault) {
axisFault.printStackTrace();
}</pre>
<p>Since we are accessing a IN-ONLY operation we can directly use the
-"MessageSender" to invoke this operation. As it can be seen in the above code
-, it is very straight forward to invoke this type of operation. MessageSender
-will not block the invocation, hence it will return the control immediately
-back to the client. You can test this client by running the target
-"testPingClient" of the ant build file at "Axis2Home/samples".</p>
-
-<p>Ok, we have invoked the two operations in our service, Are we done? No!,
-there are lot more to explore, Let's see some other ways to invoke the same
-operations.</p>
+"MessageSender" to invoke this operation. MessageSender will not block the
+invocation, hence it will return the control immediately back to the client.
+You can test this client by running the target "testPingClient" of the ant
+build file at "Axis2Home/samples".</p>
+
+<p>We have invoked the two operations in our service. Are we done? No! There
+are lot more to explore. Let's see some other ways to invoke the same
+operations...</p>
-<h3>EchoNonBlockingClient</h3>
+<h4><a name="echononblocking">EchoNonBlockingClient</a></h4>
<p>In the EchoBlockingClient once the "call.invokeBlocking("echo", payload);"
is called, the client is blocked till the operation is completed. This
behavior is not desirable when there are many Web Service invocations to be
-done in a single client application. A solution, would be to use a
+done in a single client application. A solution would be to use a
Non-Blocking API to invoke web services. Axis2 provides a callback based
non-blocking API for users.</p>
<p>A sample client for this can be found under
"Axis2Home/samples/userguide/src/userguide/clients" with the name
-EchoNonBlockingClient. If we consider the changes that the user may have to
-do with respect to the "EchoBlockingClient" that we have already seen, it
-will be as follows.</p>
+EchoNonBlockingClient. If we consider the changes that user may have to do
+with respect to the "EchoBlockingClient" that we have already seen, it will
+be as follows:</p>
<pre style="margin-bottom: 0.2in">call.invokeNonBlocking("echo", payload, callback);</pre>
<p>The invocation accepts a callback object as a parameter. Axis2 client API
-provides an abstract Callback with the following methods.</p>
+provides an abstract Callback with the following methods:</p>
<pre>public abstract void onComplete(AsyncResult result);
public abstract void reportError(Exception e);
public boolean isComplete() {}</pre>
@@ -795,34 +939,36 @@
"testEchoNonBlockingClient" target of the ant file found at the
"Axis2Home/samples" directory.</p>
-<h3>EchoNonBlockingDualClient</h3>
+<h4><a name="echononblockingdual">EchoNonBlockingDualClient</a></h4>
<p>The solution provided by the Non-Blocking API has one limitation when it
comes to Web Service invocations which takes long time to complete. The
limitation is due to the use of single transport connection to invoke the Web
Service and to retrieve the response. In other words, client API provides a
non blocking invocation mechanism for the users, but the request and the
-response comes in a single transport connection (needs two way transports
-like HTTP). Long running Web Service invocations or Web Service invocations
-using One-Way transports (like SMTP) cannot be utilized by simply using a non
+response comes in a single transport (Two-Way transport) connection (like
+HTTP). Long running Web Service invocations or Web Service invocations using
+One-Way transports (like SMTP) cannot be utilized by simply using a non
blocking invocation. </p>
<p>The trivial solution is to use separate transport connections (either
One-Way or Two-Way) for the request and response. The next problem that needs
to be solved is the correlation (correlating the request and the response).
-<a href="http://www.w3.org/Submission/ws-addressing/">WS-Addressing</a>
-provides a neat solution to above using <wsa:MessageID> and
-<wsa:RelatesTo> headers. Axis2 provides support for addressing based
-correlation mechanism and a complying Client API to invoke Web Services with
-two transport connections. (core of Axis2 does not depend on WS-Addressing,
-and it is the addressing like properties, hence Axis2 has the flexibility to
-use different versions of addressing)</p>
+<a href="http://www.w3.org/Submission/ws-addressing/"
+target="_blank">WS-Addressing</a> provides a neat solution to this using
+<wsa:MessageID> and <wsa:RelatesTo> headers. Axis2 provides
+support for addressing based correlation mechanism and a complying Client
+API to invoke Web Services with two transport connections. (Core of Axis2
+does not depend on WS-Addressing, but contains a set of parameters like in
+addressing that can be populated in any means. WS-Addressing is one of the
+users that may populate them. Even the transports can populate these. Hence
+Axis2 has the flexibility to use different versions of addressing)</p>
<p>Users can select between Blocking or Non-Blocking APIs for the Web Service
clients with two transport connections. By simply using a boolean flag, the
same API can be used to invoke web services (IN-OUT operations) using two
-separate transport connections. Let's see how we can do it using an example.
-Following code fragment shows how to invoke the same "echo" operation, using
+separate transport connections. Let's see how it's done using an example.
+Following code fragment shows how to invoke the same "echo" operation using
Non-Blocking API with two transport connections<strong>. The ultimate
asynchrony!!</strong></p>
<pre> try {
@@ -832,10 +978,7 @@
//The boolean flag informs the axis2 engine to use two separate transport connection
//to retrieve the response.<br> options.setUseSeparateListener(true);
- Call call = new Call();<br> call.setClientOptions(options);
-</pre>
-
-
+ Call call = new Call();<br> call.setClientOptions(options);</pre>
<pre>
//Callback to handle the response
Callback callback = new Callback() {
@@ -872,60 +1015,61 @@
} catch (Exception ex) {
ex.printStackTrace();
}</pre>
-<p><font
-color="#0000ff"><font color="#000000">The boolean flag (value true) in
-the "<b>call.setUseSeparateListener(...)</b>" method informs the Axis2 engine to use
-separate transport connections for request and response. Finally
-"<b>call.close()</b>" informs the Axis2 engine to stop the client side
-listener started to retrieve the response.</font></font></p>
-
-<p>Before we run the sample client we need one more step to perform. As
-mentioned earlier Axis2 uses addressing based correlation mechanism and hence
-we need to "engage" addressing module in the server side as well. According
-to the Axis2 architecture addressing module is deployed in the
+
+<p><font color="#0000ff"><font color="#000000">The boolean flag (value true)
+in the "<b>call.setUseSeparateListener(...)</b>" method informs the Axis2
+engine to use separate transport connections for request and response.
+Finally "<b>call.close()</b>" informs the Axis2 engine to stop the client
+side listener started to retrieve the response.</font></font></p>
+
+<p>Before we run the sample client we have one more step to perform. As
+mentioned earlier Axis2 uses addressing based correlation mechanism, hence we
+need to "engage" addressing module in the server side as well. According to
+the Axis2 architecture, addressing module is deployed in the
"<strong>pre-dispatch</strong>" phase (See <a
-href="file:///G:/Documents and Settings/Jaliya/Desktop/Axis2ArchitectureGuide.html">Architecture
-Guide</a> for more details about phases) and hence "engaging" means simply
-adding module reference in the "axis2.xml" (NOT the "services.xml"). Please
-add the following line to the "axis2.xml" that you can find in the
-"/webapps/axis2/WEB-INF" directory in the servlet container. </p>
+href="Axis2ArchitectureGuide.html" target="_blank">Architecture Guide</a> for
+more details about phases) and hence "engaging" means simply adding module
+reference in the "axis2.xml" (NOT the "services.xml"). Now add the following
+line to the "axis2.xml" that you can find in the "/webapps/axis2/WEB-INF"
+directory in the servlet container. </p>
<pre style="margin-bottom: 0.2in"> <module ref="addressing"/></pre>
-<p>Note: Please note that<font color="#000000"> once you change the
-"axis2.xml" you need to restart the servlet container.</font></p>
+<p>Note: <font color="#000000">Once you change the "axis2.xml" you need to
+restart the servlet container.</font></p>
-<p>This will enable the addressing in the server side and now you can test
-the "TestEchoNonBlockingDualClient" using the "testEchoNonBlockingDualClient"
-target of the ant file found at "Axis2Home/samples" directory. If you can see
-the response OMElement printed in the client side, that means you have
-successfully tested the Non Blocking API with two transport channels at the
-client side.</p>
-
-<h3>EchoBlockingDualClient</h3>
-
-<p>This is again a two transport request/response client, but this time, we
-use a Blocking API in the client code. Sample code for this can be found in
-the "Axis2Home/samples/userguide/src/userguide/clients/" directory and the
-explanation is similar to the EchoNonBlockingDualClient, except that here we
-do not use a callback object to handle response. This is a very useful
+<p>This will enable the addressing in the server side. Now you can test the
+"TestEchoNonBlockingDualClient" using the "testEchoNonBlockingDualClient"
+target of the ant file found at "Axis2Home/samples" directory. If you see the
+response OMElement printed in the client side, then you have successfully
+tested the Non Blocking API with two transport channels at the client
+side.</p>
+
+<h4><a name="echoblockingdual">EchoBlockingDualClient</a></h4>
+
+<p>This is again a Two-Way transport request/response client, but this time,
+we use a Blocking API in the client code. Sample code for this can be found
+in the "Axis2Home/samples/userguide/src/userguide/clients/" directory and the
+explanation is similar to the <a
+href="#echononblockingdual">EchoNonBlockingDualClient</a>, except that here
+we do not use a callback object to handle response. This is a very useful
mechanism when the service invocation is IN-OUT in nature and the transports
are One-Way (e.g. SMTP). For the sample client we use two HTTP connections
for request and response. User can test this client using the
"echoBlockingDualClient" target of the ant build file found in the
"Axis2Home/samples" directory.</p>
-<p>See <a href="#configTransport">Configuring Transports</a> for use
-different transports.</p>
+<p>See <a href="http-transport.html" target="_blank">Configuring
+Transports</a> for use different transports.</p>
-<h3>With Data Binding</h3>
+<h3><a name="databinding">Writing Web Service Clients using Code Generation
+with Data Binding Support</a></h3>
<p>Axis2 provides the data binding support for Web Service client as well.
The user can generate the required stubs from a given WSDL with the other
-supporting classes. Let's see how we can generate the stubs for the WSDL we
-have used earlier to generate the skeleton for the
-"Axis2SampleDocLitPortType". Simply run the WSDL2Java tool that can be found
-in the bin directory of the Axis2 distribution using the following
-command.</p>
+supporting classes. Let's generate stubs for the WSDL used earlier to
+generate the skeleton for the "Axis2SampleDocLitPortType". Simply run the
+WSDL2Java tool that can be found in the bin directory of the Axis2
+distribution using the following command:</p>
<pre style="margin-bottom: 0.2in">WSDL2Java -uri ..\samples\wsdl\Axis2SampleDocLit.wsdl -o ..\samples\src -p org.apache.axis2.userguide</pre>
<p>This will generate the required stub "Axis2SampleDocLitPortTypeStub.java"
@@ -934,7 +1078,7 @@
Service Axis2SampleDocLitPortType (the service that we have already
deployed).</p>
-<h3>Client for echoVoid Operation</h3>
+<h4><a name="echovoid">Client for echoVoid Operation</a></h4>
<p>Following code fragment shows the necessary code for utilizing the
echoVoid operation of the Axis2SampleDocLitPortType that we have already
@@ -942,7 +1086,7 @@
Service and the same SOAP envelope is echoed back.</p>
<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 sa the AXIS_HOME
+ //We pass null to the AXIS_HOME and hence the stub will use the current directory as the AXIS_HOME
Axis2SampleDocLitPortTypeStub stub = new Axis2SampleDocLitPortTypeStub(null,
"http://localhost:8080/axis2/services/Axis2SampleDocLitPortType");
stub.echoVoid();
@@ -951,15 +1095,15 @@
e.printStackTrace();
}</pre>
-<h3>Client for echoString Operation</h3>
+<h4><a name="clientechostring">Client for echoString Operation</a></h4>
<p>Following code fragment shows the necessary code for utilizing the
echoString operation of the Axis2SampleDocLitPortType that we have already
-deployed. The code is very simple to understand and the explanations are
-given in the comments.</p>
+deployed. The code is very simple to understand and the explanations are in
+the form of comments.</p>
<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 sa the AXIS_HOME
+ //We pass null to the AXIS_HOME and hence the stub will use the current directory as the AXIS_HOME
Axis2SampleDocLitPortTypeStub stub= new Axis2SampleDocLitPortTypeStub(null,
"http://localhost:8080/axis2/services/Axis2SampleDocLitPortType");
//Create the request document to be sent.
@@ -973,13 +1117,14 @@
e.printStackTrace();
}</pre>
-<p>Similarly following code fragments shows client side code for
+<p>Similarly following code fragments show client side code for
echoStringArray operation and echoStruct operation respectively.</p>
-<h3>Client for echoStringArray Operation</h3>
+<h4><a name="clientechostringarray">Client for echoStringArray
+Operation</a></h4>
<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 sa the AXIS_HOME
+ //We pass null to the AXIS_HOME and hence the stub will use the current directory as the AXIS_HOME
Axis2SampleDocLitPortTypeStub stub = new Axis2SampleDocLitPortTypeStub(null,
"http://localhost:8080/axis2/services/Axis2SampleDocLitPortType");
@@ -1003,10 +1148,10 @@
e.printStackTrace();
}</pre>
-<h3>Client for echoStruct Operation</h3>
+<h4><a name="clientechostruct">Client for echoStruct Operation</a></h4>
<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 sa the AXIS_HOME
+ //We pass null to the AXIS_HOME and hence the stub will use the current directory as the AXIS_HOME
Axis2SampleDocLitPortTypeStub stub = new Axis2SampleDocLitPortTypeStub(null,
"http://localhost:8080/axis2/services/Axis2SampleDocLitPortType");
//Create the request Document
@@ -1036,11 +1181,10 @@
<h2><a name="Modules"></a>Modules</h2>
<p>Axis2 provides an extended support for modules (See <a
-href="file:///G:/Documents and Settings/Jaliya/Desktop/Axis2ArchitectureGuide.html">Architecture
-Guide</a> for more details about modules in axis2). Let's see how we can
-create a custom module and deploy it to the MyService that we have created
-earlier. Following steps shows the actions that needs to be performed to
-deploy a custom module for a given Web Service.</p>
+href="Axis2ArchitectureGuide.html">Architecture Guide</a> for more details
+about modules in Axis2). Let's create a custom module and deploy it to the
+MyService which we created earlier. Following steps shows the actions that
+need to be performed to deploy a custom module for a given Web Service:</p>
<ol>
<li><p style="margin-bottom: 0in">Create the Module Implementation</p>
</li>
@@ -1060,10 +1204,10 @@
</li>
</ol>
-<h3>MyService with a Logging Module</h3>
+<h3><a name="logging">MyService with a Logging Module</a></h3>
<p>Let's write a simple logging module for our sample. This module contains
-one handler that just logs the message that is passed though it. Axis2 uses
+one handler that just logs the message that is passed through it. Axis2 uses
."mar" (Module Archive) to deploy modules in Axis2. Following diagram shows
the file structure inside that needs to be there in the ".mar" archive. Let's
create all these and see how it works.</p>
@@ -1071,7 +1215,7 @@
<p><img src="images/userguide/ModuleView.jpg" name="Graphic5" align="bottom"
width="185" height="120" border="0"></p>
-<h4>Step1 : LoggingModule Class</h4>
+<h4><a name="step1loggingmodule">Step1 : LoggingModule Class</a></h4>
<p>LoggingModule is the implementation class of the Axis2 module. Axis2
modules should implement the "org.apache.axis2.modules.Module" interface with
@@ -1080,21 +1224,21 @@
public void shutdown(AxisConfiguration axisSystem) throws AxisFault;//End of module processing</pre>
<p>These methods can be used to control the module initialization and the
-termination. With the input parameter AxisConfiguration, the user is provided
-with the complete configuration hierarchy and this can be used to fine tune
-the module behavior by the module writers. For the simple logging service, we
+termination. With the input parameter AxisConfiguration user is provided with
+the complete configuration hierarchy. This can be used to fine-tune the
+module behavior using the module writers. For the simple logging service we
can keep these methods blank in our implementation class.</p>
-<h4>Step2 : LogHandler</h4>
+<h4><a name="step2loggingmodule">Step2 : LogHandler</a></h4>
-<p>A module in axis2 can contain, one or more handlers that perform various
+<p>A module in Axis2 can contain, one or more handlers that perform various
SOAP header processing at different phases. (See<a
-href="file:///G:/Documents and Settings/Jaliya/Desktop/Axis2ArchitectureGuide.html">
-Architecture Guide</a> for more information about phases). For the logging
-module we will write a handle with the following methods. "public void
-invoke(MessageContext ctx);" is the method that is called by the Axis2 engine
-when the control is passed to the handler. "public void revoke(MessageContext
-ctx);" is called when the handlers are revoked by the Axis2 engine.</p>
+href="Axis2ArchitectureGuide.html" target="_blank"> Architecture Guide</a>
+for more information about phases). For the logging module we will write a
+handle with the following methods. "public void invoke(MessageContext ctx);"
+is the method that is called by Axis2 engine when the control is passed to
+the handler. "public void revoke(MessageContext ctx);" is called when the
+handlers are revoked by the Axis2 engine.</p>
<pre>public class LogHandler extends AbstractHandler implements Handler {
private Log log = LogFactory.getLog(getClass());
private QName name;
@@ -1116,44 +1260,43 @@
}
}</pre>
-<h4>Step3 : module.xml</h4>
+<h4><a name="step3loggingmodule">Step3 : module.xml</a></h4>
<p>"module.xml" contains the deployment configurations for a particular
module. It contains details such as Implementation class of the module (in
-this example it is the "LoggingModule" class and the various handlers that
-will run in different phases. "module.xml" for the logging module will be as
-follows.</p>
+this example it is the "LoggingModule" class and various handlers that will
+run in different phases). "module.xml" for the logging module will be as
+follows:</p>
<pre><module name="logging" class="userguide.loggingmodule.LoggingModule ">
-<inflow>
+ <inflow>
<handler name="InFlowLogHandler" class="userguide.loggingmodule.LogHandler">
<order phase="loggingPhase" />
</handler>
-</inflow>
+ </inflow>
-<outflow>
+ <outflow>
<handler name="OutFlowLogHandler" class="userguide.loggingmodule.LogHandler">
<order phase="loggingPhase"/>
</handler>
-</outflow>
+ </outflow>
-<Outfaultflow>
+ <Outfaultflow>
<handler name="FaultOutFlowLogHandler" class="userguide.loggingmodule.LogHandler">
<order phase="loggingPhase"/>
</handler>
-</Outfaultflow>
+ </Outfaultflow>
-<INfaultflow>
+ <INfaultflow>
<handler name="FaultInFlowLogHandler" class="userguide.loggingmodule.LogHandler">
<order phase="loggingPhase"/>
</handler>
-</INfaultflow>
+ </INfaultflow>
</module></pre>
<p>As it can be seen there are four phases defined in this "module.xml"</p>
<ol>
- <li><p style="margin-bottom: 0in">inflow - Represents the
- handler chain that will run when a message is coming in. </p>
- </li>
+ <li><style="margin-bottom: 0in">inflow - Represents the
+ handler chain that will run when a message is coming in. </li>
<li><p style="margin-bottom: 0in">outflow - Represents the
handler chain that will run when the message is going out. </p>
</li>
@@ -1167,25 +1310,26 @@
</ol>
<p>Following set of tags describe the name of the handler, handler class and
-the phase in which this handler going to run."InFlowLogHandler" is the name
-given for the particular instance of this handler. The property, class is the
-actual implementation class for this handler. Since we are writing logging
-handler, we can reuse the same handler in all these phases, however this may
-not be the same for all the modules. "<order phase="loggingPhase" />"
-describes the phase in which this handler runs.</p>
+the phase in which this handler is going to run. "InFlowLogHandler" is the
+name given for the particular instance of this handler. The value of class
+attribute is the actual implementation class for this handler. Since we are
+writing logging handler, we can reuse the same handler in all these phases.
+However this may not be the same for all the modules. "<order
+phase="loggingPhase" />" describes the phase in which this handler
+runs.</p>
<pre><handler name="InFlowLogHandler" class="userguide.loggingmodule.LogHandler">
<order phase="loggingPhase" />
</handler></pre>
-<h4>Step 4: Modify the "axis2.xml"</h4>
+<h4><a name="step4loggingmodule">Step 4: Modify the "axis2.xml"</a></h4>
<p>In this handler the phase "loggingPhase" is defined by the module writer.
-It is not a pre-defined handler phase and hence the module writer should
+It is not a pre-defined handler phase, hence the module writer should
introduce it to the "axis2.xml" (NOT the services.xml) so that Axis2 engine
-knows where to place the handler in different "flows" (<br>
-InFlow, OutFlow, etc...). Following xml lines shows the respective changes to
-the "axis2.xml" in order for us to deploy this logging module in Axis2
-engine. This is an extract of the phase section of the "axis2.xml".</p>
+knows where to place the handler in different "flows" ( InFlow, OutFlow,
+etc.). Following xml lines show the respective changes made to the
+"axis2.xml" in order to deploy this logging module in Axis2 engine. This is
+an extract of the phase section of the "axis2.xml".</p>
<pre><!-- ================================================= -->
<!-- Phases -->
<!-- ================================================= -->
@@ -1198,73 +1342,72 @@
<!-- System pre defined phases -->
<!-- After Postdispatch phase module author or or service author can add any phase he want -->
-<phase name="<font color="#33cc00">loggingPhase</font>"/>
+ <phase name="<font color="#33cc00">loggingPhase</font>"/>
</phaseOrder>
<phaseOrder type="outflow">
<!-- user can add his own phases to this area -->
-<phase name="<font color="#33cc00">loggingPhase</font>"/>
+ <phase name="<font color="#33cc00">loggingPhase</font>"/>
</phaseOrder>
<phaseOrder type="INfaultflow">
<!-- user can add his own phases to this area -->
-<phase name="<font color="#33cc00">loggingPhase</font>"/>
+ <phase name="<font color="#33cc00">loggingPhase</font>"/>
</phaseOrder>
<phaseOrder type="Outfaultflow">
<!-- user can add his own phases to this area -->
-<phase name="<font color="#33cc00">loggingPhase</font>"/>
+ <phase name="<font color="#33cc00">loggingPhase</font>"/>
</phaseOrder></pre>
<p>Shown in green, the custom phase "loggingPhase" is placed in all the
-flows, and hence that phase will be called in all the message flows in the
-engine. Since our module is associated with this phase, the LogHandler is now
-have a phase for it to get executed.</p>
-
-<h4>Step5 : Modify the "services.xml"</h4>
-
-<p>Up to this point we have created the required classes and the
-configuration descriptions for the logging module and by changing the
-"axis2.xml" we have created the required phases for the logging module. Now
-the next step is to "<b>engage</b>" (use) this module in one of our services.
-For this, let's use the same Web Service that we have used throughout the
-user guide, the MyService. However, since we need to modify the
-"services.xml" of the MyService in order for us engage this module, we use a
-separate Web Service, but with the similar operations. The code for this
-service can be found in the
+flows, hence that phase will be called in all the message flows in the
+engine. Since our module is associated with this phase, the LogHandler inside
+the module now will be executed in this phase.</p>
+
+<h4><a name="step5loggingmodule">Step5 : Modify the "services.xml"</a></h4>
+
+<p>Up to this point we have created the required classes and configuration
+descriptions for the logging module and by changing the "axis2.xml" we have
+created the required phases for the logging module. Next step is to
+"<b>engage</b>" (use) this module in one of our services. For this, let's use
+the same Web Service that we have used throughout the user's guide,
+MyService. However, since we need to modify the "services.xml" of MyService
+in order to engage this module, we use a separate Web Service, but with the
+similar operations. The code for this service can be found in the
"Axis2Home/samples/userguide/src/userguide/example2" directory. The simple
-changes that we have done to he "services.xml' are shown in the green color
-in the following lines of xml.</p>
+changes that we have done to "services.xml' are shown in green in the
+following lines of xml.</p>
<pre><service name="<font color="#33cc00">MyServiceWithModule</font>">
-<description>
-This is a sample Web Service with a logging module engaged.
-</description>
-<font color="#33cc00"><module ref="logging"/></font>
-<parameter name="ServiceClass" locked="xsd:false">userguide.example2.MyService</parameter>
-<operation name="echo">
-<messageReceiver class="org.apache.axis2.receivers.RawXMLINOutMessageReceiver"/>
-</operation>
-<operation name="ping">
-<messageReceiver class="org.apache.axis2.receivers.RawXMLINOutMessageReceiver"/>
-</operation>
+ <description>
+ This is a sample Web Service with a logging module engaged.
+ </description>
+ <font color="#33cc00"><module ref="logging"/></font>
+ <parameter name="ServiceClass" locked="xsd:false">userguide.example2.MyService</parameter>
+ <operation name="echo">
+ <messageReceiver class="org.apache.axis2.receivers.RawXMLINOutMessageReceiver"/>
+ </operation>
+ <operation name="ping">
+ <messageReceiver class="org.apache.axis2.receivers.RawXMLINOutMessageReceiver"/>
+ </operation>
</service></pre>
<p>In this example we have changed the service name (the implementation class
is very similar to what we have used earlier although it is in a different
package). In addition we have added the line <b>"<module
-ref="logging"/>"</b> to the "services.xml". This informs the Axis2 engine
-that the module "logging" should be engaged for this service. The handler in
-side the module will be executed in their respective phases as described by
-the "module.xml".</p>
+ref="logging"/>"</b> to "services.xml". This informs the Axis2 engine that
+the module "logging" should be engaged for this service. The handler inside
+the module will be executed in their respective phases as described by the
+"module.xml".</p>
-<p><b>Step6 : Packaging</b></p>
+<p><b><a name="step6loggingmodule">Step6 : Packaging</a></b></p>
<p>Before deploying the module we need to create the ".mar" file for this
module. This can be done, using the "jar" command and then renaming the
-created jar file, or you can find the "Logging.mar" that is already created
+created jar file. Or you can find the "Logging.mar" that is already created
for you in the "Axis2Home/samples/userguide" directory.</p>
-<h4>Step7 : Deploy the Module in Axis2</h4>
+<h4><a name="step7loggingmodule">Step7 : Deploy the Module in Axis2</a></h4>
<p>Deploying a module in Axis2 require the user to create a directory with
the name "modules" in the "webapps/axis2/WEB-INF" directory of their servlet
@@ -1274,104 +1417,86 @@
<p>Although the required changes to the "services.xml" is very little, we
have created a separate service archive (MyServiceWithModule.aar) for users
-to just deploy and see. Please deploy this service using the same steps that
-you use to deploy "MyService" and copy the "LoggingModule.mar" file to the
-"modules" directory. Then by using the "TestWebServiceWithModuleClient.bat"
-and "TestWebServiceWithModuleClient.sh" in the
-"Axis2Home/samples/userguide/src/userguide/clients/bin" directory.</p>
+to deploy and see. Deploy this service using the <a href="#step4">same steps
+that you used to deploy "MyService"</a> and copy the "LoggingModule.mar" file
+to the "modules" directory. Then run using the
+"TestWebServiceWithModuleClient.bat" or "TestWebServiceWithModuleClient.sh"
+in the "Axis2Home/samples/userguide/src/userguide/clients/bin" directory.</p>
<p>Note: To see the logs, the user needs to modify the "log4j.properties" to
-log INFO as well. The property file is located in
-"webapps\axis2\WEB-INF\classes" of your servlet container. Change the line
-"log4j.rootCategory= ERROR, LOGFILE" to "log4j.rootCategory=INFO, ERROR,
-LOGFILE".</p>
-
-<h2> </h2>
+log INFO. The property file is located in "webapps\axis2\WEB-INF\classes" of
+your servlet container. Change the line "log4j.rootCategory= ERROR, LOGFILE"
+to "log4j.rootCategory=INFO, ERROR, LOGFILE".</p>
-<h2><a name="Other_Samples"></a>Other Samples</h2>
+<h2><a name="Other_Samples">Other Samples</a></h2>
-<p>To show the power and usage of Axis2, three standard samples are shipped
+<p>To show the power of usage of Axis2, three standard samples are shipped
with the binary distribution. These are meant to interact with outside web
services and prove the capabilities of the Axis2 system.</p>
<p>The included samples are</p>
<ul>
- <li><p style="margin-bottom: 0in">Google spell checker sample<!--<li>Google search sample</li> -->
- </p>
+ <li><style="margin-bottom: 0in">Google spell checker sample</li>
+ <li><p style="margin-bottom: 0in">Google search sample</p>
</li>
- <li><p>Amazon queuing sample</p>
+ <li><p style="margin-bottom: 0in">Amazon queuing sample</p>
</li>
</ul>
-<p>Following is a simple introduction to each of the samples. Each sample
-contains it's own help document that says about the usage and the advanced
-operations of that particular sample.</p>
-
-<h4>Google spell checker sample</h4>
-
-<p>This includes a spell checker program that uses the Google spell checking
-service. It demonstrates the blocking and non-blocking modes of calling the
-service. This sample can be found at the samples\googleSpellcheck folder and
-can be easily started using either the batch file or the shell script.</p>
-
-<h4>Google search sample</h4>
-
-<p>This includes a search program that uses the familiar Google search over
-the SOAP API. It utilizes the non-blocking mode of the client API. This
-sample can be found at the samples\googleSearch folder and can be easily
-started using either the batch file or the shell script.</p>
-
-<h4>Amazon queuing service</h4>
-
-<p>Amazon queuing service sample shows how to use the Amazon queuing service.
-it has two user interfaces , one to enqueue and the other dequeue. This
-sample is included in the samples\amazonQS and also contains the batch/shell
-scripts to run.</p>
-
-<h3>Where are these samples ?</h3>
+<p>A simple introduction to each of the above samples are given below. Each
+sample contains it's own help document that speaks about the usage and the
+advanced operations of that particular sample.</p>
<p>The most obvious place to look for the samples are the binary
-distribution. all these samples are included in the samples directory in the
+distribution. All these samples are included in the samples directory in the
binary distribution. The shell scripts and the batch files are in fact
-written to use the binary distributions root directory as the home to find
-the libraries.</p>
+written to use the binary distribution's root directory as the home in order
+to find the libraries.</p>
-<p>The other way is to build the samples from source. Moving to the
+<p>The alternate method is to build the samples from source. Moving to the
modules/samples and running maven will create the samples in the
target/samples directory. However if the samples need to be started using the
shell scripts (or the batch files) then the AXIS_HOME environment need to be
set.( the "guessed" AXIS_HOME would not be correct in this case)</p>
-<h2><a name="Tools"></a>Tools</h2>
+<h3><a name="googlespell">Google Spell Checker Sample</a></h3>
-<p>Axis2 is shipped with two standard tools. Both the tools are Eclipse
[... 58 lines stripped ...]