Author: chatra Date: Mon Oct 23 04:07:11 2006 New Revision: 466970 URL: http://svn.apache.org/viewvc?view=rev&rev=466970 Log: restructured installationguide.html
Modified: webservices/axis2/branches/java/1_1/xdocs/1_1/installationguide.html webservices/axis2/branches/java/1_1/xdocs/download/1_1/download.html Modified: webservices/axis2/branches/java/1_1/xdocs/1_1/installationguide.html URL: http://svn.apache.org/viewvc/webservices/axis2/branches/java/1_1/xdocs/1_1/installationguide.html?view=diff&rev=466970&r1=466969&r2=466970 ============================================================================== --- webservices/axis2/branches/java/1_1/xdocs/1_1/installationguide.html (original) +++ webservices/axis2/branches/java/1_1/xdocs/1_1/installationguide.html Mon Oct 23 04:07:11 2006 @@ -21,24 +21,19 @@ <h2>Contents</h2> <ul> <li><a href="#Download_Axis2">Download Axis2</a></li> - <li><p><a href="#requirements">System Requirements</a></p> - </li> - <li><p><a href="#source">Axis2 Source Distribution</a></p> + <li><a href="#requirements">System Requirements</a></li> + <li><a href="#_Toc96698086">Installing Axis2 in a Servlet Container</a></li> + <li><a href="#upload">Uploading Services</a></li> + <li><a href="#advanced">Advanced</a> <ul> - <li><a href="#_Toc96698083">Setting up the Environment and Tools</a> + <li><a href="#source">Axis2 Source Distribution</a> <ul> - <li><p><a href="#maven">Maven</a></p> - </li> + <li><a href="#_Toc96698083">Setting up the Environment and + Tools</a></li> + <li><a href="#_Toc96698085">Building Axis2 Binaries and WAR file + Using the Source Distribution</a></li> </ul> </li> - <li><a href="#_Toc96698085">Building Axis2 using the Source - Distribution</a></li> - </ul> - </li> - <li><p><a href="#_Toc96698086">Installing Axis2 in a Servlet - Container</a></p> - <ul> - <li><a href="#upload">Uploading Services</a></li> </ul> </li> </ul> @@ -49,44 +44,66 @@ <p>Axis2 is distributed in several convenient distribution packages and can be installed either as a standalone server or as part of a J2EE compliant servlet container. Axis2 is distributed under the Apache License, version -2.0.</p> - -<p>The distribution packages provided are as follows:</p> +2.0. This User's Guide will mainly focus on running Apache Axis2 using the +Standard Binary Distribution.</p> -<h3>1. Minimal Binary Distribution</h3> +<p><a href="../download/1_1/download.html">Download</a> distribution packages +of the latest release -Axis2 is <a href="../index.html">version 1.1</a>. +Distribution packages of all versions are available for <a +href="http://ws.apache.org/axis2/download.cgi">download.</a></p> -<p>This distribution is aimed at advanced users who will be embedding Axis2. -It will contain the minimal runtime required to act as a Web service client -and/or a server (axis2-kernel-1.1.jar will contain compiled versions of -common and core modules.)</p> +<p>The Distribution Packages Provided are as follows:</p> -<h3><a name="std-bin" id="std-bin"></a>2. Standard Binary Distribution</h3> +<h3><a name="std-bin" id="std-bin"></a>1. Standard Binary Distribution</h3> <p>This is the complete version of Axis2 and will contain useful samples as -well. Useful for some one to get familiar with Axis2. (Since WS-Addressing +well. Useful for some one to get familiar with Axis2. Since WS-Addressing implementation module is engaged in to Axis2, by default, this distribution -will contain addressing.mar. But the other modules that are being developed -within Axis2 will not be included here and are available to be downloaded -separately from <a href="../modules/index.html">here</a>.)</p> +will contain addressing.mar. But the other modules that are being developed +within Axis2 will not be included here and are available to be <a +href="../modules/index.html">downloaded</a> separately.</p> + +<p><a href="../download/1_1/download.html#std-bin">Download</a> Standard +Binary Distribution</p> +<a name="war"></a> -<h3>3. Source Distribution </h3> +<h3>2. WAR (Web Archive) Distribution</h3> -<p>This will contain the sources of Axis2 standard distribution. One can -generate a binary distribution from this by typing <span -class="style1">$maven dist-standard-bin. </span>(<a -href="http://ws.apache.org/axis2/1_1/installationguide.html#_Toc96698083">Set -up Axis2 environment</a> before running this command)</p> +<p>This will be the Web application of Axis2 which can be deployed in most of +the servlet containers.</p> + +<p><a href="../download/1_1/download.html#war">Download</a> StandardBinary +Distribution</p> + +<h3>3. Documents Distribution</h3> + +<p>This will contain all the documentation in one package. The package +includes the xdocs and the Java API docs of this project.</p> -<h3>4. Documents Distribution</h3> +<p><a href="../download/1_1/download.html#docs">Download</a> Documents +Distribution</p> -<p>This will contain all the documentation in one package.</p> +<h3>4. Source Distribution</h3> -<p>All distribution packages are available for <a -href="http://ws.apache.org/axis2/download.cgi">download</a>.</p> +<p>This will contain the sources of Axis2 standard distribution, and is +mainly for the benefit of the advance users. One can generate a binary +distribution using the source by typing <span class="style1">$maven +dist-standard-bin. </span> You need to set up the Axis2 environment before +running this command. Step by step details on how to create the binary +distribution is available in the <a href="advanced">Advanced</a> section.</p> + +<p><a href="../download/1_1/download.html#src">Download</a> Source +Distribution</p> + +<h3>5. Minimal Binary Distribution</h3> + +<p>This distribution is aimed at advanced users who will be embedding Axis2. +It will contain the minimal runtime required to act as a Web service client +and/or a server (axis2-kernel-1.1.jar will contain compiled versions of +common and core modules.)</p> -<p>Latest release of Axis2 is <a href="../index.html">version 1.1</a>. <a -href="../download/1_1/download.html">See complete list of Axis2 1.1 -distribution packages and their descriptions.</a></p> +<p><a href="../download/1_1/download.html#min">Download</a> Minimal Binary +Distribution</p> <!--<table width="940" border="1" cellpadding="1"> <tbody> <tr> @@ -206,7 +223,7 @@ <strong>Please download maven 1.x version. Axis2 is not compatible with maven2 yet.</strong> - <p>Required only for building Axis2 from source distribution</p> + <p>Required only for building Axis2 from Source Distribution</p> </td> </tr> <tr> @@ -228,14 +245,111 @@ </tbody> </table> -<p>All the required jars are shipped with the binary distribution.</p> +<h2>Standalone Insatallation Using Standard Binary Distribution</h2> + +<p>All the required jars required are shipped with the standard binary +distribution.</p> + +<p>Installing Axis2 is merely a matter of downloading and extracting the +Standard Binary Distribution and setting the Java home.</p> + +<h2>Installing Axis2 in a Servlet Container</h2> + +<p>Which ever the distribution, installing Axis2 in a J2EE compliant servlet +container is as follows:</p> +<ol> + <li><a href="../download/1_1/download.html#war">Download</a> Axis2 WAR + file. The WAR file can also be <a href="#war">built using the Source + Distribution</a>.</li> + <li>Drop the war in the webapps folder of the servlet container. Most + servlet containers will automatically install war. (some servlet + containers may require a restart in order to capture the new web + application. Refer your servlet container documentation for more + information about this.)</li> + <li>Once the WAR is successfully installed, test it by pointing the web + browser to the <strong>http://<host :port>/axis2. </strong>It + should produce the following page which is the <strong>Axis2 Web + Application Home Page</strong>.</li> +</ol> + +<p align="center"><strong><img src="images/clip_image006.jpg" +alt=""></strong></p> + +<p></p> +<ul> + <li>Use the link "Validate" to ensure that everything is fine and smooth. + If the validation fails then the war has failed to install properly or + some essential jars are missing. At such a situation the documentation of + the particular servlet container should be consulted to find the problem. + The following page is a successful validation. Note the statement core + Axis2 libraries are present.</li> +</ul> + +<p align="center"><img src="images/happyaxis.jpg"></p> +<a name="upload"></a> + +<h2>Uploading Services</h2> +<ol> + <p>The Axis2 Web application also provides an interface to upload services. + Once a service is created according to the service specification as + described in <a name="userguide.html" target="_blank">User's Guide that jar + file can be uploaded using the upload page.</a></p> + + <p align="center"><strong><img src="images/clip_image010.jpg" + alt=""></strong></p> + + <p>The uploaded jar files will be stored in the default service directory. + For Axis2 this will be the <webapps>/axis2/WEB-INF/services + directory. Once a service is uploaded it will be installed instantly.</p> + <a name="hot_deployment"></a> + + <p>Since Axis2 supports <strong>hot deployment</strong> one can drop the + service jar directly through the file system to the above mentioned + services directory.It will also cause the service to be automatically + installed without the container being restarted.</p> + + <p>Use the 'Services' link on the Web Application home page to check the + successful installation of a service. The services and the operations of + successfully installed services will be displayed in the available services + page.</p> + + <p align="center"><img src="images/clip_image012.jpg" alt=""></p> + + <p></p> + + <p>If the service has deployment time errors it will list those services as + faulty services. If you click on the link you can see the your deployment + fault error message(s).</p> + + <p align="center"><img src="images/faultservice.jpg" alt=""></p> + + <p>Deployment time error message</p> -<p>Running the Maven build will automatically download the required jars when -using source distribution.</p> + <p align="center"><strong><img src="images/faultmsg.jpg" + alt=""></strong></p> + + <p></p> + + <p>Axis2 Administration is all about configuring Axis2 at the run time and + the configuration will be transient. More descriptions are available in <a + href="webadminguide.html" target="_blank">Axis2 Web Administration + Guide</a></p> +</ol> +<a name="advanced"></a> + +<h2>Advanced</h2> <a name="source"></a> <h2>Axis2 Source Distribution</h2> -<a name="_Toc96698083"></a> +<a name="_Toc96698083">Using the Source Distribution both brinary files +(which is downloadable as the </a><a href="std-bin">Standard Binary +Ditribution</a>) and axis2.war file (which is downloadable as the <a +href="war">WAR distribution</a>) can be built using maven commands. + +<p>Required jar files do not come with the distribution and they will also +have to be built by running the maven command. Before we go any further is is +necessary to install <a href="http://maven.apache.org/maven-1.x/" +target="_blank">Maven</aandsettheEnvironment.Thenextsectionwillguideyouhowtodojustthat.></a></p> <h3>Setting Up the Environment and Tools</h3> <a name="maven"></a> @@ -245,7 +359,7 @@ <p>The Axis2 build is based on <a href="http://maven.apache.org/maven-1.x/" target="_blank">Maven </a>. Hence the only prerequisite to build Axis2 from source distribution is to have Maven installed. Extensive instruction guides -are available at the Maven site.This guide however contains the easiest path +are available at the Maven site. This guide however contains the easiest path for quick environment setting. Advanced users who wish to know more about Maven can visit <a href="http://maven.apache.org/maven-1.x/start/index.html" target="_blank">here </a>.</p> @@ -253,7 +367,7 @@ <li>MS Windows</li> </ul> <ol> - <li>Download and run the Windows installer package</li> + <li>Download and run the Windows installer package for Maven.</li> <li>Set the 'Environment Variables' ( create system variable MAVEN_HOME and edit path. eg: "C:\Program Files\Apache Software Foundation\maven-1.0.2"; path %MAVEN_HOME%\bin)</li> @@ -282,12 +396,11 @@ <p><a name="_Toc96698085"></a></p> -<h3>Building Axis2 using the Source Distribution</h3> +<h3>Building Binaries and WAR File Using the Source Distribution</h3> -<p>The <a href="http://ws.apache.org/axis2/download.cgi" -target="_blank">source distribution </a> is available as a zipped archive. -All the necessary build scripts are included with the source distribution. -Once the source archive is expanded into a directory of choice, moving to the +<p>The Source Distribution is available as a zipped archive. All the +necessary build scripts are included with the source distribution. Once the +source archive is expanded into a directory of choice, moving to the particular directory and running <code>maven</code> command will build the Axis2 jar file.</p> @@ -311,86 +424,5 @@ <p>Once this build step is complete, the binaries are ready to be deployed.</p> -<a name="_Toc96698086"></a> - -<h2>Installing Axis2 in a Servlet Container</h2> -<ol> - <li>Either use the <a href="#war">axis2.war</a> file built using the above - intructions or <a href="../download/1_1/download.html#war" - target="_blank">Download</a> Axis2 WAR file.</li> - <li>Drop the war in the webapps folder. Most servlet containers will - automatically install war. (some servlet containers may require a restart - in order to capture the new web application. Refer your servlet container - documentation for more information about this.)</li> - <li>Once the WAR is successfully installed, test it by pointing the web - browser to the <strong>http://<host :port>/axis2. </strong>It - should produce the following page which is the <strong>Axis2 Web - Application Home Page</strong>.</li> - - <p align="center"><strong><img src="images/clip_image006.jpg" - alt=""></strong></p> - - <p></p> - <li>Use the link "Validate" to ensure that everything is fine and smooth. - If the validation fails then the war has failed to install properly or - some essential jars are missing. At such a situation the documentation of - the particular servlet container should be consulted to find the problem. - The following page is a successful validation. Note the statement core - Axis2 libraries are present. - <p></p> - </li> - - <p align="center"><strong><img src="images/happyaxis.jpg" - alt=""></strong></p> -</ol> -<a name="upload"></a> - -<h3>Uploading Services</h3> -<ol> - <p>The Axis2 web application also provides an interface to upload services. - Once a service is created according to the service specification as - described in <a name="userguide.html" target="_blank">User's Guide that jar - file can be uploaded using the upload page.</a></p> - - <p align="center"><strong><img src="images/clip_image010.jpg" - alt=""></strong></p> - - <p>The uploaded jar files will be stored in the default service directory. - For Axis2 this will be the <webapps>/axis2/WEB-INF/services - directory. Once a service is uploaded it will be installed instantly.</p> - <a name="hot_deployment"></a> - - <p>Since Axis2 supports <strong>hot deployment</strong> one can drop the - service jar directly through the file system to the above mentioned - services directory.It will also cause the service to be automatically - installed without the container being restarted.</p> - - <p>Use the 'Services' link on the Web Application home page to check the - successful installation of a service. The services and the operations of - successfully installed services will be displayed in the available services - page.</p> - - <p align="center"><img src="images/clip_image012.jpg" alt=""></p> - - <p></p> - - <p>If the service has deployment time errors it will list those services as - faulty services. If you click on the link you can see the your deployment - fault error message(s).</p> - - <p align="center"><img src="images/faultservice.jpg" alt=""></p> - - <p>Deployment time error message</p> - - <p align="center"><strong><img src="images/faultmsg.jpg" - alt=""></strong></p> - - <p></p> - - <p>Axis2 Administration is all about configuring Axis2 at the run time and - the configuration will be transient. More descriptions are available in <a - href="webadminguide.html" target="_blank">Axis2 Web Administration - Guide</a></p> -</ol> -</body> +<a name="_Toc96698086"></a></body> </html> Modified: webservices/axis2/branches/java/1_1/xdocs/download/1_1/download.html URL: http://svn.apache.org/viewvc/webservices/axis2/branches/java/1_1/xdocs/download/1_1/download.html?view=diff&rev=466970&r1=466969&r2=466970 ============================================================================== --- webservices/axis2/branches/java/1_1/xdocs/download/1_1/download.html (original) +++ webservices/axis2/branches/java/1_1/xdocs/download/1_1/download.html Mon Oct 23 04:07:11 2006 @@ -6,7 +6,9 @@ <body> <h2>Axis2 1.1 Release</h2> + <div> + <table border="1" cellpadding="1"> <tbody> <tr> @@ -15,49 +17,30 @@ <th scope="col">Items</th> <th scope="col">Download</th> </tr> + <!--<tr> + <td><strong>Minimal Distribution - Source</strong></td> + <td background="#_Toc96698083"><p>This will contain the sources of + Axis2 minimal distribution. One can generate a binary distribution + from this by typing <span class="style1">$maven dist-min-bin. + </span>(<a href="http://ws.apache.org/axis2/1_1/installationguide.html#_Toc96698083">Set + up Axis2 environment</a> before running this command)</p> + </td> + <td><ul> + <li>sources of Axis2 common, java2wsdl , adb and core modules</li> + <li>README.TXT and release-notes.html</li> + </ul> + </td> + <td><a href="[preferred]/ws/axis2/1_1/axis2-min-1.1-src.zip" + title="[preferred]/ws/axis2/1_1/axis2-min-1.1-src.zip">zip</a> <a + href="http://www.apache.org/dist/ws/axis2/1_1/axis2-min-1.1-src.zip.md5" + title="http://www.apache.org/dist/ws/axis2/1_1/axis2-min-1.1-src.zip.md5">MD5</a> + <a + href="http://www.apache.org/dist/ws/axis2/1_1/axis2-min-1.1-src.zip.asc" + title="http://www.apache.org/dist/ws/axis2/1_1/axis2-min-1.1-src.zip.asc">PGP</a></td> + </tr>--> <tr> - <td><strong>Minimal Distribution - Binary</strong></td> - <td>This distribution is aimed at advanced users who will be embedding - Axis2. It will contain the minimal runtime required to act as a Web - service client and/or a server (axis2-kernel-1.1.jar will contain - compiled versions of common and core modules.)</td> - <td><ul> - <li>axis2-kernel-1.1.jar, axis2-adb-1.1.jar</li> - <li>third party distributable libraries</li> - <li>README.TXT and release-notes.html</li> - </ul> - </td> - <td><a href="[preferred]/ws/axis2/1_1/axis2-min-1.1-bin.zip" - title="[preferred]/ws/axis2/1_1/axis2-min-1.1-bin.zip">zip</a> <a - href="http://www.apache.org/dist/ws/axis2/1_1/axis2-min-1.1-bin.zip.md5" - title="http://www.apache.org/dist/ws/axis2/1_1/axis2-min-1.1-bin.zip.md5">MD5</a> - <a - href="http://www.apache.org/dist/ws/axis2/1_1/axis2-min-1.1-bin.zip.asc" - title="http://www.apache.org/dist/ws/axis2/1_1/axis2-min-1.1-bin.zip.asc">PGP</a></td> - </tr> - <tr> - <td><strong>Minimal Distribution - Source</strong></td> - <td background="#_Toc96698083"><p>This will contain the sources of - Axis2 minimal distribution. One can generate a binary distribution - from this by typing <span class="style1">$maven dist-min-bin. - </span>(<a href="http://ws.apache.org/axis2/1_1/installationguide.html#_Toc96698083">Set - up Axis2 environment</a> before running this command)</p> - </td> - <td><ul> - <li>sources of Axis2 common, java2wsdl , adb and core modules</li> - <li>README.TXT and release-notes.html</li> - </ul> - </td> - <td><a href="[preferred]/ws/axis2/1_1/axis2-min-1.1-src.zip" - title="[preferred]/ws/axis2/1_1/axis2-min-1.1-src.zip">zip</a> <a - href="http://www.apache.org/dist/ws/axis2/1_1/axis2-min-1.1-src.zip.md5" - title="http://www.apache.org/dist/ws/axis2/1_1/axis2-min-1.1-src.zip.md5">MD5</a> - <a - href="http://www.apache.org/dist/ws/axis2/1_1/axis2-min-1.1-src.zip.asc" - title="http://www.apache.org/dist/ws/axis2/1_1/axis2-min-1.1-src.zip.asc">PGP</a></td> - </tr> - <tr> - <td><a name="std-bin"></a><strong>Standard Distribution - Binary</strong></td> + <td><a name="std-bin"></a><strong>Standard Binary + Distribution</strong></td> <td>This is the complete version of Axis2 and will contain useful samples as well. Useful for some one to get familiar with Axis2. (Since WS-Addressing implementation module is engaged in to Axis2, by @@ -81,12 +64,32 @@ title="http://www.apache.org/dist/ws/axis2/1_1/axis2-std-1.1-bin.zip.asc">PGP</a></td> </tr> <tr> - <td><a name="src"></a><strong>Standard Distribution - Source</strong></td> + <td><strong>Minimal Binary Distribution</strong></td> + <td>This distribution is aimed at advanced users who will be embedding + Axis2. It will contain the minimal runtime required to act as a Web + service client and/or a server (axis2-kernel-1.1.jar will contain + compiled versions of common and core modules.)</td> + <td><ul> + <li>axis2-kernel-1.1.jar, axis2-adb-1.1.jar</li> + <li>third party distributable libraries</li> + <li>README.TXT and release-notes.html</li> + </ul> + </td> + <td><a href="[preferred]/ws/axis2/1_1/axis2-min-1.1-bin.zip" + title="[preferred]/ws/axis2/1_1/axis2-min-1.1-bin.zip">zip</a> <a + href="http://www.apache.org/dist/ws/axis2/1_1/axis2-min-1.1-bin.zip.md5" + title="http://www.apache.org/dist/ws/axis2/1_1/axis2-min-1.1-bin.zip.md5">MD5</a> + <a + href="http://www.apache.org/dist/ws/axis2/1_1/axis2-min-1.1-bin.zip.asc" + title="http://www.apache.org/dist/ws/axis2/1_1/axis2-min-1.1-bin.zip.asc">PGP</a></td> + </tr> + <tr> + <td><a name="src"></a><strong> Source Distribution</strong></td> <td>This will contain the sources of Axis2 standard distribution. One can generate a binary distribution from this by typing <span class="style1">$maven dist-standard-bin. </span>(<a - href="http://ws.apache.org/axis2/1_1/installationguide.html#_Toc96698083">Set up Axis2 - environment</a> before running this command)</td> + href="http://ws.apache.org/axis2/1_1/installationguide.html#_Toc96698083">Set + up Axis2 environment</a> before running this command)</td> <td><ul> <li>all the content of minimal-source distribution</li> <li>Contents of codegen and doom modules</li> @@ -102,7 +105,8 @@ title="http://www.apache.org/dist/ws/axis2/1_1/axis2-std-1.1-src.zip.asc">PGP</a></td> </tr> <tr> - <td><a name="war"></a><strong>WAR (Web Archive) Distribution</strong></td> + <td><a name="war"></a><strong>WAR (Web Archive) + Distribution</strong></td> <td>This will be the web application of Axis2 which can be deployed in most of the servlet containers.</td> <td><ul> @@ -147,9 +151,9 @@ </table> </div> - <div align="left"> <br> + <p>[if-any logo] <a href="[link]"><img align="right" src="[logo]" border="0"></a>[end] The currently selected mirror is <b>[preferred]</b>. If --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]