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 di...@apache.org on 2008/05/01 23:20:38 UTC
svn commit: r652665 [17/45] - in /webservices/axis2/site: ./ 1_4/ 1_4/adb/
1_4/adb/images/ 1_4/images/ 1_4/images/archi-guide/ 1_4/images/userguide/
1_4/jibx/ 1_4/src/ css/ download/0_9/ download/0_91/ download/0_92/
download/0_93/ download/0_94/ downl...
Added: webservices/axis2/site/1_4/userguide.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/1_4/userguide.html?rev=652665&view=auto
==============================================================================
--- webservices/axis2/site/1_4/userguide.html (added)
+++ webservices/axis2/site/1_4/userguide.html Thu May 1 14:20:27 2008
@@ -0,0 +1,655 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+
+
+
+
+
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven - </title>
+ <style type="text/css" media="all">
+ @import url("../css/maven-base.css");
+ @import url("../css/maven-theme.css");
+ @import url("../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../" id="bannerLeft">
+
+ <img src="http://www.apache.org/images/asf_logo_wide.png" alt="" />
+
+ </a>
+ <span id="bannerRight">
+
+ <img src="../../images/axis.jpg" alt="" />
+
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+
+ <div class="xleft">
+ Last Published: 2008-05-01
+ </div>
+ <div class="xright"> <a href="../index.html">Axis2/Java</a>
+ |
+ <a href="../../c">Axis2/C</a>
+ |
+ <a href="../../..">Apache WS</a>
+ |
+ <a href="http://www.apache.org" class="externalLink">Apache</a>
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+
+
+
+
+
+
+
+ <h5>Axis2/Java</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../index.html">Home</a>
+ </li>
+ </ul>
+ <h5>Downloads</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../download.cgi">Releases</a>
+ </li>
+
+ <li class="none">
+ <a href="../modules/index.html">Modules</a>
+ </li>
+
+ <li class="none">
+ <a href="../tools/index.html">Tools</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="../1_4/contents.html">Version 1.4</a>
+ <ul>
+
+ <li class="none">
+ <a href="../1_4/toc.html">Table of Contents</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/installationguide.html">Installation Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/quickstartguide.html">QuickStart Guide</a>
+ </li>
+
+ <li class="none">
+ <strong>User Guide</strong>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/jaxws-guide.html">JAXWS Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/pojoguide.html">POJO Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/spring.html">Spring Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/webadminguide.html">Web Administrator's Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/migration.html">Migration Guide (from Axis1)</a>
+ </li>
+ </ul>
+ </li>
+
+ <li class="none">
+ <a href="../1_3/contents.html">Version 1.3</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_2/contents.html">Version 1.2</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_1_1/contents.html">Version 1.1.1</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_1/contents.html">Version 1.1</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_0/index.html">Version 1.0</a>
+ </li>
+
+ <li class="none">
+ <a href="../0_95/index.html">Version 0.95</a>
+ </li>
+
+ <li class="none">
+ <a href="../0_94/index.html">Version 0.94</a>
+ </li>
+
+ <li class="none">
+ <a href="../0_93/index.html">Version 0.93</a>
+ </li>
+ </ul>
+ <h5>Resources</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../faq.html">FAQ</a>
+ </li>
+
+ <li class="none">
+ <a href="../articles.html">Articles</a>
+ </li>
+
+ <li class="none">
+ <a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink">Wiki</a>
+ </li>
+
+ <li class="none">
+ <a href="../refLib.html">Reference Library</a>
+ </li>
+
+ <li class="none">
+ <a href="../../1_4/api/index.html">Online Java Docs</a>
+ </li>
+ </ul>
+ <h5>Get Involved</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../overview.html">Overview</a>
+ </li>
+
+ <li class="none">
+ <a href="../svn.html">Checkout the Source</a>
+ </li>
+
+ <li class="none">
+ <a href="../mail-lists.html">Mailing Lists</a>
+ </li>
+
+ <li class="none">
+ <a href="../release-process.html">Release Process</a>
+ </li>
+
+ <li class="none">
+ <a href="../guidelines.html">Developer Guidelines</a>
+ </li>
+
+ <li class="none">
+ <a href="../siteHowTo.html">Build the Site</a>
+ </li>
+ </ul>
+ <h5>Project Information</h5>
+ <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>
+
+ <li class="none">
+ <a href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/?root=Apache-SVN" class="externalLink">Source Code</a>
+ </li>
+
+ <li class="none">
+ <a href="../thanks.html">Acknowledgements</a>
+ </li>
+
+ <li class="none">
+ <a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink">License</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
+ </a>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><meta name="generator" content="HTML Tidy for Windows (vers 14 June 2007), see www.w3.org"><meta http-equiv="content-type" content="">Apache Axis2 User's Guide- Introducing Axis2<link href="../css/axis-docs.css" rel="stylesheet" type="text/css" media="all"></head><h1>Apache Axis2 User's Guide</h1><p>This guide provides a starting place for users who are new to
+Apache Axis2. It also covers some advanced topics, such as how to
+use Axis2 to create and deploy Web services as well as how to use
+WSDL to generate both clients and services.</p>
+
+For experienced users of Apache Axis2, we recommend the <a href="adv-userguide.html">Advanced User's Guide.</a>
+<a name="intro"></a>
+<h1>Introducing Axis2</h1><p>This section introduces Axis2 and its structure, including an
+explanation of various directories/files included in the latest
+Axis2 <a class="externalLink" href="http://ws.apache.org/axis2/download.cgi">download</a>
+.</p>
+<h2>Content</h2><ul><li><a href="userguide.html#intro"><strong>Introducing
+Axis2</strong></a>
+<br />
+<ul><li><a href="userguide.html#whatis"><strong>What is
+Axis2?</strong></a>
+</li>
+<li><a href="userguide.html#underhood"><strong>What's under the
+hood?</strong></a>
+</li>
+<li><a href="userguide.html#handlessoap"><strong>How Axis2 handles
+SOAP messages</strong></a>
+</li>
+<li><a href="userguide.html#distributions"><strong>Axis2
+Distributions</strong></a>
+</li>
+<li><a href="userguide.html#sbd"><strong>The Axis2 Standard Binary
+Distribution</strong></a>
+</li>
+<li><a href="userguide.html#hierarchy"><strong>Axis2.war Directory
+Hierarchy</strong></a>
+</li>
+<li><a href="userguide.html#docs"><strong>Axis2 Documents
+Distribution</strong></a>
+</li>
+<li><a href="userguide.html#clients"><strong>Axis2 and
+Clients</strong></a>
+</li>
+</ul>
+</li>
+<li><a href="userguide-installingtesting.html#installingtesting">Installing and
+Testing Client Code</a>
+</li>
+<li><a href="userguide-introtoservices.html#introservices">Introduction to
+Services</a>
+<br />
+<ul><li><a href="userguide-introtoservices.html#messageexchange">Message Exchange
+Patterns</a>
+</li>
+</ul>
+</li>
+<li><a href="userguide-creatingclients.html#createclients">Creating
+Clients</a>
+<br />
+<ul><li><a href="userguide-creatingclients.html#choosingclient">Choosing a Client
+Generation Method</a>
+</li>
+<li><a href="userguide-creatingclients.html#generating">Generating
+Clients</a>
+</li>
+<li><a href="userguide-creatingclients.html#adb">Axis Data Binding
+(ADB)</a>
+</li>
+</ul>
+</li>
+<li><a href="userguide-buildingservices.html#buildservices">Building
+Services</a>
+<br />
+<ul><li><a href="userguide-buildingservices.html#getcomfortable">Getting
+Comfortable with Available Options</a>
+</li>
+<li><a href="userguide-buildingservices.html#createscratch">Creating a Service
+from Scratch</a>
+</li>
+<li><a href="userguide-buildingservices.html#deploypojo">Deploying
+Plain Old Java Objects</a>
+</li>
+<li><a href="userguide-buildingservices.html#deployrun">Deploying
+and Running an Axis2 Service Created from WSDL</a>
+</li>
+</ul>
+</li>
+<li><a href="userguide-samples.html">Samples</a>
+</li>
+<li><a href="userguide-forfurtherstudy.html">For Further
+Study</a>
+</li>
+</ul>
+<a name="whatis"></a>
+<h2>What is Axis2?</h2><p>The Apache Axis2 project is a Java-based implementation of both
+the client and server sides of the Web services equation. Designed
+to take advantage of the lessons learned from Apache Axis 1.0,
+Apache Axis2 provides a complete object model and a modular
+architecture that makes it easy to add functionality and support
+for new Web services-related specifications and
+recommendations.</p>
+<p>Axis2 enables you to easily perform the following tasks:</p>
+<ul><li>Send SOAP messages</li>
+<li>Receive and process SOAP messages</li>
+<li>Create a Web service out of a plain Java class</li>
+<li>Create implementation classes for both the server and client
+using WSDL</li>
+<li>Easily retrieve the WSDL for a service</li>
+<li>Send and receive SOAP messages with attachments</li>
+<li>Create or utilize a REST-based Web service</li>
+<li>Create or utilize services that take advantage of the <a class="externalLink" href="http://www.oasis-open.org/committees/download.php/16790/wss-v1.1-spec-os-SOAPMessageSecurity.pdf">
+WS-Security</a>
+, <a class="externalLink" href="http://xml.coverpages.org/ws-reliablemessaging20030313.pdf">WS-ReliableMessaging</a>
+,
+<a class="externalLink" href="http://www.w3.org/2002/ws/addr/">WS-Addressing</a>
+,
+<a class="externalLink" href="http://dev2dev.bea.com/pub/a/2004/03/ws-coordination.html">WS-Coordination</a>
+,
+and <a class="externalLink" href="ftp://www6.software.ibm.com/software/developer/library/WS-AtomicTransaction.pdf">
+WS-Atomic Transaction</a>
+ recommendations</li>
+<li>Use Axis2's modular structure to easily add support for new
+recommendations as they emerge</li>
+</ul>
+<p>Many more features exist as well, but this user guide
+concentrates on showing you how to accomplish the first five tasks
+on this list.</p>
+<a name="underhood"></a>
+<h2>What's Under the Hood?</h2><p>To understand Axis2 and what it does, you must have a good idea
+of the life cycle of a Web services message. Typically, it looks
+something like this:</p>
+<p><img src="images/fig01.jpg" alt="Lifecycle of a Web services message" /><br />
+</p>
+<p>The sending application creates the original SOAP message, an
+XML message that consists of headers and a body. (For more
+information on SOAP, see "<a href="userguide-introtoservices.html/">Introduction to Services</a>
+".)
+If the system requires the use of WS* recommendations such as
+WS-Addressing or WS-Security, the message may undergo additional
+processing before it leaves the sender. Once the message is ready,
+it is sent via a particular transport such as HTTP, JMS, and so
+on.</p>
+<p>The message works its way over to the receiver, which takes in
+the message via the transport listener. (In other words, if the
+application doesn't have an HTTP listener running, it's not going
+to receive any HTTP messages.) Again, if the message is part of a
+system that requires the use of WS-Security or other
+recommendations, it may need additional processing for the purpose
+of checking credentials or decrypting sensitive information.
+Finally, a dispatcher determines the specific application (or other
+component, such as a Java method) for which the message was
+intended, and sends it to that component. That component is part of
+an overall application designed to work with the data being sent
+back and forth.</p>
+<a name="handlessoap"></a>
+<h2>How Axis2 Handles SOAP Messages</h2><p>Axis2 can handle processing for both the sender and the receiver
+in a transaction. From the Axis2 perspective, the structure looks
+like this:</p>
+<p><img src="images/fig02.jpg" alt="Axis2 handles SOAP messages" /><br />
+</p>
+<p>On each end, you have an application designed to deal with the
+(sent or received) messages. In the middle, you have Axis2, or
+rather, you <em>can</em> have Axis2. The value of Web services is
+that the sender and receiver (each of which can be either the
+server or the client) don't even have to be on the same platform,
+much less running the same application. Assuming that Axis2 is
+running on both sides, the process looks like this:</p>
+<ul><li>The sender creates the SOAP message.</li>
+<li>Axis "handlers" perform any necessary actions on that message
+such as encryption of WS-Security related messages.</li>
+<li>The transport sender sends the message.</li>
+<li>On the receiving end, the transport listener detects the
+message.</li>
+<li>The transport listener passes the message on to any handlers on
+the receiving side.</li>
+<li>Once the message has been processed in the "pre-dispatch"
+phase, it is handed off to the dispatchers, which pass it on to the
+appropriate application.</li>
+</ul>
+<p>In Axis2, these actions are broken down into "phases", with
+several pre-defined phases, such as the "pre-dispatch", "dispatch,"
+and "message processing", being built into Axis2. Each phase is a
+collection of "handlers". Axis2 enables you to control what
+handlers go into which phases, and the order in which the handlers
+are executed within the phases. You can also add your own phases
+and handlers.</p>
+<p>Handlers come from "modules" that can be plugged into a running
+Axis2 system. These modules, such as Rampart, which provides an
+implementation of WS-Security, and Sandesha, which provides an
+implementation of WS-ReliableMessaging, are the main extensibility
+mechanisms in Axis2.</p>
+<a name="distributions"></a>
+<h2>Axis2 Distributions</h2><p>Axis2 is released in several <a class="externalLink" href="http://ws.apache.org/axis2/download/1_4/download.cgi">
+distributions</a>
+. Which one you need depends on what you'll be
+doing with it.</p>
+<a name="sbd"></a>
+<h3>The Axis2 Standard Binary Distribution</h3><p>If you're developing services and applications, you'll need the
+Axis2 <a class="externalLink" href="http://ws.apache.org/axis2/download/1_4/download.cgi#std-bin">
+Standard Binary Distribution</a>
+. The distribution includes all the
+necessary *.jar files, as well as a variety of scripts that ease
+development. It has the following structure.</p>
+<p><b>Code Listing 1: Axis2 Standard Binary Distribution</b>
+</p>
+<pre>
+bin
+ axis2.bat
+ axis2.sh
+ axis2server.bat
+ axis2server.sh
+ java2wsdl.bat
+ java2wsdl.sh
+ wsdl2java.bat
+ wsdl2java.sh
+ setenv.sh
+lib
+ activation-1.1.jar
+ ...
+ XmlSchema.jar
+repository
+ modules
+ modules.list
+ addressing-1.1.mar
+ ..
+ services
+ services.list
+ version.aar
+ ..
+samples
+ ...
+webapp
+ ...
+conf
+ axis2.xml
+
+LICENSE.txt
+README.txt
+NOTICE.txt
+INSTALL.txt
+release-notes.html
+</pre><p>The bin directory includes a number of useful scripts. They
+include axis2.bat (or axis2.sh), which enables you to easily
+execute a Java command without having to manually add all the Axis2
+jar files to the classpath, java2wsdl.bat (and .sh) and
+wsdl2java.bat (and .sh), which enable you to easily generate Java
+code from a WSDL file and vice versa, and axis2server.bat (and sh),
+a simple Web server that enables you to build Axis2's capability to
+send and receive messages into your own application.</p>
+<p>As expected, the lib directory includes all the necessary .jar
+files. Services and modules are added to the repository directory.
+Axis2 comes with a standard module implementing WS-Addressing, and
+you can add any other necessary module such as Rampart to the
+repository/modules directory.</p>
+<p>conf directory includes the axis2.xml which is the global
+deployment descriptor.</p>
+<p>Finally, the samples directory includes all the sample code
+distributed with Axis2. See the list of <a href="userguide-samples.html">samples and their descriptions</a>
+.</p>
+<a name="hierarchy"></a>
+<h2>axis2.war Distribution Directory Hierarchy</h2><p>axis2.war is available in <a class="externalLink" href="http://ws.apache.org/axis2/download/1_4/download.cgi#war">
+WAR (Web Archive) Distribution</a>
+. The server side of Axis2 ships
+as a J2EE application, and has the following structure shown in
+Code Listing 2.</p>
+<p><b>Code Listing 2: Server Side of Axis2</b>
+</p>
+<pre>
+axis2-web
+META-INF
+WEB-INF
+ classes
+ conf
+ axis2.xml
+ lib
+ activation.jar
+ ...
+ xmlSchema.jar
+ modules
+ modules.list
+ addressing.mar
+ ...
+ soapmonitor.mar
+ services
+ services.list
+ aservice.aar
+ ...
+ version.aar
+ web.xml
+</pre><p>Starting at the top, axis2-web is a collection of JSPs that make
+up the <a href="webadminguide.html">Axis2 administration
+application</a>
+, through which you can perform any needed actions
+such as adding services and engaging and dis-engaging modules. The
+WEB-INF directory represents the actual Axis2 application,
+including all the *.jar files, any included modules, and even the
+deployed services themselves.</p>
+<p>The classes directory holds any class or property files that are
+needed by Axis2 itself, such as log4j.properties. Any actual
+services to be handled by the system reside in the services
+directory in the form of an axis archive, or *.aar file. This file
+contains any classes related to the service, as well as the
+services.xml file, which controls any additional requirements, such
+as the definition of message senders and message receivers.</p>
+<p>The main file in all this is axis2.xml, which controls how the
+application deals with received messages. It defines message
+receivers and transport receivers, as well as defining transport
+senders and determining which modules are active. It also defines
+the order of phases, and the handlers to be executed within each
+phase.</p>
+<p>You can control all of this information through the use of the
+Web application, but if you restart the Axis2 application, these
+changes are lost and the server goes back to the definitions in the
+axis2.xml file.</p>
+<p>Axis2 also provides a third distribution, the <a class="externalLink" href="http://ws.apache.org/axis2/download/1_4/download.cgi#src">
+source distribution</a>
+, which enables you to generate this .war
+file yourself.</p>
+<a name="docs"></a>
+<h2>Axis2 Documentation Distribution Directory Hierarchy</h2><p>The Documents distribution includes all Axis2 documentation
+including the xdcos and javadocs. It has the following
+structure:</p>
+<p><b>Code Listing 3: Axis2 Documents Distribution</b>
+</p>
+<pre>
+docs
+ javadocs
+ xdocs
+
+LICENSE.txt
+README.txt
+release-notes.html
+</pre><p>The javadocs directory includes all the standard <a href="../../javadocs/index.html">API documentation</a>
+ for the Axis2
+API, with other documentation (like this document) in the xdocs
+directory.</p>
+<a name="clients"></a>
+<h2>Axis2 and Clients</h2><p>Now that explains how Axis2 behaves as part of a Web
+application. What about a standalone client that is not part of a
+J2EE application? In that case, a sender can use the Axis2 default
+properties, in other words, no special handlers, and so on. But you
+also have the option to tell the client to load its own copy of the
+axis2.xml file and behave accordingly.</p>
+<p><strong>See Next Section</strong> - <a href="userguide-installingtesting.html#installingtesting">Installing and
+Testing Client Code</a>
+</p>
+</html>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">©
+ 2004-2008
+
+ Apache Software Foundation
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: webservices/axis2/site/1_4/webadminguide.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/1_4/webadminguide.html?rev=652665&view=auto
==============================================================================
--- webservices/axis2/site/1_4/webadminguide.html (added)
+++ webservices/axis2/site/1_4/webadminguide.html Thu May 1 14:20:27 2008
@@ -0,0 +1,596 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+
+
+
+
+
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven - </title>
+ <style type="text/css" media="all">
+ @import url("../css/maven-base.css");
+ @import url("../css/maven-theme.css");
+ @import url("../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../" id="bannerLeft">
+
+ <img src="http://www.apache.org/images/asf_logo_wide.png" alt="" />
+
+ </a>
+ <span id="bannerRight">
+
+ <img src="../../images/axis.jpg" alt="" />
+
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+
+ <div class="xleft">
+ Last Published: 2008-05-01
+ </div>
+ <div class="xright"> <a href="../index.html">Axis2/Java</a>
+ |
+ <a href="../../c">Axis2/C</a>
+ |
+ <a href="../../..">Apache WS</a>
+ |
+ <a href="http://www.apache.org" class="externalLink">Apache</a>
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+
+
+
+
+
+
+
+ <h5>Axis2/Java</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../index.html">Home</a>
+ </li>
+ </ul>
+ <h5>Downloads</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../download.cgi">Releases</a>
+ </li>
+
+ <li class="none">
+ <a href="../modules/index.html">Modules</a>
+ </li>
+
+ <li class="none">
+ <a href="../tools/index.html">Tools</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="../1_4/contents.html">Version 1.4</a>
+ <ul>
+
+ <li class="none">
+ <a href="../1_4/toc.html">Table of Contents</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/installationguide.html">Installation Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/quickstartguide.html">QuickStart Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/userguide.html">User Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/jaxws-guide.html">JAXWS Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/pojoguide.html">POJO Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/spring.html">Spring Guide</a>
+ </li>
+
+ <li class="none">
+ <strong>Web Administrator's Guide</strong>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/migration.html">Migration Guide (from Axis1)</a>
+ </li>
+ </ul>
+ </li>
+
+ <li class="none">
+ <a href="../1_3/contents.html">Version 1.3</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_2/contents.html">Version 1.2</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_1_1/contents.html">Version 1.1.1</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_1/contents.html">Version 1.1</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_0/index.html">Version 1.0</a>
+ </li>
+
+ <li class="none">
+ <a href="../0_95/index.html">Version 0.95</a>
+ </li>
+
+ <li class="none">
+ <a href="../0_94/index.html">Version 0.94</a>
+ </li>
+
+ <li class="none">
+ <a href="../0_93/index.html">Version 0.93</a>
+ </li>
+ </ul>
+ <h5>Resources</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../faq.html">FAQ</a>
+ </li>
+
+ <li class="none">
+ <a href="../articles.html">Articles</a>
+ </li>
+
+ <li class="none">
+ <a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink">Wiki</a>
+ </li>
+
+ <li class="none">
+ <a href="../refLib.html">Reference Library</a>
+ </li>
+
+ <li class="none">
+ <a href="../../1_4/api/index.html">Online Java Docs</a>
+ </li>
+ </ul>
+ <h5>Get Involved</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../overview.html">Overview</a>
+ </li>
+
+ <li class="none">
+ <a href="../svn.html">Checkout the Source</a>
+ </li>
+
+ <li class="none">
+ <a href="../mail-lists.html">Mailing Lists</a>
+ </li>
+
+ <li class="none">
+ <a href="../release-process.html">Release Process</a>
+ </li>
+
+ <li class="none">
+ <a href="../guidelines.html">Developer Guidelines</a>
+ </li>
+
+ <li class="none">
+ <a href="../siteHowTo.html">Build the Site</a>
+ </li>
+ </ul>
+ <h5>Project Information</h5>
+ <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>
+
+ <li class="none">
+ <a href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/?root=Apache-SVN" class="externalLink">Source Code</a>
+ </li>
+
+ <li class="none">
+ <a href="../thanks.html">Acknowledgements</a>
+ </li>
+
+ <li class="none">
+ <a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink">License</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
+ </a>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <html xmlns="http://www.w3.org/1999/xhtml"><head><meta name="generator" content="HTML Tidy for Windows (vers 14 June 2007), see www.w3.org"><meta http-equiv="content-type" content="">Apache Axis2 Web Administrator's Guide<link href="../css/axis-docs.css" rel="stylesheet" type="text/css" media="all"></head><h1 align="center">Apache Axis2 Web Administrator's Guide</h1><p>This document gives you detailed information on the
+administration console of the Apache Axis2 Web application. Apache
+Axis2 Administration is all about configuring Apache Axis2 at run
+time, where the configuration is transient.</p>
+<p><i>Send your feedback to: <a class="externalLink" href="mailto:axis-dev@ws.apache.org?subject=[Axis2]">axis-dev@ws.apache.org</a>
+</i>
+.
+(Subscription details are available on the <a class="externalLink" href="http://ws.apache.org/axis2/mail-lists.html">Axis2 site</a>
+.)
+Kindly prefix every email subject with [Axis2].</p>
+<h2>Contents</h2><ul><li><a href="#Intro">Introduction</a>
+<ul><li><a href="#login">Login into Administration Site</a>
+</li>
+</ul>
+</li>
+<li><a href="#adminoptions">Administration Options</a>
+<ul><li><a href="#tools">Tools</a>
+<ul><li><a href="#upservice">Upload Service</a>
+</li>
+</ul>
+</li>
+<li><a href="#syscomponents">System components</a>
+<ul><li><a href="#heading1">Available services</a>
+</li>
+<li><a href="#servgroups">Available service groups</a>
+</li>
+<li><a href="#avmodules">Available modules</a>
+</li>
+<li><a href="#globalmodules">Globally engaged modules</a>
+</li>
+<li><a href="#phases">Available phases</a>
+</li>
+</ul>
+</li>
+<li><a href="#executionchains">Execution chains</a>
+<ul><li><a href="#globalchains">Global chains</a>
+</li>
+<li><a href="#operationchains">Operation specific chains</a>
+</li>
+</ul>
+</li>
+<li><a href="#engaginmodule">Engage module</a>
+</li>
+<li><a href="#services">Services</a>
+<ul><li><a href="#turnoffservice">Deactivate Service</a>
+</li>
+<li><a href="#turnonservice">Activate Service</a>
+</li>
+<li><a href="#editservicepara">Edit service parameters</a>
+</li>
+</ul>
+</li>
+<li><a href="#context">Contexts</a>
+<ul><li><a href="#viewhierarchy">View Hierarchy</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<a name="Intro"></a>
+<h3>Introduction</h3><p>The Apache Axis2 Web application has three main sections:
+'Services' lists all the available services deployed in this
+server, 'Validate' checks the system to see whether all the
+required libraries are in place and views the system information,
+and 'Administration' is the Axis2 Web Administration module which
+is the console for administering the Apache Axis2 installation.</p>
+<p>The Axis2 Web Administration module provides a way to configure
+Axis2 dynamically. It's important to note that this dynamic
+configuration will NOT be persistent, i.e., if the servlet
+container is restarted, then all the dynamic configuration changes
+will be lost.</p>
+<a name="login"></a>
+<h4>Log on to the Administration Site</h4>
+<p>Once Apache Axis2 is successfully installed, the Web application
+can be accessed (see <a href="installationguide.html">Installation
+Guide</a>
+ for instructions). From the <a href="#homepage">Axis2 Web
+Application Home page</a>
+ you can go to the Administration page by
+clicking the 'Administration' link. The Login page shown below will
+appear requesting the user name and password. The default user name
+is 'admin' (without quotes) and default password is 'axis2'
+(without quotes).</p>
+<p><img src="images/adminlogin.jpg" alt="" /></p>
+<p>You can change the user name and password values by changing the
+following two parameters in the axis2.xml as required.</p>
+<p><img src="images/parameters.jpg" alt="" /></p>
+<p>If the log on is successful, you will see the screen below. This
+is where you can view the configuration and the status of the
+running system and dynamically configure it.</p>
+<p><img src="images/admin.jpg" alt="" /></p>
+<a name="adminoptions"></a>
+<h3>Administration Options</h3><div style="margin-left: 2em"><a name="tools"><b>Tools</b>
+</a>
+<ul><li><a href="#upservice">Upload Service</a>
+</li>
+</ul>
+<a name="syscomponents"><b>System
+components</b>
+</a>
+<ul><li><a href="#heading1">Available services</a>
+</li>
+<li><a href="#servgroups">Available service groups</a>
+</li>
+<li><a href="#avmodules">Available modules</a>
+</li>
+<li><a href="#globalmodules">Globally engaged modules</a>
+</li>
+<li><a href="#phases">Available phases</a>
+</li>
+</ul>
+<a name="executionchains"><b>Execution
+chains</b>
+</a>
+<ul><li><a href="#globalchains">Global chains</a>
+</li>
+<li><a href="#operationchains">Operation specific chains</a>
+</li>
+</ul>
+<b><a href="#engaginmodule">Engage module</a>
+</b>
+<br />
+<ul><li>For all Services</li>
+<li>For a Service Group</li>
+<li>For a Service</li>
+<li>For an Operation</li>
+</ul>
+<a name="services"><b>Services</b>
+</a>
+<ul><li><a href="#turnoffservice">Deactivate service</a>
+</li>
+<li><a href="#turnonservice">Activate service</a>
+</li>
+<li><a href="#editservicepara">Edit service parameters</a>
+</li>
+</ul>
+<a name="context"><b>Contexts</b>
+</a>
+<ul><li><a href="#viewhierarchy">View Hierarchy</a>
+</li>
+</ul>
+</div><a name="homepage"></a>
+<h3>Apache Axis2 Web Application Home Page</h3><p><strong><img src="images/clip_image006.jpg" alt="" /></strong></p>
+<a name="upservice"></a>
+<h3>Upload Services</h3><p>You can upload packaged Apache Axis2 service archive files using
+this page. This can be done in two simple steps:</p>
+<ul><li>Browse to the location and select the axisService archive file
+you wish to upload</li>
+<li>Then click Upload</li>
+</ul>
+<p><img src="images/clip_image010.jpg" alt="" /></p>
+<a name="heading1"></a>
+<h3>Available Services</h3><p>The functionality of the 'Available Services' option is almost
+the same as the functionality of the 'Services' option on the Axis2
+Web Application Home page, where it displays a list of deployed
+services and their operations. As an additional feature, the
+'Available Services' page lists details of modules that are engaged
+to the deployed services and their operations on a global, service
+or on an operation level.</p>
+<p>Using the 'Disengage' link, you can disengage the corresponding
+module as long as the module is not globally engaged (i.e., engaged
+to all the services and operations).</p>
+<p>Click on a specific service and it will give you the WSDL file
+of that particular service.</p>
+<p><strong>Faulty services</strong> of this system will also be
+listed on this page. Click on a faulty service to view a page that
+lists the exception stack trace of the exception, which caused the
+service to be faulty.</p>
+<p><img src="images/adminmain.jpg" alt="" /></p>
+<a name="servgroups"></a>
+<h3>Available Service Groups</h3><p>Service group is a logical collection of related services, and
+the 'Available Service Groups' link will list all the available
+service groups in the system.</p>
+<p><img src="images/servicegroups.jpg" alt="" /></p>
+<a name="avmodules"></a>
+<h3>Available Modules</h3><p>To view the available modules in the 'modules' directory of the
+repository, click 'Available Modules'. This will show you all the
+available modules in the system. Those modules can be engaged
+dynamically.</p>
+<p><img src="images/modules.jpg" alt="" /></p>
+<br />
+<a name="globalmodules"></a>
+<h3>Globally Engaged Modules</h3><p>Click the 'Globally Engaged Modules' to view the globally
+engaged modules, if any. If a module is engaged globally, then the
+handlers that belong to that module will be executed irrespective
+of the service.</p>
+<a name="phases"></a>
+<h3>Available Phases</h3><p>The 'Available Phases' link will display all the available
+phases. In Axis2, there are two levels of phases:</p>
+<ul><li>System predefined phases (not allowed to be changed)</li>
+<li>User defined phases</li>
+</ul>
+<p>The main difference between these two levels is that system
+predefined phases will be invoked irrespective of the services,
+while the user defined phases will be invoked when the dispatcher
+finds the operation. Note that it is essential for module
+developers and service writers to have a good understanding of
+phases and phase ordering.</p>
+<p><img src="images/viewphases.jpg" alt="" /></p>
+<br />
+<a name="globalchains"></a>
+<h3>Global Chains</h3><p>The 'Global Chains' link will display all the Global Execution
+Chains. The most interesting feature of the Axis2 Web
+Administration Module is that it provides a very basic method of
+viewing the global phase list and handlers inside the phases
+depending on both the phase and handler orders. This kind of
+information is extremely useful in debugging the system, as there
+is no other way to list out handlers in the global chains. If you
+engage a new module, the new handlers will be added to the global
+chains and will be displayed on this page.</p>
+<p><img src="images/globalchain.jpg" alt="" /></p>
+<br />
+<a name="operationchains"></a>
+<h3>Operation Specific Chains</h3><p>The 'Operation Specific Chains' link can be used to view the
+handlers corresponding to a given service in the same order as it
+is in the real execution chain.</p>
+<p><img src="images/select_service_for_handler.jpg" alt="" /></p>
+<br />
+<p>Select the service of whose service handlers you wish to view
+from the list, and click 'View' to view the handlers. The page
+below shows the service handlers of the service
+<em>version</em></p>
+<p><img src="images/serviceHandlers.jpg" alt="" /></p>
+<br />
+<a name="engaginmodule"></a>
+<h3>Engaging Modules</h3><p>The 'Engaging Modules' link allows you to engage modules either
+globally (to all services), to a service group, to a service, or to
+an operation depending on the module implementation. If the module
+was designed to engage the handlers globally, then the handlers in
+the module can be included in any phase in the system. It can be
+either a system predefined phase or a user defined phase.</p>
+<p>On the other hand, if the module was implemented in such a way
+that it is going to be deployed to a service or to an operation,
+then the module cannot be included in any of the <a href="#phases">System Predefined Phases</a>
+. Thus it can only be
+included in <a href="#phases">User Defined Phases</a>
+.</p>
+<p>Immediately after engaging the module, you can see the status of
+the engagement indicating whether it is engaged properly or
+not.</p>
+<p><img src="images/moduleengage.jpg" alt="" /></p>
+<a name="turnoffservice"></a>
+<h3>Deactivate Service</h3><p>The 'Deactivate Service' link under the 'Services' list will
+lead to the page below. The Deactivate service functionality
+provides a way to remove unnecessary services from the running
+system, but the removal is transient--which means that if you
+restart the system, the service will be active.</p>
+<p>To deactivate a service, select a service from the list, select
+the 'Deactivate service' check box, and then click 'Deactivate'..
+The 'Clear' button will clear the 'Deactivate service' check
+box.</p>
+<p><img src="images/inactivate.jpg" alt="" /></p>
+<br />
+<a name="turnonservice"></a>
+<h3>Activate Service</h3><p>The 'Activate Service' link under the 'Services' list will lead
+to the page below. The Activate service functionality provides a
+way to activate services while the system is running, but the
+activation is transient-- which means that if you restart the
+system, the service will be inactive.</p>
+<p>To activate a service, select a service from the list, select
+the 'Activate Service' check box, then click 'Activate'. The
+'Clear' button will clear the 'Activate service' check box.</p>
+<p><img src="images/activate.jpg" alt="" /></p>
+<br />
+<a name="editservicepara"></a>
+<h3>Edit Service Parameters</h3><p>This functionality provides a way to change the parameters in a
+service or its operations. These changes will be transient too,
+which means if you restart the system, the changes will not be
+reflected.</p>
+<p>The 'Edit Parameters' link under the 'Services' list (on the
+navigation bar) will link to the page where you can select the
+services of which you want to edit the parameters. Once the service
+is selected, click 'Edit Parameters'.. This will open the page
+shown below.</p>
+<p><img src="images/editserviecpara.jpg" alt="" /></p>
+<br />
+<a name="viewhierarchy"></a>
+<h3>View Hierarchy</h3><p>By listing the current context hierarchy, the 'View Hierarchy'
+link provides a means to look at the system state at run time. This
+will list out all the available service group contexts, service
+contexts, operation contexts, etc.</p>
+</html>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">©
+ 2004-2008
+
+ Apache Software Foundation
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: webservices/axis2/site/1_4/xmlbased-server.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/1_4/xmlbased-server.html?rev=652665&view=auto
==============================================================================
--- webservices/axis2/site/1_4/xmlbased-server.html (added)
+++ webservices/axis2/site/1_4/xmlbased-server.html Thu May 1 14:20:27 2008
@@ -0,0 +1,466 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+
+
+
+
+
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven - </title>
+ <style type="text/css" media="all">
+ @import url("../css/maven-base.css");
+ @import url("../css/maven-theme.css");
+ @import url("../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../" id="bannerLeft">
+
+ <img src="http://www.apache.org/images/asf_logo_wide.png" alt="" />
+
+ </a>
+ <span id="bannerRight">
+
+ <img src="../../images/axis.jpg" alt="" />
+
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+
+ <div class="xleft">
+ Last Published: 2008-05-01
+ </div>
+ <div class="xright"> <a href="../index.html">Axis2/Java</a>
+ |
+ <a href="../../c">Axis2/C</a>
+ |
+ <a href="../../..">Apache WS</a>
+ |
+ <a href="http://www.apache.org" class="externalLink">Apache</a>
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+
+
+
+
+
+
+
+ <h5>Axis2/Java</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../index.html">Home</a>
+ </li>
+ </ul>
+ <h5>Downloads</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../download.cgi">Releases</a>
+ </li>
+
+ <li class="none">
+ <a href="../modules/index.html">Modules</a>
+ </li>
+
+ <li class="none">
+ <a href="../tools/index.html">Tools</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="../1_4/contents.html">Version 1.4</a>
+ <ul>
+
+ <li class="none">
+ <a href="../1_4/toc.html">Table of Contents</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/installationguide.html">Installation Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/quickstartguide.html">QuickStart Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/userguide.html">User Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/jaxws-guide.html">JAXWS Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/pojoguide.html">POJO Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/spring.html">Spring Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/webadminguide.html">Web Administrator's Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_4/migration.html">Migration Guide (from Axis1)</a>
+ </li>
+ </ul>
+ </li>
+
+ <li class="none">
+ <a href="../1_3/contents.html">Version 1.3</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_2/contents.html">Version 1.2</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_1_1/contents.html">Version 1.1.1</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_1/contents.html">Version 1.1</a>
+ </li>
+
+ <li class="none">
+ <a href="../1_0/index.html">Version 1.0</a>
+ </li>
+
+ <li class="none">
+ <a href="../0_95/index.html">Version 0.95</a>
+ </li>
+
+ <li class="none">
+ <a href="../0_94/index.html">Version 0.94</a>
+ </li>
+
+ <li class="none">
+ <a href="../0_93/index.html">Version 0.93</a>
+ </li>
+ </ul>
+ <h5>Resources</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../faq.html">FAQ</a>
+ </li>
+
+ <li class="none">
+ <a href="../articles.html">Articles</a>
+ </li>
+
+ <li class="none">
+ <a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink">Wiki</a>
+ </li>
+
+ <li class="none">
+ <a href="../refLib.html">Reference Library</a>
+ </li>
+
+ <li class="none">
+ <a href="../../1_4/api/index.html">Online Java Docs</a>
+ </li>
+ </ul>
+ <h5>Get Involved</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../overview.html">Overview</a>
+ </li>
+
+ <li class="none">
+ <a href="../svn.html">Checkout the Source</a>
+ </li>
+
+ <li class="none">
+ <a href="../mail-lists.html">Mailing Lists</a>
+ </li>
+
+ <li class="none">
+ <a href="../release-process.html">Release Process</a>
+ </li>
+
+ <li class="none">
+ <a href="../guidelines.html">Developer Guidelines</a>
+ </li>
+
+ <li class="none">
+ <a href="../siteHowTo.html">Build the Site</a>
+ </li>
+ </ul>
+ <h5>Project Information</h5>
+ <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>
+
+ <li class="none">
+ <a href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/?root=Apache-SVN" class="externalLink">Source Code</a>
+ </li>
+
+ <li class="none">
+ <a href="../thanks.html">Acknowledgements</a>
+ </li>
+
+ <li class="none">
+ <a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink">License</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
+ </a>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <html xmlns="http://www.w3.org/1999/xhtml"><head><meta name="generator" content="HTML Tidy for Windows (vers 14 June 2007), see www.w3.org"><meta http-equiv="content-type" content="">Writing Web Services Using Axis2's Primary APIs<link href="../css/axis-docs.css" rel="stylesheet" type="text/css" media="all"></head><a name="Writing_Web_Services_Using_Axis2s_Primary_APIs"></a>
+<h1>Writing Web Services Using Apache Axis2's Primary APIs</h1><p>Apache Axis2 dispatches a component called
+<strong>MessageReceiver</strong> when Receiving a Message to the
+server. Apache Axis2 provides different implementations of this
+class and it can be configured by adding a messageReceiver tag to
+services.xml. Apache Axis2 provides an implementation for a class
+of Message receivers called RawXml Message receivers. They work at
+the XML level and can only handle OMElements as parameters. This
+section explains how to write a service using them.</p>
+<p>In our example, the Web service will have two operations.</p>
+<pre>
+public void ping(OMElement element){} //IN-ONLY operation, just accepts the OMElement and does some processing.
+public OMElement echo(OMElement element){}//IN-OUT operation, accepts an OMElement and
+ // sends back the same again
+</pre><a name="How_to_write_the_Web_Service_"></a>
+<h4>How to Write a Web Service?</h4>
+
+Writing a new Web service with Apache Axis2 involves four steps:
+<ol type="1"><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>Deploy the Web service.</li>
+</ol>
+<a name="Step1_:Write_the_Implementation_Class"></a>
+<h4>Step1: Write the Implementation Class</h4>
+<p>An implementation class has the business logic for the Web
+service and implements the operations provided by the Web service.
+Unless you have data binding, the signature of the methods can have
+only one parameter of the type OMElement. <i>OM stands for Object
+Model (also known as AXIOM - AXis Object Model) and refers to the
+XML infoset model that is initially developed for Apache Axis2. DOM
+and JDOM are two such XML models conceptually similar to OM as an
+XML model by its external behavior, but considering the deep down
+implementation OM is very much different to others. OMElement is
+the basic representation of the XML infoset element in OM.For more
+details on OMElement see the <a class="externalLink" href="http://ws.apache.org/commons/axiom/OMTutorial.html">OM
+Tutorial</a>
+.</i>
+</p>
+<pre>
+public class MyService{
+ public void ping(OMElement element){
+ // Business Logic
+ ......
+ }
+ public OMElement echo(OMElement element){
+ ......
+ }
+}
+</pre><a name="Step2_:Write_the_services_xml_file"></a>
+<h4>Step2: Write the services.xml file</h4>
+<p>"services.xml" has the configuration for a Web service. Each Web
+service, deployed in Apache Axis2 , must have its configuration in
+"services.xml". The configuration for MyService is as follows:</p>
+<pre>
+<service >
+ <description>
+ This is a sample Web service with two operations, echo and ping.
+ </description>
+ <parameter name="ServiceClass">userguide.example1.MyService</parameter>
+ <operation name="echo">
+ <messageReceiver class="org.apache.axis2.receivers.RawXMLINOutMessageReceiver"/>
+ <actionMapping>urn:echo</actionMapping>
+ </operation>
+ <operation name="ping">
+ <messageReceiver class="org.apache.axis2.receivers.RawXMLINOnlyMessageReceiver"/>
+ <actionMapping>urn:ping</actionMapping>
+ </operation>
+ </service>
+</pre><p>The above XML tags can be explained as follows:</p>
+<p>1. The description of the service class is provided in the
+description tag.</p>
+<pre>
+<service >
+ <description>
+ This is a sample Web service with two operations, echo and ping.
+ </description>
+</pre><p>2. The name of the service class is provided as a parameter.</p>
+<pre>
+<parameter name="serviceClass">userguide.example1.MyService</parameter>
+</pre><p>3. The "operation" XML tag describes the operations that are
+available in this service with respective message receivers.</p>
+<pre>
+ <operation name="echo">
+ <messageReceiver class="org.apache.axis2.receivers.RawXMLINOutMessageReceiver"/>
+ <actionMapping>urn:echo</actionMapping>
+ </operation>
+ <operation name="ping">
+ <messageReceiver class="org.apache.axis2.receivers.RawXMLINOnlyMessageReceiver"/>
+ <actionMapping>urn:ping</actionMapping>
+ </operation>
+</pre><p>4. Every operation must map to a corresponding MessageReceiver
+class. After a message is processed by the handlers, the Axis2
+engine hands it over to a MessageReceiver.</p>
+<p>5. For the "echo" operation, we have used a
+<strong>RawXMLINOutMessageReceiver</strong> since it is an IN-OUT
+operation. For the IN-ONLY operation "ping", we have used
+<strong>RawXMLINOnlyMessageReceiver</strong> as the message
+receiver.</p>
+<p>6. The actionMapping is required only if you want to enable
+WS-Addressing. This will be used later in this user guide.</p>
+<p>7. You can write a services.xml file to include a group of
+services instead of a single service. This makes the 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 the following
+format.</p>
+<pre>
+<ServiceGroup>
+ <service name="Service1">
+ <!-- details for Service1 -->
+ </service>
+ <service name="Service2">
+ <!-- details for Service2 -->
+ </service>
+ <module ref="ModuleName" />
+ <parameter name="serviceGroupParam1">value 1</parameter>
+</serviceGroup>
+</pre><p>Note : The name of the service is a compulsory attribute.</p>
+<a name="Step3_:Create_the_Web_Service_Archive"></a>
+<h4>Step3: Create the Web Service Archive</h4>
+<p>Apache Axis2 uses the ".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 in the directory structure shown below. Please note that
+the name of the archive file will be the same as that of the
+service only if the services.xml contains only one service
+element.</p>
+<p><img src="images/userguide/ServiceItems.jpg" /></p>
+<p>To create the archive file, you can create a .jar file
+containing all the necessary files and then rename it to a .aar
+file. This archive file can be found in the
+"Axis2_HOME/samples/userguide" directory. This file has to be
+deployed now.</p>
+<a name="Step4_:Deploy_the_Web_Service"></a>
+<h4>Step4: Deploy the Web Service</h4>
+<p>The service can be deployed by dropping the ".aar" file into the
+"services" directory in "/webapps/axis2/WEB-INF" of your servlet
+container. Start the servlet container (if you have not already
+started), click the link "Services" on the <a class="externalLink" href="http://localhost:8080/axis2/">Home Page of Axis2
+Web Application</a>
+ (http://localhost:8080/axis2) and see whether
+MyService is deployed properly. If you can see the following
+output, then you have successfully deployed MyService on Apache
+Axis2. Congratulations !!</p>
+<p><img src="images/userguide/MyServiceDeployed.jpg" /></p>
+<p>Note: Apache Axis2 provides an easy way to deploy Web services
+using the "Upload Service" tool on the Axis2 Web Application's
+Administration module. Please refer to the <a href="webadminguide.html">Web Administration Guide</a>
+
+for more information.</p>
+</html>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">©
+ 2004-2008
+
+ Apache Software Foundation
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Modified: webservices/axis2/site/api.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/api.html?rev=652665&r1=652664&r2=652665&view=diff
==============================================================================
--- webservices/axis2/site/api.html (original)
+++ webservices/axis2/site/api.html Thu May 1 14:20:27 2008
@@ -1,6 +1,6 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Axis 2.0 - :: Axis2 API Docs ::</title><style type="text/css" media="all">
- @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: 10 January 2006
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Axis 2.0 - :: Axis2 API Docs ::</title><style type="text/css" media="all">
+ @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: 10 January 2006
| Doc for 0.94</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">Developer Guidelines</a></li><li cl
ass="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 href="/api/0_92/index.html">0.92</a></p><p><a href="/api/0_93/index.html">0.93</a></p></div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 2004-2006, Apache Software Foundation</div><div class="cl
ear"><hr></hr></div></div></body></html>
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org