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 2007/07/14 06:37:36 UTC
svn commit: r556222 [13/22] - in /webservices/axis2/trunk/java/xdocs: ./
@axis2_version_dir@/ @axis2_version_dir@/adb/ @axis2_version_dir@/jibx/
@axis2_version_dir@/src/ download/0_9/ download/0_91/ download/0_92/
download/0_93/ download/0_94/ download...
Copied: webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/userguide-installingtesting.xml (from r556217, webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/userguide-installingtesting.html)
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/%40axis2_version_dir%40/userguide-installingtesting.xml?view=diff&rev=556222&p1=webservices/axis2/trunk/java/xdocs/%40axis2_version_dir%40/userguide-installingtesting.html&r1=556217&p2=webservices/axis2/trunk/java/xdocs/%40axis2_version_dir%40/userguide-installingtesting.xml&r2=556222
==============================================================================
--- webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/userguide-installingtesting.html (original)
+++ webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/userguide-installingtesting.xml Fri Jul 13 21:37:26 2007
@@ -1,147 +1,153 @@
-<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one
- ~ or more contributor license agreements. See the NOTICE file
- ~ distributed with this work for additional information
- ~ regarding copyright ownership. The ASF licenses this file
- ~ to you under the Apache License, Version 2.0 (the
- ~ "License"); you may not use this file except in compliance
- ~ with the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing,
- ~ software distributed under the License is distributed on an
- ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~ KIND, either express or implied. See the License for the
- ~ specific language governing permissions and limitations
- ~ under the License.
- -->
-<html lang="en">
-<head>
- <meta http-equiv="content-type" content="">
- <title>Apache Axis2 User's Guide-Installing and Testing Client Code</title>
- <link href="../css/axis-docs.css" rel="stylesheet" type="text/css"
- media="all">
-</head>
-
-<body lang="en">
-<a name="installingtesting"></a>
-
-<h1>Apache Axis2 User's Guide - Installing and Testing Client Code</h1>
-
-<p>The best way to make sure that your system is running Apache Axis2 is to
-install and test both a service and a client. The process involves the
-following steps:</p>
-
-<h2>Content</h2>
-<ul>
- <li><a href="userguide.html#intro">Introducing Axis2</a><br>
-
- <ul>
- <li><a href="userguide.html#whatis">What is Axis2?</a></li>
- <li><a href="userguide.html#underhood">What's under the hood?</a></li>
- <li><a href="userguide.html#handlessoap">How Axis2 handles SOAP
- messages</a></li>
- <li><a href="userguide.html#distributions">Axis2 distributions</a></li>
- <li><a href="userguide.html#sbd">The Axis2 Standard Binary
- Distribution</a></li>
- <li><a href="userguide.html#hierarchy">Axis2.war Directory
- Hierarchy</a></li>
- <li><a href="userguide.html#docs">Axis2 Documents Distribution</a></li>
- <li><a href="userguide.html#clients">Axis2 and clients</a></li>
- </ul>
- </li>
- <li><a
- href="userguide-installingtesting.html#installingtesting"><strong>Installing
- and testing client code</strong></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 the 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>
-
-<p><b>The Short Story:</b></p>
-<ol>
- <li>Install Apache Axis2 in a suitable container, such as Apache Tomcat, by
- copying the axis2.war file to the webapps directory.</li>
- <li>Install the service into the Axis2 application by copying the *.aar
- file into the Axis2 services directory.</li>
- <li>Install the client on the system on which you want to run it, and make
- sure all the Axis2 libraries are on the CLASSPATH.</li>
- <li>Run the client.</li>
-</ol>
-<!--stopped here-->
-
-<p><b>The Long Story:</b></p>
-
-<p>Start by installing a suitable container, such as <a
-href="http://tomcat.apache.org/">Apache Tomcat</a>. Any J2EE server will do.
-To install Apache Axis2 on the server, download the Axis2 WAR distribution
-from <a
-href="http://ws.apache.org/axis2/download.cgi">http://ws.apache.org/axis2/download.cgi</a>
-and place the axis2.war file in the server's webapps directory. The server
-will then expand the distribution into its proper structure, as seen in the
-<a href="userguide-intro.html#hierarchy">earlier section</a>.</p>
-
-<p>Apache Axis2 services come bundled as *.aar files, which contain all the
-pieces necessary to define the service, such as the necessary classes and
-libraries and the services.xml file that defines the service's behavior. You
-can install the service using the <a href="webadminguide.html">Web
-administration application</a>, but to make things simple for now, copy the
-*.aar file into the Axis2 services directory. For example, to install the
-MyService service distributed as one of the Axis2 samples, copy the file
-<AXIS2_HOME>/samples/userguide/build/MyService.aar file, which is built
-using the <code>ant</code> command, from
-<AXIS2_HOME>/samples/userguide, to the directory
-<J2EE_HOME>/webapps/axis2/WEB-INF/services.</p>
-
-<p>Your client can come in any number of forms, from a collection of files to
-a single *.jar file. The important thing is to ensure that all the
-appropriate classes are on the classpath. In addition to the classes that
-pertain to the actual client, you must also add the Axis2 .jar files into the
-CLASSPATH. Normally you will do this by downloading and unpacking the <a
-href="http://ws.apache.org/axis2/download/@axis2_version_dir@/download.cgi#std-bin">Axis2
-Standard Distribution</a> and adding the *.jar files in the lib directory to
-your CLASSPATH, or you also have the option of running your client using the
-axis2.bat (or axis2.sh) script, which takes care of it for you. For example,
-you can run a client with the command:</p>
-
-<p>axis2 org.apache.axis2.axis2userguide.Client.</p>
-
-<p><strong>See Next Section</strong>- <a
-href="userguide-introtoservices.html#introservices">Introduction to
-Services</a></p>
-</body>
-</html>
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you under the Apache License, Version 2.0 (the
+ ~ "License"); you may not use this file except in compliance
+ ~ with the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing,
+ ~ software distributed under the License is distributed on an
+ ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~ KIND, either express or implied. See the License for the
+ ~ specific language governing permissions and limitations
+ ~ under the License.
+ -->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html lang="en" xmlns="http://www.w3.org/1999/xhtml" xml: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="" />
+<title>Apache Axis2 User's Guide-Installing and Testing Client
+Code</title>
+<link href="../css/axis-docs.css" rel="stylesheet" type="text/css"
+media="all" />
+</head>
+<body lang="en" xml:lang="en">
+<a name="installingtesting" id="installingtesting"></a>
+<h1>Apache Axis2 User's Guide - Installing and Testing Client
+Code</h1>
+<p>The best way to make sure that your system is running Apache
+Axis2 is to install and test both a service and a client. The
+process involves the following steps:</p>
+<h2>Content</h2>
+<ul>
+<li><a href="userguide.html#intro">Introducing Axis2</a><br />
+<ul>
+<li><a href="userguide.html#whatis">What is Axis2?</a></li>
+<li><a href="userguide.html#underhood">What's under the
+hood?</a></li>
+<li><a href="userguide.html#handlessoap">How Axis2 handles SOAP
+messages</a></li>
+<li><a href="userguide.html#distributions">Axis2
+distributions</a></li>
+<li><a href="userguide.html#sbd">The Axis2 Standard Binary
+Distribution</a></li>
+<li><a href="userguide.html#hierarchy">Axis2.war Directory
+Hierarchy</a></li>
+<li><a href="userguide.html#docs">Axis2 Documents
+Distribution</a></li>
+<li><a href="userguide.html#clients">Axis2 and clients</a></li>
+</ul>
+</li>
+<li><a href=
+"userguide-installingtesting.html#installingtesting"><strong>Installing
+and testing client code</strong></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 the 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>
+<p><b>The Short Story:</b></p>
+<ol>
+<li>Install Apache Axis2 in a suitable container, such as Apache
+Tomcat, by copying the axis2.war file to the webapps
+directory.</li>
+<li>Install the service into the Axis2 application by copying the
+*.aar file into the Axis2 services directory.</li>
+<li>Install the client on the system on which you want to run it,
+and make sure all the Axis2 libraries are on the CLASSPATH.</li>
+<li>Run the client.</li>
+</ol>
+<!--stopped here-->
+<p><b>The Long Story:</b></p>
+<p>Start by installing a suitable container, such as <a href=
+"http://tomcat.apache.org/">Apache Tomcat</a>. Any J2EE server will
+do. To install Apache Axis2 on the server, download the Axis2 WAR
+distribution from <a href=
+"http://ws.apache.org/axis2/download.cgi">http://ws.apache.org/axis2/download.cgi</a>
+and place the axis2.war file in the server's webapps directory. The
+server will then expand the distribution into its proper structure,
+as seen in the <a href="userguide-intro.html#hierarchy">earlier
+section</a>.</p>
+<p>Apache Axis2 services come bundled as *.aar files, which contain
+all the pieces necessary to define the service, such as the
+necessary classes and libraries and the services.xml file that
+defines the service's behavior. You can install the service using
+the <a href="webadminguide.html">Web administration
+application</a>, but to make things simple for now, copy the *.aar
+file into the Axis2 services directory. For example, to install the
+MyService service distributed as one of the Axis2 samples, copy the
+file <AXIS2_HOME>/samples/userguide/build/MyService.aar file,
+which is built using the <code>ant</code> command, from
+<AXIS2_HOME>/samples/userguide, to the directory
+<J2EE_HOME>/webapps/axis2/WEB-INF/services.</p>
+<p>Your client can come in any number of forms, from a collection
+of files to a single *.jar file. The important thing is to ensure
+that all the appropriate classes are on the classpath. In addition
+to the classes that pertain to the actual client, you must also add
+the Axis2 .jar files into the CLASSPATH. Normally you will do this
+by downloading and unpacking the <a href=
+"http://ws.apache.org/axis2/download/@axis2_version_dir@/download.cgi#std-bin">
+Axis2 Standard Distribution</a> and adding the *.jar files in the
+lib directory to your CLASSPATH, or you also have the option of
+running your client using the axis2.bat (or axis2.sh) script, which
+takes care of it for you. For example, you can run a client with
+the command:</p>
+<p>axis2 org.apache.axis2.axis2userguide.Client.</p>
+<p><strong>See Next Section</strong>- <a href=
+"userguide-introtoservices.html#introservices">Introduction to
+Services</a></p>
+</body>
+</html>
Copied: webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/userguide-introtoservices.xml (from r556217, webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/userguide-introtoservices.html)
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/%40axis2_version_dir%40/userguide-introtoservices.xml?view=diff&rev=556222&p1=webservices/axis2/trunk/java/xdocs/%40axis2_version_dir%40/userguide-introtoservices.html&r1=556217&p2=webservices/axis2/trunk/java/xdocs/%40axis2_version_dir%40/userguide-introtoservices.xml&r2=556222
==============================================================================
--- webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/userguide-introtoservices.html (original)
+++ webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/userguide-introtoservices.xml Fri Jul 13 21:37:26 2007
@@ -1,182 +1,189 @@
-<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one
- ~ or more contributor license agreements. See the NOTICE file
- ~ distributed with this work for additional information
- ~ regarding copyright ownership. The ASF licenses this file
- ~ to you under the Apache License, Version 2.0 (the
- ~ "License"); you may not use this file except in compliance
- ~ with the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing,
- ~ software distributed under the License is distributed on an
- ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~ KIND, either express or implied. See the License for the
- ~ specific language governing permissions and limitations
- ~ under the License.
- -->
-<html lang="en">
-<head>
- <meta http-equiv="content-type" content="">
- <title>Apache Axis2 User's Guide- Introduction to Services</title>
- <link href="../css/axis-docs.css" rel="stylesheet" type="text/css"
- media="all">
-</head>
-
-<body>
-<a name="introservices"></a>
-
-<h1>Apache Axis2 User's Guide - Introduction to Services</h1>
-
-<p>The term "Web services" can apply to a number of different ways of sending
-information back and forth. However, this guide focuses on the sending and
-receiving of SOAP messages. SOAP messages are XML documents that consist of
-an "envelope" containing a "payload" (see Code Listing 4).</p>
-
-<h2>Content</h2>
-<ul>
- <li><a href="userguide.html#intro">Introducing Axis2</a><br>
-
- <ul>
- <li><a href="userguide.html#whatis">What is Axis2?</a></li>
- <li><a href="userguide.html#underhood">What's under the hood?</a></li>
- <li><a href="userguide.html#handlessoap">How Axis2 handles SOAP
- messages</a></li>
- <li><a href="userguide.html#distributions">Axis2 distributions</a></li>
- <li><a href="userguide.html#sbd">The Axis2 Standard Binary
- Distribution</a></li>
- <li><a href="userguide.html#hierarchy">Axis2.war Directory
- Hierarchy</a></li>
- <li><a href="userguide.html#docs">Axis2 Documents Distribution</a></li>
- <li><a href="userguide.html#clients">Axis2 and clients</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"><strong>Introduction
- to Services</strong></a><br>
-
- <ul>
- <li><a
- href="userguide-introtoservices.html#messageexchange"><strong>Message
- Exchange Patterns</strong></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 the 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>
-
-<h3>Code Listing 4: Example SOAP Message</h3>
-<pre><?xml version='1.0' ?>
-<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"
-xmlns:wsa="http://www.w3.org/2005/03/addressing">
- <env:Header>
-
- <wsa:MessageID>
- http://ws.apache.org/9C21DE32-DB42-1228-C42E-66CB101421AD
- </wsa:MessageID>
- <wsa:ReplyTo>
- <wsa:Address>http://example.com/projects/clientApp</wsa:Address>
- </wsa:ReplyTo>
-
-<wsa:To>http://example.com/axis2/publishingService</wsa:To>
-
-<wsa:Action>http://example.com/axis2/addDocument</wsa:Action>
-
-</env:Header>
- <env:Body>
-
- <addDocument>
- <docTitle>What I Did On My Summer Vacation</doctitle>
- <docSubtitle>Children's Essays from Accross the World</docSubtitle>
- <docLocation>contentRepos/summerVac.doc</docLocation>
- </addDocument>
-
- </env:Body>
-</env:Envelope></pre>
-
-<p>This XML document consists of the outer element or the SOAP Envelope, and
-its contents. The SOAP Envelope is in the SOAP namespace,
-http://www.w3.org/2003/05/soap-envelope, prefixed as env: and contains up to
-two children. This envelope is a standard format that pertains to every
-single SOAP message sent and received by any SOAP Web service.</p>
-
-<p>The contents of the Envelope consists of two parts; the first being the
-SOAP headers-the contents of the env:Header element. These headers, such as
-the WS-Addressing elements shown here, provide additional information about
-the message and how it should be handled. A SOAP message may carry headers
-relating to several aspects of the message, or it may carry no headers at
-all. These headers are typically processed by the message handlers.</p>
-
-<p>The second and arguably the most important part of the message is the
-payload, which consists of the contents of the env:Body element. This is the
-actual message intended for the receiver, and it is the information that the
-main application will ultimately process.</p>
-<a name="messageexchange"></a>
-
-<h2>Message Exchange Patterns</h2>
-
-<p>Although all SOAP messages carry the same structure, the ways in which
-they are used can be combined into a number of different "message exchange
-patterns", or MEPs. The two major message exchange patterns are:</p>
-<ul>
- <li>In-Out: in this MEP, the client sends a SOAP message to the server,
- which processes the message and sends a response back. This is probably
- the most commonly used MEP, and is useful for tasks such as searching for
- information or submitting information in situations in where
- acknowledgment is important.</li>
- <li>In-Only: In this MEP, the client sends a message to the server without
- expecting a response. You may use this MEP for activities such as pinging
- a server to wake it up, reporting logging information for which you do
- not need an acknowledgment and so on.</li>
-</ul>
-
-<p>Within these two MEPs, you also have several variables to consider:</p>
-<ul>
- <li>Blocking versus non-blocking: When the client sends a message, the
- application may wait to receive a response before moving on, or it may
- simply send a message and move on by specifying a callback action to be
- completed when the response is received.</li>
- <li>Number of parameters: Ultimately, a message sent from a client to
- server is intended to execute a particular action. That action may not
- require any parameters, or it may require one or more parameters. These
- parameters must be encoded as part of the payload of the message.</li>
-</ul>
-
-<p>Taking all these options into consideration, you can create virtually any
-MEP. For example, you can create an Out-Only system by reversing roles for
-the In-Only MEP. Apache Axis2 also includes support for less prominent MEPs,
-such as Robust-In-Only.</p>
-
-<p><strong>See Next Section</strong> - <a
-href="userguide-creatingclients.html#createclients">Creating Clients</a></p>
-</body>
-</html>
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you under the Apache License, Version 2.0 (the
+ ~ "License"); you may not use this file except in compliance
+ ~ with the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing,
+ ~ software distributed under the License is distributed on an
+ ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~ KIND, either express or implied. See the License for the
+ ~ specific language governing permissions and limitations
+ ~ under the License.
+ -->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html lang="en" xmlns="http://www.w3.org/1999/xhtml" xml: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="" />
+<title>Apache Axis2 User's Guide- Introduction to Services</title>
+<link href="../css/axis-docs.css" rel="stylesheet" type="text/css"
+media="all" />
+</head>
+<body>
+<a name="introservices" id="introservices"></a>
+<h1>Apache Axis2 User's Guide - Introduction to Services</h1>
+<p>The term "Web services" can apply to a number of different ways
+of sending information back and forth. However, this guide focuses
+on the sending and receiving of SOAP messages. SOAP messages are
+XML documents that consist of an "envelope" containing a "payload"
+(see Code Listing 4).</p>
+<h2>Content</h2>
+<ul>
+<li><a href="userguide.html#intro">Introducing Axis2</a><br />
+<ul>
+<li><a href="userguide.html#whatis">What is Axis2?</a></li>
+<li><a href="userguide.html#underhood">What's under the
+hood?</a></li>
+<li><a href="userguide.html#handlessoap">How Axis2 handles SOAP
+messages</a></li>
+<li><a href="userguide.html#distributions">Axis2
+distributions</a></li>
+<li><a href="userguide.html#sbd">The Axis2 Standard Binary
+Distribution</a></li>
+<li><a href="userguide.html#hierarchy">Axis2.war Directory
+Hierarchy</a></li>
+<li><a href="userguide.html#docs">Axis2 Documents
+Distribution</a></li>
+<li><a href="userguide.html#clients">Axis2 and clients</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"><strong>Introduction
+to Services</strong></a><br />
+<ul>
+<li><a href=
+"userguide-introtoservices.html#messageexchange"><strong>Message
+Exchange Patterns</strong></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 the 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>
+<h3>Code Listing 4: Example SOAP Message</h3>
+<pre>
+<?xml version='1.0' ?>
+<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"
+xmlns:wsa="http://www.w3.org/2005/03/addressing">
+ <env:Header>
+
+ <wsa:MessageID>
+ http://ws.apache.org/9C21DE32-DB42-1228-C42E-66CB101421AD
+ </wsa:MessageID>
+ <wsa:ReplyTo>
+ <wsa:Address>http://example.com/projects/clientApp</wsa:Address>
+ </wsa:ReplyTo>
+
+<wsa:To>http://example.com/axis2/publishingService</wsa:To>
+
+<wsa:Action>http://example.com/axis2/addDocument</wsa:Action>
+
+</env:Header>
+ <env:Body>
+
+ <addDocument>
+ <docTitle>What I Did On My Summer Vacation</doctitle>
+ <docSubtitle>Children's Essays from Accross the World</docSubtitle>
+ <docLocation>contentRepos/summerVac.doc</docLocation>
+ </addDocument>
+
+ </env:Body>
+</env:Envelope>
+</pre>
+<p>This XML document consists of the outer element or the SOAP
+Envelope, and its contents. The SOAP Envelope is in the SOAP
+namespace, http://www.w3.org/2003/05/soap-envelope, prefixed as
+env: and contains up to two children. This envelope is a standard
+format that pertains to every single SOAP message sent and received
+by any SOAP Web service.</p>
+<p>The contents of the Envelope consists of two parts; the first
+being the SOAP headers-the contents of the env:Header element.
+These headers, such as the WS-Addressing elements shown here,
+provide additional information about the message and how it should
+be handled. A SOAP message may carry headers relating to several
+aspects of the message, or it may carry no headers at all. These
+headers are typically processed by the message handlers.</p>
+<p>The second and arguably the most important part of the message
+is the payload, which consists of the contents of the env:Body
+element. This is the actual message intended for the receiver, and
+it is the information that the main application will ultimately
+process.</p>
+<a name="messageexchange" id="messageexchange"></a>
+<h2>Message Exchange Patterns</h2>
+<p>Although all SOAP messages carry the same structure, the ways in
+which they are used can be combined into a number of different
+"message exchange patterns", or MEPs. The two major message
+exchange patterns are:</p>
+<ul>
+<li>In-Out: in this MEP, the client sends a SOAP message to the
+server, which processes the message and sends a response back. This
+is probably the most commonly used MEP, and is useful for tasks
+such as searching for information or submitting information in
+situations in where acknowledgment is important.</li>
+<li>In-Only: In this MEP, the client sends a message to the server
+without expecting a response. You may use this MEP for activities
+such as pinging a server to wake it up, reporting logging
+information for which you do not need an acknowledgment and so
+on.</li>
+</ul>
+<p>Within these two MEPs, you also have several variables to
+consider:</p>
+<ul>
+<li>Blocking versus non-blocking: When the client sends a message,
+the application may wait to receive a response before moving on, or
+it may simply send a message and move on by specifying a callback
+action to be completed when the response is received.</li>
+<li>Number of parameters: Ultimately, a message sent from a client
+to server is intended to execute a particular action. That action
+may not require any parameters, or it may require one or more
+parameters. These parameters must be encoded as part of the payload
+of the message.</li>
+</ul>
+<p>Taking all these options into consideration, you can create
+virtually any MEP. For example, you can create an Out-Only system
+by reversing roles for the In-Only MEP. Apache Axis2 also includes
+support for less prominent MEPs, such as Robust-In-Only.</p>
+<p><strong>See Next Section</strong> - <a href=
+"userguide-creatingclients.html#createclients">Creating
+Clients</a></p>
+</body>
+</html>
Copied: webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/userguide-samples.xml (from r556217, webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/userguide-samples.html)
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/%40axis2_version_dir%40/userguide-samples.xml?view=diff&rev=556222&p1=webservices/axis2/trunk/java/xdocs/%40axis2_version_dir%40/userguide-samples.html&r1=556217&p2=webservices/axis2/trunk/java/xdocs/%40axis2_version_dir%40/userguide-samples.xml&r2=556222
==============================================================================
--- webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/userguide-samples.html (original)
+++ webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/userguide-samples.xml Fri Jul 13 21:37:26 2007
@@ -1,222 +1,203 @@
-<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one
- ~ or more contributor license agreements. See the NOTICE file
- ~ distributed with this work for additional information
- ~ regarding copyright ownership. The ASF licenses this file
- ~ to you under the Apache License, Version 2.0 (the
- ~ "License"); you may not use this file except in compliance
- ~ with the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing,
- ~ software distributed under the License is distributed on an
- ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~ KIND, either express or implied. See the License for the
- ~ specific language governing permissions and limitations
- ~ under the License.
- -->
-<html lang="en">
-<head>
- <meta http-equiv="content-type" content="">
- <title>Apache Axis2 User's Guide- The Samples</title>
- <link href="../css/axis-docs.css" rel="stylesheet" type="text/css"
- media="all">
-</head>
-
-<body lang="en">
-<a name="samples"></a>
-
-<h1>Apache Axis2 User's Guide - The Samples</h1>
-
-<p>The Apache Axis2 Standard Distribution provides a number of samples you
-can use as a guide for implementing specific features and capabilities. These
-services are listed in this section.</p>
-
-<h2>Content</h2>
-<ul>
- <li><a href="userguide.html#intro">Introducing Axis2</a><br>
-
- <ul>
- <li><a href="userguide.html#whatis">What is Axis2?</a></li>
- <li><a href="userguide.html#underhood">What's under the hood?</a></li>
- <li><a href="userguide.html#handlessoap">How Axis2 handles SOAP
- messages</a></li>
- <li><a href="userguide.html#distributions">Axis2 distributions</a></li>
- <li><a href="userguide.html#sbd">The Axis2 Standard Binary
- Distribution</a></li>
- <li><a href="userguide.html#hierarchy">Axis2.war Directory
- Hierarchy</a></li>
- <li><a href="userguide.html#docs">Axis2 Documents Distribution</a></li>
- <li><a href="userguide.html#clients">Axis2 and clients</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 the 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"><strong>Samples</strong></a>
- <ul>
- <li><a
- href="userguide-samples.html#clients"><strong>Clients</strong></a></li>
- <li><a
- href="userguide-samples.html#services"><strong>Services</strong></a></li>
- <li><a href="userguide-samples.html#wsdl"><strong>Sample WSDL
- files</strong></a></li>
- <li><a href="userguide-samples.html#others"><strong>Other
- Samples</strong></a></li>
- </ul>
- </li>
- <li><a href="userguide-forfurtherstudy.html">For Further Study</a></li>
-</ul>
-<a name="clients"></a>
-
-<h2>Clients (in AXIS2_HOME/samples/userguide/src/clients):</h2>
-
-<p><strong>EchoBlockingClient.java</strong>: A basic example of the
-send/receive MEP.</p>
-
-<p><strong>EchoBlockingDualClient.java</strong>: Specifies that the return
-message should be sent over a different channel than the request message.</p>
-
-<p><strong>EchoBlockingWsaBasedClient.java</strong>: Provides an example of
-using the capabilities of WS-Addressing action mapping.</p>
-
-<p><strong>EchoNonBlockingClient.java</strong>: Demonstrates an asynchronous
-request using Callbacks.</p>
-
-<p><strong>EchoNonBlockingDualClient.java</strong>: Similar to the above, but
-uses a separate listener for the response.</p>
-
-<p><strong>ClientForWebServiceWithModule.java</strong>: Simply makes a call
-to a service with engaged modules.</p>
-
-<p><strong>ClientSideModuleEngagement.java</strong>: Demonstrates the use of
-modules on the client side, in addition to the server side.</p>
-
-<p><strong>MailClient.java</strong>: Demonstrates the use of the Robust
-In-Only MEP.</p>
-
-<p><strong>PingClient.java</strong>: A simple "fire and forget" client.</p>
-
-<p><strong>RESTClient.java</strong>: Demonstrates the ability to request a
-REST response rather than a SOAP response. Also demonstrates setting
-arbitrary properties on the Options object.</p>
-
-<p><strong>TCPClient.java</strong>: Provides an example of using the TCP
-transport rather than HTTP.</p>
-<a name="services"></a>
-
-<h2>Services (in AXIS2_HOME/samples/userguide):</h2>
-
-<p><strong>groovyService.aar</strong>: Demonstrates how to use Groovy classes
-in the processing of SOAP messages.</p>
-
-<p><strong>MyService.aar</strong>: Provides simple "echo" and "ping"
-operations.</p>
-
-<p><strong>MyServiceWithModule.aar</strong>: Same as above, but demonstrates
-how to engage a module.</p>
-
-<p><strong>WsaMappingService.aar</strong>: Demonstrates the mapping of
-WS-Addressing actions.</p>
-<a name="wsdl"></a>
-
-<h2>Sample WSDL files (in AXIS2_HOME/samples):</h2>
-
-<p><strong>Axis2SampleDocLit.wsdl</strong>: Demonstrates the use of the
-Document/Literal WSDL pattern, rather than RPC.</p>
-
-<p><strong>perf.wsdl</strong>: Demonstrates the use of array values as input
-values.</p>
-<a name="others"></a>
-
-<h2>Other samples</h2>
-
-<h3>In AXIS2_HOME/samples Directory:</h3>
-<!--<p><strong>amazonqs</strong>: Uses the Amazon Queue Service to store and
-retrieve String objects.</p>-->
-
-<p><strong>faulthandling</strong>: Demonstrates the use of SOAP faults and
-their definitions in WSDL enabling exception processing in the client.</p>
-<!--<p><strong>googlesearch</strong>: Creates a GUI-based application making use
-of Google Web Services asynchronously.</p>-->
-
-<p><strong>googleSpellcheck</strong>: Demonstrates both synchronous and
-non-synchronous use of the Google Web Service in a GUI.</p>
-
-<p><strong>mtom</strong>: Demonstrates the use of MTOM and SOAP with
-Attachments to send binary files to a service.</p>
-
-<p><strong>saopwithattachments</strong>: Demonstrates the capabilities and
-power of SOAP with Attachment support and the Attachment API of Axis2.</p>
-
-<p><strong>pojo</strong>: Example of a POJO (Plain Old Java Object) Web
-service. It shows how to expose the methods of a Java class as a Web service
-using Apache Aixs2.</p>
-
-<p><strong>servicelifecycle</strong>: Demonstrates the usage of a service
-life cycle and a bit of session management. The main idea is to show where
-and how to use the service life cycle interface and session related
-methods.</p>
-<!--<p><strong>sgccalculator</strong>: A simple calculator that demonstrates the
-use of Service Groups.</p>-->
-
-<p><strong>databinding</strong>: Demonstrates how to use WSDL2Java generated
-code with Castor.</p>
-
-<p><strong>version</strong>: A very simple service that simply outputs the
-Apache Axis2 version.</p>
-
-<p><strong>yahoorestearch</strong>: A complete example of the use of a REST
-service rather than a SOAP service.</p>
-
-<h3>External:</h3>
-
-<p><strong>FlickrClient</strong> : Demonstrates code generation capabilities
-for WSDL 2.0. The FlickrService.wsdl describes services offered by flickr in
-terms of WSDL 2.0. It also demonstrates how a restful service can be
-described using the HTTPBinding of wsdl 2.0.</p>
-
-<p>Extract the <a
-href="http://dist.wso2.org/products/wsas/java/nightly-build/">WSO2 WSAS for
-Java nightly build distribution</a> and you will find the sample at
-WSAS_HOME/samples/FlickrClient or checkout sample from SVN:
-http://wso2.org/repos/wso2/trunk/wsas/java/modules/samples/FlickrClient</p>
-
-<p><strong>See Next Section</strong> - <a
-href="userguide-forfurtherstudy.html">For Further Study</a></p>
-</body>
-</html>
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you under the Apache License, Version 2.0 (the
+ ~ "License"); you may not use this file except in compliance
+ ~ with the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing,
+ ~ software distributed under the License is distributed on an
+ ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~ KIND, either express or implied. See the License for the
+ ~ specific language governing permissions and limitations
+ ~ under the License.
+ -->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html lang="en" xmlns="http://www.w3.org/1999/xhtml" xml: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="" />
+<title>Apache Axis2 User's Guide- The Samples</title>
+<link href="../css/axis-docs.css" rel="stylesheet" type="text/css"
+media="all" />
+</head>
+<body lang="en" xml:lang="en">
+<a name="samples" id="samples"></a>
+<h1>Apache Axis2 User's Guide - The Samples</h1>
+<p>The Apache Axis2 Standard Distribution provides a number of
+samples you can use as a guide for implementing specific features
+and capabilities. These services are listed in this section.</p>
+<h2>Content</h2>
+<ul>
+<li><a href="userguide.html#intro">Introducing Axis2</a><br />
+<ul>
+<li><a href="userguide.html#whatis">What is Axis2?</a></li>
+<li><a href="userguide.html#underhood">What's under the
+hood?</a></li>
+<li><a href="userguide.html#handlessoap">How Axis2 handles SOAP
+messages</a></li>
+<li><a href="userguide.html#distributions">Axis2
+distributions</a></li>
+<li><a href="userguide.html#sbd">The Axis2 Standard Binary
+Distribution</a></li>
+<li><a href="userguide.html#hierarchy">Axis2.war Directory
+Hierarchy</a></li>
+<li><a href="userguide.html#docs">Axis2 Documents
+Distribution</a></li>
+<li><a href="userguide.html#clients">Axis2 and clients</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 the 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"><strong>Samples</strong></a>
+<ul>
+<li><a href=
+"userguide-samples.html#clients"><strong>Clients</strong></a></li>
+<li><a href=
+"userguide-samples.html#services"><strong>Services</strong></a></li>
+<li><a href="userguide-samples.html#wsdl"><strong>Sample WSDL
+files</strong></a></li>
+<li><a href="userguide-samples.html#others"><strong>Other
+Samples</strong></a></li>
+</ul>
+</li>
+<li><a href="userguide-forfurtherstudy.html">For Further
+Study</a></li>
+</ul>
+<a name="clients" id="clients"></a>
+<h2>Clients (in AXIS2_HOME/samples/userguide/src/clients):</h2>
+<p><strong>EchoBlockingClient.java</strong>: A basic example of the
+send/receive MEP.</p>
+<p><strong>EchoBlockingDualClient.java</strong>: Specifies that the
+return message should be sent over a different channel than the
+request message.</p>
+<p><strong>EchoBlockingWsaBasedClient.java</strong>: Provides an
+example of using the capabilities of WS-Addressing action
+mapping.</p>
+<p><strong>EchoNonBlockingClient.java</strong>: Demonstrates an
+asynchronous request using Callbacks.</p>
+<p><strong>EchoNonBlockingDualClient.java</strong>: Similar to the
+above, but uses a separate listener for the response.</p>
+<p><strong>ClientForWebServiceWithModule.java</strong>: Simply
+makes a call to a service with engaged modules.</p>
+<p><strong>ClientSideModuleEngagement.java</strong>: Demonstrates
+the use of modules on the client side, in addition to the server
+side.</p>
+<p><strong>MailClient.java</strong>: Demonstrates the use of the
+Robust In-Only MEP.</p>
+<p><strong>PingClient.java</strong>: A simple "fire and forget"
+client.</p>
+<p><strong>RESTClient.java</strong>: Demonstrates the ability to
+request a REST response rather than a SOAP response. Also
+demonstrates setting arbitrary properties on the Options
+object.</p>
+<p><strong>TCPClient.java</strong>: Provides an example of using
+the TCP transport rather than HTTP.</p>
+<a name="services" id="services"></a>
+<h2>Services (in AXIS2_HOME/samples/userguide):</h2>
+<p><strong>groovyService.aar</strong>: Demonstrates how to use
+Groovy classes in the processing of SOAP messages.</p>
+<p><strong>MyService.aar</strong>: Provides simple "echo" and
+"ping" operations.</p>
+<p><strong>MyServiceWithModule.aar</strong>: Same as above, but
+demonstrates how to engage a module.</p>
+<p><strong>WsaMappingService.aar</strong>: Demonstrates the mapping
+of WS-Addressing actions.</p>
+<a name="wsdl" id="wsdl"></a>
+<h2>Sample WSDL files (in AXIS2_HOME/samples):</h2>
+<p><strong>Axis2SampleDocLit.wsdl</strong>: Demonstrates the use of
+the Document/Literal WSDL pattern, rather than RPC.</p>
+<p><strong>perf.wsdl</strong>: Demonstrates the use of array values
+as input values.</p>
+<a name="others" id="others"></a>
+<h2>Other samples</h2>
+<h3>In AXIS2_HOME/samples Directory:</h3>
+<!--<p><strong>amazonqs</strong>: Uses the Amazon Queue Service to store and
+retrieve String objects.</p>-->
+<p><strong>faulthandling</strong>: Demonstrates the use of SOAP
+faults and their definitions in WSDL enabling exception processing
+in the client.</p>
+<!--<p><strong>googlesearch</strong>: Creates a GUI-based application making use
+of Google Web Services asynchronously.</p>-->
+<p><strong>googleSpellcheck</strong>: Demonstrates both synchronous
+and non-synchronous use of the Google Web Service in a GUI.</p>
+<p><strong>mtom</strong>: Demonstrates the use of MTOM and SOAP
+with Attachments to send binary files to a service.</p>
+<p><strong>saopwithattachments</strong>: Demonstrates the
+capabilities and power of SOAP with Attachment support and the
+Attachment API of Axis2.</p>
+<p><strong>pojo</strong>: Example of a POJO (Plain Old Java Object)
+Web service. It shows how to expose the methods of a Java class as
+a Web service using Apache Aixs2.</p>
+<p><strong>servicelifecycle</strong>: Demonstrates the usage of a
+service life cycle and a bit of session management. The main idea
+is to show where and how to use the service life cycle interface
+and session related methods.</p>
+<!--<p><strong>sgccalculator</strong>: A simple calculator that demonstrates the
+use of Service Groups.</p>-->
+<p><strong>databinding</strong>: Demonstrates how to use WSDL2Java
+generated code with Castor.</p>
+<p><strong>version</strong>: A very simple service that simply
+outputs the Apache Axis2 version.</p>
+<p><strong>yahoorestearch</strong>: A complete example of the use
+of a REST service rather than a SOAP service.</p>
+<h3>External:</h3>
+<p><strong>FlickrClient</strong> : Demonstrates code generation
+capabilities for WSDL 2.0. The FlickrService.wsdl describes
+services offered by flickr in terms of WSDL 2.0. It also
+demonstrates how a restful service can be described using the
+HTTPBinding of wsdl 2.0.</p>
+<p>Extract the <a href=
+"http://dist.wso2.org/products/wsas/java/nightly-build/">WSO2 WSAS
+for Java nightly build distribution</a> and you will find the
+sample at WSAS_HOME/samples/FlickrClient or checkout sample from
+SVN:
+http://wso2.org/repos/wso2/trunk/wsas/java/modules/samples/FlickrClient</p>
+<p><strong>See Next Section</strong> - <a href=
+"userguide-forfurtherstudy.html">For Further Study</a></p>
+</body>
+</html>
Copied: webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/userguide.xml (from r556217, webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/userguide.html)
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/%40axis2_version_dir%40/userguide.xml?view=diff&rev=556222&p1=webservices/axis2/trunk/java/xdocs/%40axis2_version_dir%40/userguide.html&r1=556217&p2=webservices/axis2/trunk/java/xdocs/%40axis2_version_dir%40/userguide.xml&r2=556222
==============================================================================
--- webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/userguide.html (original)
+++ webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/userguide.xml Fri Jul 13 21:37:26 2007
@@ -1,379 +1,374 @@
-<?xml version="1.0" encoding=""?>
-<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one
- ~ or more contributor license agreements. See the NOTICE file
- ~ distributed with this work for additional information
- ~ regarding copyright ownership. The ASF licenses this file
- ~ to you under the Apache License, Version 2.0 (the
- ~ "License"); you may not use this file except in compliance
- ~ with the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing,
- ~ software distributed under the License is distributed on an
- ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~ KIND, either express or implied. See the License for the
- ~ specific language governing permissions and limitations
- ~ under the License.
- -->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <meta http-equiv="content-type" content="" />
- <title>Apache Axis2 User's Guide- Introducing Axis2</title>
- <link href="../css/axis-docs.css" rel="stylesheet" type="text/css"
- media="all" />
-</head>
-
-<body xml:lang="en" lang="en">
-<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
-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
- href="http://www.oasis-open.org/committees/download.php/16790/wss-v1.1-spec-os-SOAPMessageSecurity.pdf">WS-Security</a>,
- <a
- href="http://xml.coverpages.org/ws-reliablemessaging20030313.pdf">WS-ReliableMessaging</a>,
- <a href="http://www.w3.org/2002/ws/addr/">WS-Addressing</a>, <a
- href="http://dev2dev.bea.com/pub/a/2004/03/ws-coordination.html">WS-Coordination</a>,
- and <a
- 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 alt="Lifecycle of a Web services message" src="images/fig01.jpg"
-/><br clear="all" />
-</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 alt="Axis2 handles SOAP messages" src="images/fig02.jpg" /><br
-clear="all" />
-</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
-href="http://ws.apache.org/axis2/download/@axis2_version_dir@/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
-href="http://ws.apache.org/axis2/download/@axis2_version_dir@/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
-href="http://ws.apache.org/axis2/download/@axis2_version_dir@/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
-href="http://ws.apache.org/axis2/download/@axis2_version_dir@/download.cgi#src">source
-distribution</a>, which enables you to generate this .war file yourself.</p>
-<a id="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>
-</body>
-</html>
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you under the Apache License, Version 2.0 (the
+ ~ "License"); you may not use this file except in compliance
+ ~ with the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing,
+ ~ software distributed under the License is distributed on an
+ ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~ KIND, either express or implied. See the License for the
+ ~ specific language governing permissions and limitations
+ ~ under the License.
+ -->
+<!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" 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="" />
+<title>Apache Axis2 User's Guide- Introducing Axis2</title>
+<link href="../css/axis-docs.css" rel="stylesheet" type="text/css"
+media="all" />
+</head>
+<body xml:lang="en" lang="en">
+<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" id=
+"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 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" id="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 href=
+"http://www.oasis-open.org/committees/download.php/16790/wss-v1.1-spec-os-SOAPMessageSecurity.pdf">
+WS-Security</a>, <a href=
+"http://xml.coverpages.org/ws-reliablemessaging20030313.pdf">WS-ReliableMessaging</a>,
+<a href="http://www.w3.org/2002/ws/addr/">WS-Addressing</a>,
+<a href=
+"http://dev2dev.bea.com/pub/a/2004/03/ws-coordination.html">WS-Coordination</a>,
+and <a 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" id="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 alt="Lifecycle of a Web services message" src=
+"images/fig01.jpg" /><br clear="all" /></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" id="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 alt="Axis2 handles SOAP messages" src=
+"images/fig02.jpg" /><br clear="all" /></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" id="distributions"></a>
+<h2>Axis2 Distributions</h2>
+<p>Axis2 is released in several <a href=
+"http://ws.apache.org/axis2/download/@axis2_version_dir@/download.cgi">
+distributions</a>. Which one you need depends on what you'll be
+doing with it.</p>
+<a name="sbd" id="sbd"></a>
+<h3>The Axis2 Standard Binary Distribution</h3>
+<p>If you're developing services and applications, you'll need the
+Axis2 <a href=
+"http://ws.apache.org/axis2/download/@axis2_version_dir@/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" id="hierarchy"></a>
+<h2>axis2.war Distribution Directory Hierarchy</h2>
+<p>axis2.war is available in <a href=
+"http://ws.apache.org/axis2/download/@axis2_version_dir@/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 href=
+"http://ws.apache.org/axis2/download/@axis2_version_dir@/download.cgi#src">
+source distribution</a>, which enables you to generate this .war
+file yourself.</p>
+<a id="docs" 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" id="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>
+</body>
+</html>
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org