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 de...@apache.org on 2005/12/20 11:24:52 UTC
svn commit: r357950 -
/webservices/axis2/trunk/java/xdocs/installationguide.html
Author: deepal
Date: Tue Dec 20 02:24:39 2005
New Revision: 357950
URL: http://svn.apache.org/viewcvs?rev=357950&view=rev
Log:
applied installationguide patch
Modified:
webservices/axis2/trunk/java/xdocs/installationguide.html
Modified: webservices/axis2/trunk/java/xdocs/installationguide.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/xdocs/installationguide.html?rev=357950&r1=357949&r2=357950&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/installationguide.html (original)
+++ webservices/axis2/trunk/java/xdocs/installationguide.html Tue Dec 20 02:24:39 2005
@@ -6,62 +6,110 @@
</head>
<body lang="en">
-<h3><a name="_Toc96698081"></a>Introduction</h3>
+<h3><a name="_Toc96698081"></a>Download Axis2</h3>
-<p>Axis 2.0 can be downloaded as a <a href="releases.html">zipped binary </a>
-or the <a
-href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/?root=Apache-SVN">source
-</a>. This section describes how Axis2 can be installed either as a
-standalone server or as part of a J2EE compliant servlet container.</p>
-
-<h3><a name="_Toc96698082"></a>Prerequisites</h3>
-
-<p>Axis2 requires the Java Runtime Environment to be properly installed.
-Axis2 is developed to be run on JRE 1.4 and upwards but it has not been fully
-tested with the latest JRE 1.5. Hence it is safe to run Axis2 with Java 1.4.
-If the JRE is not already in place it must be installed to proceed further.
-For instructions on setting up the JRE in different operating systems, please
-visit <a href="http://java.sun.com/">http://java.sun.com </a>.</p>
-
-<p>All the required jars are shipped with the binary distribution and if the
-source distribution is used, running the maven build will automatically
-download the required jars for you.</p>
-
-<p>Following sections describe how each type of distribution needs to be
-installed. Since the process with the source distribution is similar to the
-binary distribution after building, the first section explains the process of
-building Axis2 from source. If you have the binary distribution you can skip
-the build sections and directly go to the binary installation section.</p>
+<p>Axis2 is distributed in several formats 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>You can <a href="http://ws.apache.org/axis2/download.cgi">download</a>
+Axis2 as a zipped binary, WAR or the <a
+href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/?root=Apache-SVN">source</a>
+depending on your requirements.</p>
+
+<p>Latest release Axis2 version 0.93</p>
+
+<p></p>
+
+<h3>System Requirements</h3>
+
+<table border="2">
+ <caption></caption>
+ <tbody>
+ <tr>
+ <td>Java Runtime
+
+ <p>Environment</p>
+ </td>
+ <td>1.4 (It has not been fully tested on the latest JRE 1.5)
+
+ <p>For instructions on setting up the JRE in different operating
+ systems, visit <a
+ href="http://java.sun.com/">http://java.sun.com</a></p>
+ </td>
+ </tr>
+ <tr>
+ <td>Maven</td>
+ <td>1.0.2 or higher (<a href="http://maven.apache.org/">download</a>)
+
+ <p>Required only for building Axis2 from source distribution</p>
+ </td>
+ </tr>
+ <tr>
+ <td>Memory</td>
+ <td>No minimum requirement</td>
+ </tr>
+ <tr>
+ <td>Disk</td>
+ <td>No minimum requirement.
+
+ <p>Approximately 20 MB will be used for war distribution</p>
+ </td>
+ </tr>
+ <tr>
+ <td>Operating system</td>
+ <td>Tested on Windows XP, Mac OS X, Fedora core, Ubuntu</td>
+ </tr>
+ </tbody>
+</table>
+
+<p></p>
+
+<p>All the required jars are shipped with the binary distribution.</p>
-<h3><a name="_Toc96698083"></a>Building Axis2 from source</h3>
+<p>Running the Maven build will automatically download the required jars when
+using source distribution.</p>
-<h4><a name="_Toc96698084"></a>Setting up the Environment and the tools</h4>
+<p></p>
+
+<h3><a name="_Toc96698083"></a>Setting up the Environment and tools</h3>
+
+<h4><a name="_Toc96698084" id="_Toc96698084"></a>Maven</h4>
<p>The Axis2 build is based on <a href="http://maven.apache.org/">Maven </a>.
Hence the only prerequisite to build Axis2 from source distribution is to
-have Maven installed. Even though extensive instruction guides are available
-at the Maven site, this guide also 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/start/index.html">here </a>.</p>
-
-<p>For Windows users the easiest way is to download the windows installer
-package. Once the installer package is run, all the necessary environment
-variables will be properly set. Once Maven is installed, the success of the
-installation can be tested by typing maven version in the command prompt.</p>
+have Maven installed. Extensive instruction guides 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/start/index.html">here </a>.</p>
+
+<p>- Windows</p>
+<ol>
+ <li>Download and run the Windows installer package</li>
+ <li>Set the 'Environment Variables' ( create system variable MAVEN_HOME and
+ edit path. eg: "C:\Program Files\Apache Software Foundation\maven-2.0.1";
+ path %MAVEN_HOME%\bin)</li>
+ <li>Make sure that system variable JAVA_HOME is set to the location of your
+ JDK, eg. C:\Program Files\Java\jdk1.5.0_02</li>
+ <li>Run maven --version to verify that it is correctly installed.</li>
+</ol>
+
+<p>.</p>
<p align="center"><img alt="clip_image002 (15K)"
src="images/clip_image002.jpg" height="211" width="477"></p>
-<p> </p>
+<p> - Unix based OS (Linux etc)</p>
-<p>For Unix/Linux users the tar ball or the zip archive is the best option.
-Once the archive is downloaded expand it to a directory of choice and set the
-environment variable MAVEN_HOME and add MAVEN_HOME/bin to the path as well.
-More instructions for installing Maven in Unix based operating systems can be
+<p>The tar ball or the zip archive is the best option. Once the archive is
+downloaded expand it to a directory of choice and set the environment
+variable MAVEN_HOME and add MAVEN_HOME/bin to the path as well. More
+instructions for installing Maven in Unix based operating systems can be
found <a href="http://maven.apache.org/start/install.html">here </a>.</p>
-<p>Once maven is properly installed it's all that is needed to start building
-Axis2.</p>
+<p></p>
+
+<p>Once maven is properly installed you can start building Axis2.</p>
<h4><a name="_Toc96698085"></a>The Axis2 source distribution</h4>
@@ -77,7 +125,7 @@
<p>Once the command completes, the binaries (jar files in this case) can be
found at a newly created "target" directory.</p>
-<p><strong>Note For the first Maven build (if the maven repository is not
+<p><strong>Note: For the first Maven build (if the maven repository is not
built first) it will take a while since required jars need to be downloaded.
However this is a once only process and will not affect any successive
builds.</strong></p>
@@ -90,67 +138,83 @@
<p>Once this build step is complete, the binaries are ready to be
deployed.</p>
-<h3><a name="_Toc96698086"></a>Installing Axis2 in a Servlet container</h3>
-
-<p>Installation of the WAR is quite simple. It's a matter of dropping the war
-in the webapps folders and most servlet containers will automatically install
-the war. However some servlet containers may require a restart in order to
-capture the new web application. Please refer your servlet container
-documentation for more information about this.</p>
-
-<p>Once the WAR is successfully installed it can be tested by pointing the
-web browser to the <strong>http:// <host :port>/ axis2. </strong>It
-should produce the following page.</p>
-
-<p align="center"><strong><img src="images/clip_image006.jpg"></strong></p>
-
-<p>To ensure that everything is fine and smooth, a probing of the system can
-be done through the validate link. 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 align="center"><strong><img src="images/happyaxis.jpg"></strong></p>
-
-<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 userguide that jar file can be uploaded using the upload page.</p>
-
-<p align="center"><strong><img src="images/clip_image010.jpg"></strong></p>
+<p></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 instantly installed.</p>
-
-<p>Since Axis2 supports hot deployment one can drop the service jar directly
-through the file system to the above mentioned services directory and it will
-also cause the service to be automatically installed without the container
-being restarted.</p>
-
-<p>To check the successful installation of a service <strong><em>available
-services link </em></strong> is provided. The services and the operations of
-successfully installed services will be displayed in the available services
-page.</p>
-
-<p align="center"><strong><img src="images/clip_image012.jpg"></strong></p>
-
-<p>If the service has deployment time error it will listed out those services
-as faulty services. And If you click on the link it will show your the
-deployment fault</p>
-
-<p align="center"><strong><img src="images/faultservice.jpg"></strong></p>
-
-<p>Deployment time error message</p>
-
-<p align="center"><strong><img src="images/faultmsg.jpg"></strong></p>
-
-<p> </p>
-
-<p> </p>
-
-<p>Axis2 Administration is all about configuring Axis2 at the run time and
-the configuration will be transient , and more descriptions are available in
-<a href="webadminguide.html">Axis2 admin web guide</a></p>
+<h3><a name="_Toc96698086"></a>Installing Axis2 in a Servlet container</h3>
+<ol>
+ <li>Download 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.</li>
+
+ <p align="center"><strong><img src="images/clip_image006.jpg"></strong></p>
+
+ <p></p>
+ <li>Use validate link 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"></strong></p>
+</ol>
+
+<p></p>
+
+<h4> Uploading services</h4>
+<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 userguide that jar file can be uploaded using the upload
+ page.</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>
+
+ <p>Since Axis2 supports hot deployment 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 <em>available services link</em>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"><strong><img src="images/clip_image012.jpg"
+ alt=""></strong></p>
+
+ <p></p>
+
+ <p>If the service has deployment time error it will list out those services
+ as faulty services. If you click on the link it will show your deployment
+ fault.</p>
+
+ <p align="center"><strong><img src="images/faultservice.jpg"
+ alt=""></strong></p>
+
+ <p>Deployment time error message</p>
+
+ <p align="center"><strong><img src="images/faultmsg.jpg"
+ alt=""></strong></p>
+
+ <p> </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">Axis2 admin web guide</a></p>
+</ol>
</body>
</html>