ws-axis-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chinth...@apache.org
Subject svn commit: r370524 [6/11] - in /webservices/axis2/site: ./ 0_93/ 0_93/adb/ 0_93/tools/idea-guide/ 0_94/ 0_94/adb/ 0_94/images/ 0_94/tools/idea/ modules/ modules/addressing/ modules/wss4j/ modules/wss4j/0_94/0.94/ multiproject/axis2-Samples/ multiproje...
Date Thu, 19 Jan 2006 16:25:06 GMT
Modified: webservices/axis2/site/0_94/userguide.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/site/0_94/userguide.html?rev=370524&r1=370523&r2=370524&view=diff
==============================================================================
--- webservices/axis2/site/0_94/userguide.html (original)
+++ webservices/axis2/site/0_94/userguide.html Thu Jan 19 08:22:01 2006
@@ -2,139 +2,1327 @@
           @import url("../style/maven-base.css");
           
 			    @import url("../style/maven-theme.css");</style><link rel="stylesheet" href="../style/print.css" type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta></head><body class="composite"><div id="banner"><a href="http://www.apache.org/" id="organizationLogo"><img alt="Apache Software Foundation" src="http://www.apache.org/images/asf-logo.gif"></img></a><a href="http://ws.apache.org/axis2/" id="projectLogo"><img alt="Apache Axis 2.0" src="http://ws.apache.org/axis2/images/axis.jpg"></img></a><div class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xleft">
-                	Last published: 18 January 2006
-                  | Doc for 0.95</div><div class="xright"></div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuAxis_2_0"><h5>Axis 2.0</h5><ul><li class="none"><a href="../index.html">Home</a></li><li class="expanded"><a href="../">Download Axis2</a><ul><li class="none"><a href="../download.cgi">Releases</a></li><li class="none"><a href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/?root=Apache-SVN" class="externalLink" title="External Link">Source Code</a></li></ul></li><li class="expanded"><a href="../">Documentation</a><ul><li class="none"><a href="../0_93/index.html">Version 0.93</a></li><li class="none"><a href="../0_94/index.html">Version 0.94</a></li></ul></li><li class="expanded"><a href="../overview.html">Get Involved</a><ul><li class="none"><a href="../svn.html">Checkout the Source</a></li><li class="none"><a href="../siteHowTo.html">Build the Site</a></li><li class="none"><a href="../guidelines.html">Devel
 oper Guidelines</a></li><li class="none"><a href="../refLib.html">Reference Library</a></li><li class="none"><a href="../mail-lists.html">Mailing Lists</a></li><li class="none"><a href="../faq.html">FAQ</a></li></ul></li><li class="none"><a href="../modules/index.html">Modules</a></li><li class="none"><a href="../thanks.html">Acknowledgements</a></li><li class="expanded"><a href="../">Project Information</a><ul><li class="none"><a href="../team-list.html">Project Team</a></li><li class="none"><a href="../issue-tracking.html">Issue Tracking</a></li></ul></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="../images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><a name="Axis2_User_s_Guide"></a><h2>Axis2 User's Guide</h2><p><i>Version 0.94</i></p><p align="right">Pages: <b>Content</b>, <a href="userguide1.html" class="newWindow" title="New Windo
 w" target="_blank">1</a>, <a href="userguide2.html" class="newWindow" title="New Window" target="_blank">2</a>, <a href="userguide3.html" class="newWindow" title="New Window" target="_blank">3</a>, <a href="userguide4.html" class="newWindow" title="New Window" target="_blank">4</a>, <a href="userguide5.html" class="newWindow" title="New Window" target="_blank">5</a></p><div class="subsection"><a name="Content"></a><h3>Content</h3><ul>
-  <li><p><a href="userguide1.html#Axis2_User&apos;s_Guide">Introduction</a></p>
-    <ul>
-      <li><a href="userguide1.html#Attention">Attention</a></li>
-      <li><a href="userguide1.html#What_is_Axis2_">What is Axis2?</a></li>
-      <li><a href="userguide1.html#Axis2_Complete_Features_List">Axis2
-        Complete Features List</a>
-        <ul>
-          <li><a href="userguide1.html#Experimental_Features_List">Experimental
-            Features List</a></li>
-          <li><a href="userguide1.html#Major_Changes_Since_Last_Release">Major
-            Changes Since Last Release</a></li>
-        </ul>
-      </li>
-      <li><a href="userguide1.html#Tools_included_in this_Release">Tools
-        included in this Release</a></li>
-      <li><a href="userguide1.html#What&apos;s_still_to_do_">What's still to
-        do?</a></li>
-    </ul>
-  </li>
-  <li><p><a href="userguide2.html#Axis2_User&apos;s_Guide">Web Services Using
-    Axis2</a></p>
-    <ul>
-      <li><a href="userguide2.html#Writing_Web_Services_Using Axis2&apos;s_Primary_APIs">Writing
-        Web Services using Axis2 APIs</a>
-        <ul>
-          <li><a href="userguide2.html#Creating_Web_Service__MyService_">Creating
-            Web Service (MyService)</a></li>
-          <li><a href="userguide2.html#How_to_write_the_Web_Service_">How to
-            write the Web Service?</a>
-            <ul>
-              <li><a href="userguide2.html#Step1_:Write_the_Implementation_Class">Step1
-                :Write the Implementation Class</a></li>
-              <li><a href="userguide2.html#Step2_:Write_the_services_xml_file">Step2
-                :Write the services.xml file</a></li>
-              <li><a href="userguide2.html#Step3_:Create_the_Web_Service_Archive">Step3
-                :Create the Web Service Archive</a></li>
-              <li><a href="userguide2.html#Step4_:Deploy_the_Web_Service">Step4
-                :Deploy the Web Service</a></li>
-            </ul>
-          </li>
-        </ul>
-      </li>
-      <li><p><a href="userguide2.html#Writing_Web_Services_by_Code_Generating_Skeleton">Writing
-        Web Services by Code Generating Skeleton</a></p>
-        <ul>
-          <li><a href="userguide2.html#WSDL2Java_Tool">WSDL2Java Tool</a></li>
-          <li><a href="userguide2.html#Implement_the_Business_Logic">Implement the
-            Business Logic</a></li>
-          <li><a href="userguide2.html#echoString">echoString</a></li>
-          <li><a href="userguide2.html#echoStringArray">echoStringArray</a></li>
-          <li><a href="userguide2.html#echoStruct">echoStruct</a></li>
-          <li><a href="userguide2.html#services_xml">services.xml</a></li>
-          <li><a href="userguide2.html#Packaging">Packaging</a></li>
-        </ul>
-      </li>
-    </ul>
-  </li>
+                	Last published: 19 January 2006
+                  | Doc for 0.95</div><div class="xright"></div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuAxis_2_0"><h5>Axis 2.0</h5><ul><li class="none"><a href="../index.html">Home</a></li><li class="expanded"><a href="../">Download Axis2</a><ul><li class="none"><a href="../download.cgi">Releases</a></li><li class="none"><a href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/?root=Apache-SVN" class="externalLink" title="External Link">Source Code</a></li></ul></li><li class="expanded"><a href="../">Documentation</a><ul><li class="none"><a href="../0_93/index.html">Version 0.93</a></li><li class="none"><a href="../0_94/index.html">Version 0.94</a></li></ul></li><li class="expanded"><a href="../overview.html">Get Involved</a><ul><li class="none"><a href="../svn.html">Checkout the Source</a></li><li class="none"><a href="../siteHowTo.html">Build the Site</a></li><li class="none"><a href="../guidelines.html">Devel
 oper Guidelines</a></li><li class="none"><a href="../refLib.html">Reference Library</a></li><li class="none"><a href="../mail-lists.html">Mailing Lists</a></li><li class="none"><a href="../faq.html">FAQ</a></li></ul></li><li class="none"><a href="../modules/index.html">Modules</a></li><li class="none"><a href="../thanks.html">Acknowledgements</a></li><li class="expanded"><a href="../">Project Information</a><ul><li class="none"><a href="../team-list.html">Project Team</a></li><li class="none"><a href="../issue-tracking.html">Issue Tracking</a></li></ul></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="../images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><p><a name="_Toc96697849" id="_Toc96697849"></a></p></div><div class="section"><a name="Axis2_User_s____________________Guide"></a><h2>Axis2 User's                    Guide</h2><p><i>Ver
 sion 0.94</i></p><i>User Feedback: <a href="mailto:axis-user@ws.apache.org">axis-user@ws.apache.org</a></i><div class="subsection"><a name="Contents"></a><h3>Contents</h3><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>
 </ul><ul>
-  <li><p><a href="userguide3.html#Axis2_User&apos;s_Guide">Web Service Clients
-    Using Axis2</a></p>
-    <ul>
-      <li><a href="userguide3.html#Writing_Web_Service_Clients_using_Axis2&apos;s_Primary_APIs">Writing
-        Web Service Clients using Axis2's Primary APIs</a>
-        <ul>
-          <li><a href="userguide3.html#EchoBlockingClient">EchoBlockingClient</a></li>
-          <li><a href="userguide3.html#PingClient">PingClient</a></li>
-          <li><a href="userguide3.html#EchoNonBlockingClient">EchoNonBlockingClient</a></li>
-          <li><a href="userguide3.html#EchoNonBlockingDualClient">EchoNonBlockingDualClient</a></li>
-          <li><a href="userguide3.html#EchoBlockingDualClient">EchoBlockingDualClient</a></li>
-        </ul>
-      </li>
-      <li><p><a href="userguide3.html#Writing_Web_Service_Clients_using_Code_Generation_with_Data_Binding_Support">Writing
-        Web Service Clients using Code Generation with Data Binding
-        Support</a></p>
-        <ul>
-          <li><a href="userguide3.html#Client_for_echoVoid_Operation">Client
-            for echoVoid Operation</a></li>
-          <li><a href="userguide3.html#Client_for_echoString_Operation">Client for
-            echoString Operation</a></li>
-          <li><a href="userguide3.html#Client_for_echoStringArray_Operation">Cient for
-            echoStringArray Operation</a></li>
-          <li><a href="userguide3.html#Client_for_echoStruct_Operation">Client for
-            echoStruct Operation</a></li>
-        </ul>
-      </li>
-    </ul>
-  </li>
-  <li><p><a href="userguide4.html#Axis2_User&apos;s_Guide">Modules</a></p>
-    <ul>
-      <li><a href="userguide4.html#MyService_with_a_Logging_Module">MyService
-        with a Logging Module</a>
-        <ul>
-          <li><a href="userguide4.html#Step1_:_LoggingModule_Class">Step1 :
-            LoggingModule Class</a></li>
-          <li><a href="userguide4.html#Step2_:_LogHandler">Step2 :
-            LogHandler</a></li>
-          <li><a href="userguide4.html#Step3_:_module_xml">Step3 :
-            module.xml</a></li>
-          <li><a href="userguide4.html#Step_4:_Modify_the_&quot;axis2_xml&quot;">Step
-            4: Modify the "axis2.xml"</a></li>
-          <li><a href="userguide4.html#Step5_:_Modify_the_&quot;services_xml&quot;">Step5
-            : Modify the "services.xml"</a></li>
-          <li><a href="userguide4.html#Step6_:_Packaging">Step6 :
-            Packaging</a></li>
-          <li><a href="userguide4.html#Step7_:_Deploy_the_Module_in_Axis2">Step7 :
-            Deploy the Module in Axis2</a></li>
-        </ul>
-      </li>
-    </ul>
-  </li>
-  <li><p><a href="userguide5.html#Axis2_User&apos;s_Guide">Other Samples</a></p>
-    <ul>
-      <li><a href="userguide5.html#Google_Spell_Checker_Sample">Google Spell
-        Checker Sample</a></li>
-      <li><a href="userguide5.html#Google_Search_Sample">Google Search
-        Sample</a></li>
-      <li><a href="userguide5.html#Amazon_Queuing_Service">Amazon Queuing
-        Service</a></li>
-    </ul>
-  </li>
-  <li><p>Advanced Topics</p>
-    <ul>
-      <li><a href="rest-ws.html" class="newWindow" title="New Window" target="_blank">RESTful Web Services</a></li>
-      <li><a href="tcp-transport.html" class="newWindow" title="New Window" target="_blank">TCP transport</a></li>
-      <li><a href="mail-transport.html" class="newWindow" title="New Window" target="_blank">Mail
-      Transport</a></li>
-      <li><a href="http-transport.html" class="newWindow" title="New Window" target="_blank">HTTP
-      Transports</a></li>
-      <li><a href="mtom-guide.html" class="newWindow" title="New Window" target="_blank">MTOM with Axis2</a></li>
-      <li><a href="security-module.html" class="newWindow" title="New Window" target="_blank">Securing SOAP
-        Messages with WSS4J</a></li>
-    </ul>
-  </li>
-</ul><p align="right"><a href="userguide1.html" class="newWindow" title="New Window" target="_blank">Next Page <img src="images/arrow_right.gif" alt=""></img></a></p><p>Pages: <b>Content</b>, <a href="userguide1.html" class="newWindow" title="New Window" target="_blank">1</a>, <a href="userguide2.html" class="newWindow" title="New Window" target="_blank">2</a>, <a href="userguide3.html" class="newWindow" title="New Window" target="_blank">3</a>, <a href="userguide4.html" class="newWindow" title="New Window" target="_blank">4</a>, <a href="userguide5.html" class="newWindow" title="New Window" target="_blank">5</a></p></div></div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 2004-2006, Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>
\ No newline at end of file
+    <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>
+        <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><a name="_Toc96698076"></a><a name="Introduction"></a></p></div><div class="subsection"><a name="Introduction"></a><h3>Introduction</h3><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><p><a name="Attention"></a></p></div><div class="subsection"><a name="Attention"></a><h3>Attention</h3><ul>
+    <li>This User's Guide is written based on
+        Axis2 standard binary distribution. (The standard binary distribution can
+        be created from the source distribution using the maven goal <code>$maven
+                                                                           dist-std-bin</code>).
+                                                                                              Please
+                                                                                              refer
+                                                                                              the <a href="installationguide.html#Download">installation guide</a> for further
+                                                                          information on the
+                                                                          downloadables available in
+                                                                          this release.
+    </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" class="newWindow" title="New Window" target="_blank">Axis 1.x User's Guide</a> before you go any further in
+                                                      this guide.</p>
+    </li>
+</ul><p><a name="_Toc96698077"></a><a name="What_is_Axis_2_0__"></a></p></div><div class="subsection"><a name="What_is_____Axis2_"></a><h3>What is     Axis2?</h3><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 in this direction, Axis2
+   now delivers the following key features:</p><ul>
+<li><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.
+</li>
+<li><strong>Low memory foot print</strong>-
+                                          Axis2 was designed ground-up keeping low memory foot
+                                          print in mind.
+</li>
+<li><strong>AXIOM</strong> - Axis2 comes with
+                           its own light-weight object model, AXIOM, for message processing
+                           which is
+                           extensible, high performance and developer convenient
+</li>
+<a name="hotdeployment">
+    </a><li><a name="hotdeployment"><strong>Hot Deployment</strong> - Axis2 is equipped with the capability of
+                                        deploying web service &amp; 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.
+    </a></li>
+    <li><strong>Asynchronous Web
+                Services</strong> - Axis2 now supports asynchronous web services &amp;
+                                  asynchronous web services invocation using non-blocking
+                                  clients and
+                                  transports .
+    </li>
+    <li><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.
+    </li>
+    <li><strong>Flexibility</strong> - The Axis2
+                                     architecture gives the developer complete freedom to insert
+                                     extensions
+                                     into the engine for custom header processing, system
+                                     management, or
+        <em>anything else you can imagine</em>.
+    </li>
+    <li><strong>Stability</strong> - Axis2
+                                   defines a set of published interfaces which change relatively
+                                   slowly
+                                   compared to the rest of Axis.
+    </li>
+    <li><strong>Component-oriented
+                Deployment</strong> - You can easily define reusable networks of Handlers
+                                    to implement common patterns of processing for your
+                                    applications, or to
+                                    distribute to partners.
+    </li>
+    <li><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.
+    </li>
+    <li><strong>WSDL support</strong> - Axis2
+                                      supports the <a href="http://www.w3.org/TR/wsdl" class="newWindow" title="New Window" 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.
+    </li>
+    <li><strong>Add-ons </strong> Several web
+                                  services specifications have been incorporated including <a href="http://ws.apache.org/wss4j/" class="newWindow" title="New Window" target="_blank">WSS4J</a> for
+                                                                         security, <a href="http://ws.apache.org/sandesha/" class="newWindow" title="New Window" target="_blank">Sandesha</a> for reliable messaging, <a href="http://ws.apache.org/kandula/" class="newWindow" title="New Window" target="_blank">Kandula</a> which is
+                                                                             an encapsulation of
+                                                                             WS-Coordination,
+                                                                             WS-AtomicTransaction
+                                                                             and
+                                                                             WS-BusinessActivity.
+    </li>
+    <li><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.
+    </li>
+</ul><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 us a hand! The Axis developer community welcomes your
+   participation.</p><p>Let us know what you think!</p><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><p><a name="Featurelist"></a></p></div><div class="subsection"><a name="Axis2_Complete_Features_List"></a><h3>Axis2 Complete Features List</h3><ol type="1">
+    <li>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>Support for One-Way Messaging (In-Only) and Request Response Messaging
+        (In-Out)</li>
+    <li>Module Architecture, mechanism to extend the SOAP Processing Model</li>
+    <li>Module version support , can have multiple versions of the same module
+        and use them depending on the requirement.</li>
+    <li>Content hierarchy</li>
+    <li>Archive based deployment Model and Directory based deployment model</li>
+    <li>JWS like deployment (making Java class into Web service)</li>
+    <li>WSDL Code Generation Tool for Stub and skeletons</li>
+    <li>WS-Addressing, both the submission (2004/08) and final (2005/08)
+        versions</li>
+    <li>WSS4J module for security</li>
+    <li>Improved and user friendly Client API</li>
+    <li>WSDL2Java</li>
+    <li>REST (REpresentational State Transfer) Support</li>
+    <li>Transports supports: HTTP, SMTP, TCP, JMS</li>
+    <li>Raw XML providers</li>
+    <li>Support for MTOM/ MIME/ SwA</li>
+    <li>SAAJ implementation</li>
+    <li>DOOM - New Feature</li>
+    <li>Pack/Unpack capability for the generated code- New Feature</li>
+    <li>Axis Data Binding - ADB (Framework and Schema Compiler)</li>
+    <li>Numerous bug fixes since last release</li>
+</ol><p><a name="experimental"></a></p></div><div class="subsection"><a name="Axis2_Experimental________________________________________________________Features_List"></a><h3>Axis2 Experimental                                                        Features List</h3><ol type="1">
+    <li>Sessions scoping for Application, SOAP, Transport and Request
+        levels</li>
+    <li>Server side Web Service Policy support</li>
+    <li>?wsdl and ?xsd support</li>
+    <li>Java2WSDL</li>
+    <li>Generating ServiceClient for a given WSDL and invoke the corresponding
+        service using generated client.</li>
+</ol><p><a name="majorchanges"></a></p></div><div class="subsection"><a name="Major_Changes_Since________________________________________________________Last_Release"></a><h3>Major Changes Since                                                        Last Release</h3><ol type="1">
+    <li>Fixing of memory leaks</li>
+    <li>Client API changes , Introducing ServiceClient instead of MEPClient,
+        InOnlyMEPClient, InOutMEPClient, Call. (Please note that the above
+        classes will be deprecated in this release.)</li>
+    <li>Module versioning support , can have multiple versions of the same
+        module and use them depending on the requirement.</li>
+    <li>Code generator improved to process multi-port WSDL's properly</li>
+    <li>Packing and unpacking options for the code generated classes</li>
+</ol><p><a name="toolsinrelease"></a></p></div><div class="subsection"><a name="Tools_Included_In_This________________________________________________________Release"></a><h3>Tools Included In This                                                        Release</h3><ol type="1">
+    <li>Axis2 Web Application (Web App)</li>
+    <li>WSDL2WS- <a href="CodegenTools-EclipsePlugin.html" class="newWindow" title="New Window" target="_blank">Eclipse plugin</a><a>/ </a><a href="CodegenToolReference.html" class="newWindow" title="New Window" target="_blank">Command line
+                                                             version</a><a>/ </a><a href="tools/idea/Idea_plug-in_userguide.html#WSDL2Java_Code_Generation">IntelliJ
+                                                                                    IDEA plugin</a>
+    </li>
+    <li>Service Archive Wizard- <a href="ServiceArchiveToolReference.html" class="newWindow" title="New Window" target="_blank">Eclipse plugin</a>/ <a href="tools/idea/Idea_plug-in_userguide.html#Create_Service_Archive">IntelliJ
+                                                                                 IDEA plugin</a>
+    </li>
+</ol><p><a href="http://ws.apache.org/axis2/download.cgi" class="externalLink" title="External Link">Download</a> above plugins
+
+</p></div><div class="subsection"><a name="What_s_Still_To_Do_"></a><h3>What's Still To Do?</h3><p>See list of what we think needs to be done, and consider helping out if
+   you're interested &amp; able!</p><ol type="1">
+    <li>JAX-RPC 1.1 and/or JAX-WS compliance</li>
+    <li>SOAP Encoding</li>
+    <li>Binary serialization and de-serialization support</li>
+    <li>Management Interface for Axis2</li>
+    <li>Implementation of other Transports.</li>
+    <li>Resource framework implementation (WS-RF) and Enterprise web services
+        such as JSR 109 support</li>
+    <li>Completion of interop tests</li>
+</ol><p><a name="samples"></a></p></div><div class="subsection"><a name="Samples"></a><h3>Samples</h3><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><p><a name="WS"></a></p></div><div class="subsection"><a name="Web_Services_Using_Axis2"></a><h3>Web Services Using Axis2</h3><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" class="newWindow" title="New Window" 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">Use Axis2's primary interfaces (APIs) and implement
+                         the business logic.</a></li>
+    <li><p><a href="#generateskl">Start from the WSDL -&gt;Code generate the
+                                  Skeleton -&gt;Implement the Business Logic.</a></p>
+    </li>
+</ol><p><a name="WSapi"></a></p></div><div class="subsection"><a name="Writing_Web_Services_Using_Axis2_s_Primary_APIs"></a><h3>Writing Web Services Using Axis2's Primary APIs</h3><p><a name="CreateWS"></a></p></div><div class="subsection"><a name="Creating_Web_Service__MyService_"></a><h3>Creating Web Service (MyService)</h3><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
+   Web Service with two operations as follows.</p>
+    <div class="source"><pre>public void ping(OMElement element){} //IN-ONLY operation, just accepts the OMElement and do
+     some processing.
+     public OMElement echo(OMElement element){}//IN-OUT operation, accepts an OMElement and
+     //responds with another OMElement after processing.
+
+</pre></div>
+  <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 do. Now let's see how we can write the deployment
+   descriptors for the service and deploy it.</p></div><div class="subsection"><a name="How_to_write_the_Web_Service_"></a><h3>How to write the Web Service?</h3><p>
+                                                               Writing a new Web Service with Axis2
+                                                               involve four steps:
+<ol>
+    <li>Write the Implementation Class
+    </li>
+    <li>Write a services.xml file to explain the
+        Web Service
+    </li>
+    <li>create a *.aar archive (Axis Archive) for
+        the Web Service
+    </li>
+    <li><p>Deploy the Web Service</p>
+    </li>
+</ol></p></div><div class="subsection"><a name="Step1_:Write_the_Implementation_Class"></a><h3>Step1 :Write the Implementation Class</h3><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
+   Service. Unless you have data binding the signature of the methods can have
+   one parameter of type OMElement.</p>
+    <div class="source"><pre>public class MyService{
+     public void ping(OMElement element){
+     ......
+     }
+     public OMElement echo(OMElement element){
+     ......
+     }
+     }
+
+</pre></div>
+  </div><div class="subsection"><a name="Step2_:Write_the_services_xml_file"></a><h3>Step2 :Write the services.xml file</h3><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.</p>
+    <div class="source"><pre>&lt;service &gt;
+     &lt;description&gt;
+     This is a sample Web Service with two operations, echo and ping.
+     &lt;/description&gt;
+     &lt;parameter name="ServiceClass" locked="false"&gt;userguide.example1.MyService&lt;/parameter&gt;
+     &lt;operation name="echo"&gt;
+     &lt;messageReceiver class="org.apache.axis2.receivers.RawXMLINOutMessageReceiver"/&gt;
+     &lt;/operation&gt;
+     &lt;operation name="ping"&gt;
+     &lt;messageReceiver class="org.apache.axis2.receivers.RawXMLINOnlyMessageReceiver"/&gt;
+     &lt;/operation&gt;
+     &lt;/service&gt;
+
+</pre></div>
+  <p><em>The above XML tags can be explained as follows:</em></p><p>Name of the service will be the name of the archive file , if and only if
+   the services.xml contains only one service element.</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
+   format.</p>
+    <div class="source"><pre>&lt;serviceGroup&gt;
+     &lt;service name="Service1"&gt;
+     &lt;!-- details for Service1 --&gt;
+     &lt;/service&gt;
+     &lt;service name="Service2"&gt;
+     &lt;!-- details for Service2 --&gt;
+     &lt;/service&gt;
+     &lt;module ref="ModuleName" /&gt;
+     &lt;parameter name="serviceGroupParam1" locked="false"&gt;value 1&lt;/parameter&gt;
+     &lt;/serviceGroup&gt;
+
+</pre></div>
+  <p>Note : name of the service is a compulsory attribute</p></div><div class="subsection"><a name="Step3_:Create_the_Web_Service_Archive"></a><h3>Step3 :Create the Web Service Archive</h3><p>Axis2 use ".aar" (Axis Archive) file as the deployment package for Web
+   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 alt="" src="images/userguide/ServiceItems.jpg" name="Graphic1" align="bottom" width="176" height="91" border="0"></img></p><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. Now let's use it...</p></div><div class="subsection"><a name="Step4_:Deploy_the_Web_Service"></a><h3>Step4 :Deploy the Web Service</h3><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, 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" class="newWindow" title="New Window" 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 alt="" src="images/userguide/MyServiceDeployed.jpg" name="Graphic2" align="bottom" width="734" height="766" border="0"></img></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" class="newWindow" title="New Window" target="_blank">Web Administration Guide</a> for
+                                                                               more information on
+                                                                               this)</p></div><div class="subsection"><a name="Writing_Web_Services_by_Code_Generating___________________________Skeleton"></a><h3>Writing Web Services by Code Generating                           Skeleton</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></div><div class="subsection"><a name="WSDL2Java_Tool"></a><h3>WSDL2Java Tool</h3><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
+   of the distribution and can be executed using the provided scripts (.bat or
+   .sh). The tool's parameter list is as follows and user can specify these
+   values depending on their requirements.</p>
+    <div class="source"><pre>Usage WSDL2Code -uri :WSDL file location
+     -o : output file location
+     -a : Generate async style code only. Default if off
+     -s : Generate sync style code only. Default if off. takes precedence over -a
+     -p : set custom package name
+     -l : valid languages are java and csharp. Default is java
+     -t : Generate TestCase to test the generated code
+     -ss : Generate server side code (i.e. skeletons).Default is off
+     -sd : Generate service descriptor (i.e. axis2.xml).Default is off.Valid with -ss
+
+</pre></div>
+  <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>
+    <div class="source"><pre>WSDL2Java -uri ..\samples\wsdl\Axis2SampleDocLit.wsdl -d xmlbeans
+                                  -ss -sd -o ..\samples -p org.apache.axis2.userguide
+
+</pre></div>
+  <p>Linux users should switch the file separator:</p>
+    <div class="source"><pre>WSDL2Java -uri ../samples/wsdl/Axis2SampleDocLit.wsdl -d xmlbeans
+                                  -ss -sd -o ../samples -p org.apache.axis2.userguide
+
+</pre></div>
+  <p>This will generate the required classes in the <b>src</b> directory inside
+   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></div><div class="subsection"><a name="Implement_the_Business_Logic"></a><h3>Implement the Business Logic</h3><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 now easily implement the business logic. The
+   WSDL we have used has three operations:
+</p><ul>
+    <li>echoString - Operation that echoes a
+        String value
+    </li>
+    <li>echoStringArray - Operation that accept
+        string array as the input and echoes them back
+    </li>
+    <li><p>echoStruct - Operation that accept a Struct as the input and echoes
+           them back.</p>
+    </li>
+</ul><p><a name="echostring"></a></p></div><div class="subsection"><a name="echoString"></a><h3>echoString</h3><p>Locate the following code segment in the
+   "Axis2SampleDocLitPortTypeSkeleton.java" and fill the business logic as
+   shown below.</p>
+    <div class="source"><pre> public org.soapinterop.xsd.EchoStringArrayReturnDocument
+      echoStringArray(org.soapinterop.xsd.EchoStringArrayParamDocument param2){
+      //To do fill this with the necessary business logic
+      return null;
+      }
+
+</pre></div>
+  <p>Once filled with the business logic it will be as follows. The code is
+   simple and the explanations are given as comments.</p>
+    <div class="source"><pre>public org.soapinterop.xsd.EchoStringReturnDocument
+     echoString(org.soapinterop.xsd.EchoStringParamDocument param6) {
+     //Use the factory to create the output document.
+     EchoStringReturnDocument retDoc = EchoStringReturnDocument.Factory.newInstance();
+     //send the string back.
+     retDoc.setEchoStringReturn(param6.getEchoStringParam());
+     return retDoc;
+     }
+
+</pre></div>
+  <p>Similarly following code fragments shows how you can fill the business
+   logic for our first web service.</p></div><div class="subsection"><a name="echoStringArray"></a><h3>echoStringArray</h3>
+    <div class="source"><pre>public org.soapinterop.xsd.EchoStringArrayReturnDocument
+     echoStringArray(org.soapinterop.xsd.EchoStringArrayParamDocument param2) {
+
+     //Use the factory to create the output document.
+     EchoStringArrayReturnDocument retDoc = EchoStringArrayReturnDocument.Factory.newInstance();
+
+     //Get the String array from the input parameters.
+     String[] inParams = param2.getEchoStringArrayParam().getStringArray();
+     ArrayOfstringLiteral retParams = 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>
+  </div><div class="subsection"><a name="echoStruct"></a><h3>echoStruct</h3>
+    <div class="source"><pre>public org.soapinterop.xsd.EchoStructReturnDocument
+     echoStruct(org.soapinterop.xsd.EchoStructParamDocument param4) {
+
+     //Use the factory to create the output document.
+     EchoStructReturnDocument retDoc = EchoStructReturnDocument.Factory.newInstance();
+
+     //Get the SOAPStrcut from the incoming parameters
+     SOAPStruct inStruct = param4.getEchoStructParam();
+
+     //Struct for the sending back
+     SOAPStruct outStruct = 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>
+  </div><div class="subsection"><a name="services_xml"></a><h3>services.xml</h3><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. This can be found in the same directory as the skeleton. The
+   generated services.xml is as follows.</p>
+    <div class="source"><pre>&lt;!--Auto generated Axis Service XML--&gt;
+     &lt;service name="Axis2SampleDocLitPortTypeSkeletonTest"&gt;
+     &lt;parameter locked="xsd:false" name="ServiceClass"&gt;userguide.Axis2SampleDocLitPortTypeSkeleton&lt;/parameter&gt;
+     &lt;!--Mounting the method echoStringArray--&gt;
+     &lt;operation name="echoStringArray"&gt;
+     &lt;messageReceiver class="userguide.Axis2SampleDocLitPortTypeMessageReceiver"/&gt;
+     &lt;/operation&gt;
+     &lt;!--Mounting the method echoStruct--&gt;
+     &lt;operation name="echoStruct"&gt;
+     &lt;messageReceiver class="userguide.Axis2SampleDocLitPortTypeMessageReceiver"/&gt;
+     &lt;/operation&gt;
+     &lt;!--Mounting the method echoString--&gt;
+     &lt;operation name="echoString"&gt;
+     &lt;messageReceiver class="userguide.Axis2SampleDocLitPortTypeMessageReceiver"/&gt;
+     &lt;/operation&gt;
+     &lt;/service&gt;
+
+</pre></div>
+  <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></div><div class="subsection"><a name="Packaging"></a><h3>Packaging</h3><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. 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 alt="" src="images/userguide/DirectoryStructure.JPG" align="bottom" width="164" height="142" border="0"></img></p><p>Go to the top level directory where you can find the class files for the
+   above service (i.e. one level up on the directory structure shown above),
+   then type the following command in a command line.</p>
+    <div class="source"><pre>jar -cf Axis2SampleDocLitPortType.aar .
+
+</pre></div>
+  <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, 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" class="newWindow" title="New Window" 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 alt="" src="images/userguide/ServiceDeployed.JPG" name="Graphic4" align="bottom" width="734" height="764" border="0"></img></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" class="newWindow" title="New Window" target="_blank">Web Administration Guide</a> for
+                                                                               more information on
+                                                                               this)</p></div><div class="subsection"><a name="Web_Service_Clients_Using___________________________________________________Axis2"></a><h3>Web Service Clients Using                                                   Axis2</h3><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
+   "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 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><b>Blocking API</b> -Once the service
+                            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.
+    </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 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 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 &amp; Transport Level Asynchrony we can
+   obtain four different invocation patterns for web services as shown in the
+   following table.</p><p><a name="table1"></a><table class="bodyTable"><tbody>
+        <tr class="b"><td width="33%" height="19"><p><strong>API
+                                                   (Blocking/Non-Blocking)</strong></p>
+            </td><td width="33%"><p><strong>Dual Transports (Yes/No)</strong></p>
+            </td><td width="33%"><p><strong>Description</strong></p>
+            </td></tr>
+        <tr class="a"><td width="33%" height="19"><p>Blocking</p>
+            </td><td width="33%"><p>No</p>
+            </td><td width="33%"><p>Simplest and the familiar invocation pattern</p>
+            </td></tr>
+        <tr class="b"><td width="33%" height="19"><p>Non-Blocking</p>
+            </td><td width="33%"><p>No</p>
+            </td><td width="33%"><p>Using callbacks or polling</p>
+            </td></tr>
+        <tr class="a"><td width="33%" height="19"><p>Blocking</p>
+            </td><td width="33%"><p>Yes</p>
+            </td><td width="33%"><p>This is useful when the service operation is IN-OUT
+                               in nature but the transport used is One-Way (e.g. SMTP)</p>
+            </td></tr>
+        <tr class="b"><td width="33%" height="19"><p>Non-Blocking</p>
+            </td><td width="33%"><p>Yes</p>
+            </td><td width="33%"><p>This is can be used to gain the maximum asynchronous
+                               behavior. No blocking in the API level and also in the transport
+                               level</p>
+            </td></tr>
+    </tbody></table></p><p>Axis2 provides the user with all these possibilities to invoke Web
+   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></div><div class="subsection"><a name="Writing_Web_Service_Clients_Using_Axis2_s_Primary___________________________APIs"></a><h3>Writing Web Service Clients Using Axis2's Primary                           APIs</h3></div><div class="subsection"><a name="EchoBlockingClient"></a><h3>EchoBlockingClient</h3><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. 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>
+    <div class="source"><pre> try {
+      OMElement payload = ClientUtil.getEchoOMElement();
+    
+
+    
+
+      StringWriter writer = new StringWriter();
+      result.serializeWithCache(new
+      OMOutput(XMLOutputFactory.newInstance().createXMLStreamWriter(writer)));
+      writer.flush();
+
+      System.out.println(writer.toString());
+
+      } catch (AxisFault axisFault) {
+      axisFault.printStackTrace();
+      } catch (XMLStreamException e) {
+      e.printStackTrace();
+      }
+      }
+
+</pre></div>
+  <p>The green lines shows the set of operations that you need to perform
+   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></div><div class="subsection"><a name="PingClient"></a><h3>PingClient</h3><p>In the Web Service "MyService" we had a IN-ONLY operation with the name
+   "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>
+    <div class="source"><pre> try {
+      OMElement payload = ClientUtil.getPingOMElement();
+      Options options = new Options();
+      options.setTo(targetEPR);
+      ServiceClient serviceClient = new ServiceClient();
+      serviceClient.setOptions(options);
+      serviceClient.fireAndForget(payload);
+
+      }
+      catch (AxisFault axisFault) {
+      axisFault.printStackTrace();
+      }
+
+</pre></div>
+  <p>Since we are accessing a IN-ONLY operation we can directly use the
+   "fireAndForget()" in ServiceClient to invoke this operation , and that 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></div><div class="subsection"><a name="EchoNonBlockingClient"></a><h3>EchoNonBlockingClient</h3><p>In the EchoBlockingClient once the "serviceCleint.sendReceive(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
+   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 user may have to do
+   with respect to the "EchoBlockingClient" that we have already seen, it will
+   be as follows:</p>
+    <div class="source"><pre>serviceClient.sendReceiveNonblocking(payload, callback);
+
+</pre></div>
+  <p>The invocation accepts a callback object as a parameter. Axis2 client API
+   provides an abstract Callback with the following methods:</p>
+    <div class="source"><pre>public abstract void onComplete(AsyncResult result);
+     public abstract void onError(Exception e);
+     public boolean isComplete() {}
+
+</pre></div>
+  <p>The user is expected to implement the "onComplete " and "onError " methods
+   of their extended call back class. Axis2 engine calls the onComplete method
+   once the Web Service response is received by the Axis2 Client API
+   (ServiceClient). This will eliminate the blocking nature of the Web Service
+   invocations and provides the user with the flexibility to use Non Blocking
+   API for Web Service Clients.</p><p>To run the sample client ( EchoNonBlockingClient) you can simply use the
+   "testEchoNonBlockingClient" target of the ant file found at the
+   "Axis2Home/samples" directory.</p></div><div class="subsection"><a name="EchoNonBlockingDualClient"></a><h3>EchoNonBlockingDualClient</h3><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 (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/" class="newWindow" title="New Window" target="_blank">WS-Addressing</a> provides a neat solution to this using
+                                         &lt;wsa:MessageID&gt; and &lt;wsa:RelatesTo&gt; 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 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>
+    <div class="source"><pre> try {
+      OMElement payload = ClientUtil.getEchoOMElement();
+      Options options = new Options(); options.setTo(targetEPR);
+      options.setListenerTransportProtocol(Constants.TRANSPORT_HTTP);
+
+      //The boolean flag informs the axis2 engine to use two separate transport connection
+      //to retrieve the response.
+     options.setUseSeparateListener(true);
+
+          ServiceClient serviceClinet = new ServiceClinet();
+     serviceClinet.setOptions(options);
+
+    //Callback to handle the response
+    Callback callback = new Callback() {
+    public void onComplete(AsyncResult result) {
+    try {
+    StringWriter writer = new StringWriter();
+    result.serializeWithCache(new OMOutput(XMLOutputFactory.newInstance()
+    .createXMLStreamWriter(writer)));
+    writer.flush();
+
+    System.out.println(writer.toString());
+
+    } catch (XMLStreamException e) {
+    onError(e);
+    }
+    }
+
+    public void onError(Exception e) {
+    e.printStackTrace();
+    }
+    };
+
+    //Non-Blocking Invocation
+    serviceClinet.sendReceiveNonblocking(payload, callback);
+
+    //Wait till the callback receives the response.
+    while (!callback.isComplete()) {
+    Thread.sleep(1000);
+    }
+    
+
+    } catch (AxisFault axisFault) {
+    axisFault.printStackTrace();
+    } catch (Exception ex) {
+    ex.printStackTrace();
+    }
+
+</pre></div>
+  <p><font color="#0000ff"><font color="#000000">The boolean flag (value true)
+                                               in the "<b>options.setUseSeparateListener(...)</b>"
+                                               method informs the Axis2
+                                               engine to use separate transport connections for
+                                               request and response.
+                                               Finally "<b>serviceClinet.finalizeInvoke()</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="Axis2ArchitectureGuide.html" class="newWindow" title="New Window" 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>
+    <div class="source"><pre> &lt;module ref="addressing"/&gt;
+
+</pre></div>
+  <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. 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></div><div class="subsection"><a name="EchoBlockingDualClient"></a><h3>EchoBlockingDualClient</h3><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="http-transport.html" class="newWindow" title="New Window" target="_blank">Configuring
+                                                     Transports</a> for use different transports.
+</p></div><div class="subsection"><a name="Writing_Web_Service_Clients_using_Code_Generation___________________________with_Data_Binding_Support"></a><h3>Writing Web Service Clients using Code Generation                           with Data Binding Support</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 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>
+    <div class="source"><pre>WSDL2Java -uri ..\samples\wsdl\Axis2SampleDocLit.wsdl -o
+                                  ..\samples\src -p org.apache.axis2.userguide
+
+</pre></div>
+  <p>This will generate the required stub "Axis2SampleDocLitPortTypeStub.java"
+   that can be used to invoke the Web Service Axis2SampleDocLitPortType. Let's
+   see how we can use this stub to write Web Service clients to utilize the Web
+   Service Axis2SampleDocLitPortType (the service that we have already
+   deployed).</p></div><div class="subsection"><a name="Client_for_echoVoid_Operation"></a><h3>Client for echoVoid Operation</h3><p>Following code fragment shows the necessary code for utilizing the
+   echoVoid operation of the Axis2SampleDocLitPortType that we have already
+   deployed. In this operation, a blank SOAP body element is sent to the Web
+   Service and the same SOAP envelope is echoed back.</p>
+    <div class="source"><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
+      Axis2SampleDocLitPortTypeStub stub = new Axis2SampleDocLitPortTypeStub(null,
+      "http://localhost:8080/axis2/services/Axis2SampleDocLitPortType");
+      stub.echoVoid();
+
+      } catch (Exception e) {
+      e.printStackTrace();
+      }
+
+</pre></div>
+  </div><div class="subsection"><a name="Client_for_echoString_Operation"></a><h3>Client for echoString Operation</h3><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 in
+   the form of comments.</p>
+    <div class="source"><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
+     Axis2SampleDocLitPortTypeStub stub= new Axis2SampleDocLitPortTypeStub(null,
+     "http://localhost:8080/axis2/services/Axis2SampleDocLitPortType");
+     //Create the request document to be sent.
+     EchoStringParamDocument reqDoc= EchoStringParamDocument.Factory.newInstance();
+     reqDoc.setEchoStringParam("Axis2 Echo");
+     //invokes the web service.
+     EchoStringReturnDocument resDoc=stub.echoString(reqDoc);
+     System.out.println(resDoc.getEchoStringReturn());
+
+     } catch (Exception e) {
+     e.printStackTrace();
+     }
+
+</pre></div>
+  <p>Similarly following code fragments show client side code for
+   echoStringArray operation and echoStruct operation respectively.</p></div><div class="subsection"><a name="Client_for_echoStringArray_____________________________________Operation"></a><h3>Client for echoStringArray                                     Operation</h3>
+    <div class="source"><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
+     Axis2SampleDocLitPortTypeStub stub = new Axis2SampleDocLitPortTypeStub(null,
+     "http://localhost:8080/axis2/services/Axis2SampleDocLitPortType");
+
+     //Create the request document to be sent.
+     EchoStringArrayParamDocument reqDoc = EchoStringArrayParamDocument.Factory.newInstance();
+     ArrayOfstringLiteral paramArray = ArrayOfstringLiteral.Factory.newInstance();
+
+     paramArray.addString("Axis2");
+     paramArray.addString("Echo");
+
+     reqDoc.setEchoStringArrayParam(paramArray);
+     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 (Exception e) {
+     e.printStackTrace();
+     }
+
+</pre></div>
+  </div><div class="subsection"><a name="Client_for_echoStruct_Operation"></a><h3>Client for echoStruct Operation</h3>
+    <div class="source"><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
+     Axis2SampleDocLitPortTypeStub stub = new Axis2SampleDocLitPortTypeStub(null,
+     "http://localhost:8080/axis2/services/Axis2SampleDocLitPortType");
+     //Create the request Document
+     EchoStructParamDocument reqDoc = EchoStructParamDocument.Factory.newInstance();
+
+     //Create the complex type
+     SOAPStruct reqStruct = SOAPStruct.Factory.newInstance();
+
+     reqStruct.setVarFloat(100.50F);
+     reqStruct.setVarInt(10);
+     reqStruct.setVarString("High");
+
+     reqDoc.setEchoStructParam(reqStruct);
+
+     //Service invocation
+     EchoStructReturnDocument resDoc = stub.echoStruct(reqDoc);
+     SOAPStruct resStruct = resDoc.getEchoStructReturn();
+
+     System.out.println("floot Value :" + resStruct.getVarFloat());
+     System.out.println("int Value :" + resStruct.getVarInt());
+     System.out.println("String Value :" + resStruct.getVarString());
+
+     } catch (Exception e) {
+     e.printStackTrace();
+     }
+
+</pre></div>
+  </div><div class="subsection"><a name="Modules"></a><h3>Modules</h3><p>Axis2 provides an extended support for modules (See <a 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>Create the Module Implementation
+    </li>
+    <li>Create the Handlers
+    </li>
+    <li>Create the module.xml
+    </li>
+    <li>Modify the "axis2.xml" (if you need
+        custom phases)
+    </li>
+    <li>Modify the "services.xml" to engage
+        modules at the deployment time.
+    </li>
+    <li>Package in a ".mar" (Module Archive)
+    </li>
+    <li><p>Deploy the module in Axis2</p>
+    </li>
+</ol></div><div class="subsection"><a name="MyService_with_a_Logging_Module"></a><h3>MyService with a Logging Module</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 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><p><img alt="" src="images/userguide/ModuleView.jpg" name="Graphic5" align="bottom" width="185" height="120" border="0"></img></p></div><div class="subsection"><a name="Step1_:_LoggingModule_Class"></a><h3>Step1 : LoggingModule Class</h3><p>LoggingModule is the implementation class of the Axis2 module. Axis2
+   modules should implement the "org.apache.axis2.modules.Module" interface with
+   the following methods.</p>
+    <div class="source"><pre>public void init(AxisConfiguration axisSystem) throws AxisFault;//Initialize the module
+     public void shutdown(AxisConfiguration axisSystem) throws AxisFault;//End of module
+     processing
+
+</pre></div>
+  <p>These methods can be used to control the module initialization and the
+   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></div><div class="subsection"><a name="Step2_:_LogHandler"></a><h3>Step2 : LogHandler</h3><p>A module in Axis2 can contain, one or more handlers that perform various
+   SOAP header processing at different phases. (See<a href="Axis2ArchitectureGuide.html" class="newWindow" title="New Window" 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>
+    <div class="source"><pre>public class LogHandler extends AbstractHandler implements Handler {
+     private Log log = LogFactory.getLog(getClass());
+     private QName name;
+
+     public QName getName() {
+     return name;
+     }
+
+     public void invoke(MessageContext msgContext) throws AxisFault {
+     log.info(msgContext.getEnvelope().toString());
+     }
+
+     public void revoke(MessageContext msgContext) {
+     log.info(msgContext.getEnvelope().toString());
+     }
+
+     public void setName(QName name) {
+     this.name = name;
+     }
+     }
+
+</pre></div>
+  </div><div class="subsection"><a name="Step3_:_module_xml"></a><h3>Step3 : module.xml</h3><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 various handlers that will
+   run in different phases). "module.xml" for the logging module will be as
+   follows:</p>
+    <div class="source"><pre>&lt;module name="logging" class="userguide.loggingmodule.LoggingModule "&gt;
+     &lt;inflow&gt;
+     &lt;handler name="InFlowLogHandler" class="userguide.loggingmodule.LogHandler"&gt;
+     &lt;order phase="loggingPhase" /&gt;
+     &lt;/handler&gt;
+     &lt;/inflow&gt;
+
+     &lt;outflow&gt;
+     &lt;handler name="OutFlowLogHandler" class="userguide.loggingmodule.LogHandler"&gt;
+     &lt;order phase="loggingPhase"/&gt;
+     &lt;/handler&gt;
+     &lt;/outflow&gt;
+
+     &lt;Outfaultflow&gt;
+     &lt;handler name="FaultOutFlowLogHandler" class="userguide.loggingmodule.LogHandler"&gt;
+     &lt;order phase="loggingPhase"/&gt;
+     &lt;/handler&gt;
+     &lt;/Outfaultflow&gt;
+
+     &lt;INfaultflow&gt;
+     &lt;handler name="FaultInFlowLogHandler" class="userguide.loggingmodule.LogHandler"&gt;
+     &lt;order phase="loggingPhase"/&gt;
+     &lt;/handler&gt;
+     &lt;/INfaultflow&gt;
+     &lt;/module&gt;
+
+</pre></div>
+  <p>As it can be seen there are four phases defined in this "module.xml"</p><ol>
+    <li>inflow - Represents the handler chain that will run when
+        a message is coming in. </li>
+    <li>outflow - Represents the
+        handler chain that will run when the message is going out.
+    </li>
+    <li>Outfaultflow - Represents the
+        handler chain that will run when there is a fault and the fault is going
+        out
+    </li>
+    <li><p>INfaultflow - Represents the handler chain that will run when
+           there is a fault and the fault is coming in </p>
+    </li>
+</ol><p>Following set of tags describe the name of the handler, handler class and
+   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. "&lt;order
+   phase="loggingPhase" /&gt;" describes the phase in which this handler
+   runs.</p>
+    <div class="source"><pre>&lt;handler name="InFlowLogHandler" class="userguide.loggingmodule.LogHandler"&gt;
+     &lt;order phase="loggingPhase" /&gt;
+     &lt;/handler&gt;
+
+</pre></div>
+  <p>To learn more on Phase rules, click on <a href="http://www.developer.com/java/web/article.php/3529321" class="newWindow" title="New Window" target="_blank">here</a></p></div><div class="subsection"><a name="Step_4:_Modify_the_&quot;axis2_xml&quot;"></a><h3>Step 4: Modify the "axis2.xml"</h3><p>In this handler the phase "loggingPhase" is defined by the module writer.
+   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" ( 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>
+    <div class="source"><pre>&lt;!-- ================================================= --&gt;
+     &lt;!-- Phases --&gt;
+     &lt;!-- ================================================= --&gt;
+
+     &lt;phaseOrder type="inflow"&gt;
+     &lt;!-- System pre defined phases --&gt;
+     &lt;phase name="TransportIn"/&gt;
+     &lt;phase name="PreDispatch"/&gt;
+     &lt;phase name="Dispatch" class="org.apache.axis2.engine.DispatchPhase"&gt;
+     &lt;handler name="AddressingBasedDispatcher"
+     class="org.apache.axis2.engine.AddressingBasedDispatcher"&gt;
+     &lt;order phase="Dispatch"/&gt;
+     &lt;/handler&gt;
+
+     &lt;handler name="RequestURIBasedDispatcher"
+     class="org.apache.axis2.engine.RequestURIBasedDispatcher"&gt;
+     &lt;order phase="Dispatch"/&gt;
+     &lt;/handler&gt;
+
+     &lt;handler name="SOAPActionBasedDispatcher"

[... 154 lines stripped ...]


Mime
View raw message