You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by ch...@apache.org on 2005/06/07 07:35:19 UTC
svn commit: r188699 - in /webservices/axis/trunk/java/xdocs:
installationguide.htm installationguide.html navigation.xml
webadminguide.htm webadminguide.html
Author: chinthaka
Date: Mon Jun 6 22:35:16 2005
New Revision: 188699
URL: http://svn.apache.org/viewcvs?rev=188699&view=rev
Log:
Renaming htm files to html
Added:
webservices/axis/trunk/java/xdocs/installationguide.html
webservices/axis/trunk/java/xdocs/webadminguide.html
Removed:
webservices/axis/trunk/java/xdocs/installationguide.htm
webservices/axis/trunk/java/xdocs/webadminguide.htm
Modified:
webservices/axis/trunk/java/xdocs/navigation.xml
Added: webservices/axis/trunk/java/xdocs/installationguide.html
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/xdocs/installationguide.html?rev=188699&view=auto
==============================================================================
--- webservices/axis/trunk/java/xdocs/installationguide.html (added)
+++ webservices/axis/trunk/java/xdocs/installationguide.html Mon Jun 6 22:35:16 2005
@@ -0,0 +1,121 @@
+<html>
+<head>
+<title>Axis2 Installation Guide</title>
+</head>
+<body>
+<h3><a name="_Toc96698081"></a>Introduction </h3>
+<p>Axis 2.0 can be downloaded as a <a href="releases.html">zipped binary </a> or the <a href="cvs-usage.html">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. Axis 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 Axis 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 Axis from source. If you have the binary
+distribution you can skip the build sections and directly go to the
+binary installation section. </p>
+<h3><a name="_Toc96698083"></a>Building Axis2 from source </h3>
+<h4><a name="_Toc96698084"></a>Setting up the Environment and the tools </h4>
+<p>The Axis2 build is based on <a href="http://maven.apache.org/">Maven </a>.
+Hence the prerequisite to build Axis2 from source 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>
+<p align="center">
+<img alt="clip_image002 (15K)" src="images/clip_image002.jpg" height="211" width="477"/>
+<p> </p>
+<p>
+For Linux users the tar ball or the zip archive is the best
+options. (Unfortunately there is no rpm as such that can be easily
+installed) 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>
+<h4><a name="_Toc96698085"></a>The Axis source distribution </h4>
+<p>The <a href="releases.html">source distribution </a> is available as
+a zipped archive or a tar ball. 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 typing maven will build the axis jar file. </p>
+
+<p align="center"><img alt="clip_image004 (43K)" src="images/maven.jpg" height="338" width="669" /></p>
+<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 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>
+<p><strong> </strong>The default maven build will however build only
+the Axis2 jar file. To obtain a WAR (Web Archive), maven war command
+should be issued. This will create a complete WAR with the name
+axis2.war inside the target directory. </p>
+<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 axis libraries are present.
+</p>
+<p align="center"><strong><img src="images/happyaxis.jpg"></strong></p>
+<p>
+The axis 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>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 avilable in
+axis2 admin web module guide</p>
+</body>
+</html>
Modified: webservices/axis/trunk/java/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/xdocs/navigation.xml?rev=188699&r1=188698&r2=188699&view=diff
==============================================================================
--- webservices/axis/trunk/java/xdocs/navigation.xml (original)
+++ webservices/axis/trunk/java/xdocs/navigation.xml Mon Jun 6 22:35:16 2005
@@ -20,8 +20,8 @@
<item name="Wiki" href="http://wiki.apache.org/ws/FrontPage/Axis2"/>
<item name="Architecture Guide" href="Axis2ArchitectureGuide.html" />
<item name="User Guide" href="userguide.html" />
- <item name="Installation Guide" href="installationguide.htm" />
- <item name="Web Administration Guide" href="webadminguide.htm" />
+ <item name="Installation Guide" href="installationguide.html" />
+ <item name="Web Administration Guide" href="webadminguide.html" />
<item name="AXIOM Tutorial" href="OMTutorial.html" />
<item name="Code Generation Tutorial" href="CodegenToolReference.html" />
<item name="M1 Documents" href="m1.html" />
Added: webservices/axis/trunk/java/xdocs/webadminguide.html
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/xdocs/webadminguide.html?rev=188699&view=auto
==============================================================================
--- webservices/axis/trunk/java/xdocs/webadminguide.html (added)
+++ webservices/axis/trunk/java/xdocs/webadminguide.html Mon Jun 6 22:35:16 2005
@@ -0,0 +1,83 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+
+<html>
+<head>
+<title>Axis2 administartion guide</title>
+</head>
+<body>
+<p><h3><a name="_Toc96698076"></a>Introduction </h3>
+<p>Axis2 web administration module provide a way to configure axis2 dynamically
+ but those dynamic configuration wont be persistence, i.e. if the servlet
+ container restart then all the dynamic configuration changes will be lost. </p>
+
+ <p><h4><a name="_Toc96698076"></a>Loging into Administartion </h4>
+<p>From axis2 index page you can go to administration page by following
+Axis2 Administration link, then logging page will be appeared asking user
+name and password , the default username = admin and default password = axis2 .
+ You can change those two values by changing following two parameters in
+ server.xml as you required.
+<p align="left"><strong><img src="images/parameters.jpg"></strong></p>
+<p align="left"><strong><img src="images/adminloging.jpg"></strong></p>
+</p>
+<p>If the login succeed you will be see a page like below , where you can use
+that to
+ view the running system and dynamically configure the system. </p>
+ <p align="left"><strong><img src="images/adminmain.jpg"></strong></p>
+
+ <p>The list service in axis2 index page and here are almost the same but only
+ additional feature provide with admin module list service is, if there is any
+ module engaged globally, to the service or to the operation those details
+ will be displayed here. </p>
+
+ <p>To view the available modules in the "repository/modules" you just have
+ to click the view modules then it will show you all the available modules
+ in the system and only those modules can be dynamically engaged. </p>
+
+ <p align="left"><strong><img src="images/modules.jpg"></strong></p>
+ <p> </p>
+ <p>From the globally engaged modules you can see the globally engaged
+ modules if there is any , if a modules has engaged globally then the
+ handlers belong to that module will be executed irrespective of the service.
+ </p>
+ <p> </p>
+ <p>In axis2 there are two levels of phases, system predefined phases
+ (not allowed to change) and user defined phases. The main difference
+ between those two levels of phases is irrespective of the service all
+ the system pre defined phases will be executed, if the dispatcher find
+ the corresponding operation then user defined phase list will be executed.
+ And for the module developers and service writers are really required to
+ have understanding about phases and their orders. </p>
+ <p align="left"><strong><img src="images/viewphases.jpg"></strong></p>
+ <p> </p>
+ <p>The most interesting of axis2 web admin module is it provide a very basic
+ way of viewing the global phase list and handler inside the phases considering
+ both phase and handler orders. This kind of information is very valuable to
+ debug the system, because there is no way to list out the handlers in the
+ global chains except this. And if you engage a new module the new handlers
+ will be added to the global chains and those will be displayed in this view
+ phase page. </p>
+
+ <p align="left"><strong><img src="images/globalchain.jpg"></strong></p>
+ <p> </p>
+ <p>From the View Service phase and Handlers can view the handlers corresponding
+ to a given service in the same order as there in the real execution chain. </p>
+
+ <p align="left"><strong><img src="images/serviceHandlers.jpg"></strong></p>
+ <p> </p>
+
+
+<p>Modules can be engage either globally, to a service or to an operation
+depending on the module implementation. If the module has implemented to
+engage globally then handlers in the module can be refers to any phase in
+the system, that is it can be either system predefined or user defined phase.</P>
+<p>In there other hand if the module has implemented in such a way that is going
+ to be deployed to a service or to an operation then the module can NOT refers
+ to any of system predefined phases. So that it can only refers to user defined phases. </p>
+<p>Immediately after engaging the module you can see the status of the engagement
+, whether it is engaged properly or not. </p>
+
+<p align="left"><strong><img src="images/moduleengage.jpg"></strong></p>
+ <p> </p>
+
+</body>
+</html>