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 ch...@apache.org on 2006/10/13 12:55:25 UTC
svn commit: r463645 - in /webservices/axis2/trunk/c/xdocs/docs:
architecture_notes.html installationguide.html
Author: chatra
Date: Fri Oct 13 03:55:24 2006
New Revision: 463645
URL: http://svn.apache.org/viewvc?view=rev&rev=463645
Log:
completed review
Modified:
webservices/axis2/trunk/c/xdocs/docs/architecture_notes.html
webservices/axis2/trunk/c/xdocs/docs/installationguide.html
Modified: webservices/axis2/trunk/c/xdocs/docs/architecture_notes.html
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/xdocs/docs/architecture_notes.html?view=diff&rev=463645&r1=463644&r2=463645
==============================================================================
--- webservices/axis2/trunk/c/xdocs/docs/architecture_notes.html (original)
+++ webservices/axis2/trunk/c/xdocs/docs/architecture_notes.html Fri Oct 13 03:55:24 2006
@@ -10,7 +10,7 @@
<title>Architecture_notes.html</title>
</head>
-<body>
+<body lang="en">
<h1>C Specific Architectural Notes on Axis2/C</h1>
<p>Send your feedback to: <a
@@ -32,10 +32,10 @@
<h2>Introduction</h2>
-<p>One of the main design goals of Axis2/C is the re-useability of the
-library and the ability to plug into different platforms. There are many
-features that allow Axis2/C to be pluggable in to different platforms as well
-as to enable the extension of the functionality of Axis2/C.</p>
+<p>One of the main design goals of Axis2/C is the re-usability of the library
+and the ability to plug into different platforms. There are many features
+that allow Axis2/C to be pluggable in to different platforms as well as to
+enable the extension of the functionality of Axis2/C.</p>
<a name="Axis2_Environment"></a>
<h2>Axis2 Environment</h2>
@@ -91,8 +91,8 @@
tree of Axis2 or separately. These modules should be compiled as Dynamic
Shared Objects (DSOs) that exist separately. Services are also loaded
dynamically by reading the contents of the services folder. This dynamic
-loading is mandatory in order to provide hot deployment / update as well as
-to facilitate the runtime selection of transports.</p>
+loading is mandatory in order to provide hot deployment/ update as well as to
+facilitate the runtime selection of transports.</p>
<p>The DSO support for loading individual Axis2 components is based on the
component named <code>class_loader</code>, which must be statically compiled
@@ -116,7 +116,8 @@
<code>axis2_transport_receiver.h</code>.</p>
<p>Currently Axis2/C supports HTTP transport. The transport receiver is a
-Simple HTTP server provided by Axis2 or the Axis2 Apache2 module. The
+Simple HTTP server provided by Axis2 or the Axis2 Apache2 (<a
+href="installationguide.html#installing-apache2">mod_axis2</a>) module. The
transport sender uses sockets to connect and send the SOAP Message.</p>
<p>Inside the HTTP transport, the receivers and clients are abstracted so
@@ -128,7 +129,7 @@
<h2>Stream Abstraction</h2>
<p>Stream is a representation of a sequence of bytes. Since Axis2 heavily
-uses streaming mechanisms to read / write xml, an implementation independent
+uses streaming mechanisms to read/write xml, an implementation independent
stream abstraction is required in order to integrate Axis2 in other
environments seamlessly. The core components of Axis2 deal with this
abstracted stream and does not worry about the implementation specific
@@ -145,7 +146,7 @@
<h2>Threading Model</h2>
-<p>Axis2 core functions, such as hot deployment / update, asynchronous
+<p>Axis2 core functions, such as hot deployment/update, asynchronous
invocation, concurrent request processing in simple axis2 server, etc
heavily depends on threads. At the same time these threads should be platform
independent inside the Axis2 core components. Another important requirement
Modified: webservices/axis2/trunk/c/xdocs/docs/installationguide.html
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/xdocs/docs/installationguide.html?view=diff&rev=463645&r1=463644&r2=463645
==============================================================================
--- webservices/axis2/trunk/c/xdocs/docs/installationguide.html (original)
+++ webservices/axis2/trunk/c/xdocs/docs/installationguide.html Fri Oct 13 03:55:24 2006
@@ -1,15 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
+<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<title>Axis2-C Installation Guide</title>
- <meta name="generator" content="amaya 9.51, see http://www.w3.org/Amaya/" />
+ <meta name="generator" content="amaya 9.2.1, see http://www.w3.org/Amaya/"
+ />
</head>
-<body xml:lang="en">
+<body>
<h1>Axis2/C Installation Guide</h1>
<p>This document will guide you on how to install Axis2/C and run the server
@@ -60,89 +61,81 @@
</ul>
</li>
</ul>
-
<a id="linux"></a>
-<h2>1. Installing and running on Linux</h2>
+
+<h2>1. Installing and Running on Linux</h2>
<p>This can be done using binary or source distributions</p>
<p>To get both the binary and source distributions working, you need libxml2,
-which can be downloaded from <a
-href="http://xmlsoft.org/downloads.html">here</a>.</p>
+which can be <a href="http://xmlsoft.org/downloads.html">downloaded</a>.</p>
-<p><b>NOTE:</b> Most Linux systems have libxml2 installed by default. On
+<p><b>Note :</b> Most Linux systems have libxml2 installed by default. On MS
Windows you need to download and install libxml2.</p>
+<a></a>
-<a id="linux_binary"></a>
-<h3>1.1. Using binary release</h3>
+<h3>1.1. Using Binary Release</h3>
<p>The following steps need to be taken to install and run Axis2/C using
binary distribution on Linux</p>
<ol>
-<li>Extract the binary tar package to a folder.</li>
-<li>Set AXIS2C_HOME environment variable pointing to the location where you
- have extracted Axis2C</li>
-<ul>
- <li>AXIS2C_HOME='/your_path_to_axis2c'</li>
- <li>export AXIS2C_HOME</li>
- <br />
-
- <li><strong>NOTE:</strong> You will need to set AXIS2C_HOME only if you
- need to run Axis2C samples or tests. The reason is that the samples and
- test codes use AXIS2C_HOME to get the path to Axis2C. To write your own
- services or clients this is not a requirement.</li>
-</ul>
-
-<li>Run the simple axis server:</li>
-<ul>
- <li>To start the simple axis server on default port 9090, run the following
- commands.
- <ul>
- <li>cd /your_path_to_axis2c/bin</li>
- <li>./axis2_http_server</li>
- </ul>
- </li>
- <li>To see the possible command line options run ./axis2_http_server -h</li>
- <br />
-
- <li><strong>NOTE:</strong> If you run into shared lib problems, try setting
- the LD_LIBRARY_PATH
- <ul>
- <li>export
- LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/your_path_to_axis2c/lib</li>
- </ul>
- </li>
-</ul>
-
-<li>Run the sample clients in a new shell</li>
-<ul>
- <li>cd /your_path_to_axis2c/bin/samples</li>
- <li>to run client for echo service
+ <li>Extract the binary tar package to a folder.</li>
+ <li>Set AXIS2C_HOME environment variable pointing to the location where you
+ have extracted Axis2C
<ul>
- <li>./echo</li>
+ <li>AXIS2C_HOME='/your_path_to_axis2c'</li>
+ <li>export AXIS2C_HOME</li>
+ <p><strong>Note :</strong> You will need to set AXIS2C_HOME only if you
+ need to run Axis2C samples or tests. The reason is that the samples and
+ test codes use AXIS2C_HOME to get the path to Axis2C. To write your own
+ services or clients this is not a requirement.</p>
</ul>
</li>
- <li>to run client for math service
+ <li>Run the simple axis server:
<ul>
- <li>./math</li>
+ <li>To start the simple axis server on default port 9090, run the
+ following commands.
+ <ul>
+ <li>cd /your_path_to_axis2c/bin</li>
+ <li>./axis2_http_server</li>
+ </ul>
+ </li>
+ <li>To see the possible command line options run ./axis2_http_server -h
+ <p><strong>Note :</strong> If you run into shared lib problems, try
+ setting the LD_LIBRARY_PATH</p>
+ <ul>
+ <li>export
+ LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/your_path_to_axis2c/lib</li>
+ </ul>
+ </li>
</ul>
</li>
- <li>To see the possible command line options for sample clients run them
- with '-h' option</li>
- <br />
-
- <li><strong>NOTE:</strong> If you run into shared lib problems, try setting
- the LD_LIBRARY_PATH
+ <li>Run the sample clients in a new shell
<ul>
- <li>export
- LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/your_path_to_axis2c/lib</li>
+ <li>cd /your_path_to_axis2c/bin/samples</li>
+ <li>To run client for echo service
+ <ul>
+ <li>./echo</li>
+ </ul>
+ </li>
+ <li>To run client for math service
+ <ul>
+ <li>./math</li>
+ </ul>
+ </li>
+ <li>To see the possible command line options for sample clients run
+ them with '-h' option</li>
+ <p><strong>Note :</strong> If you run into shared lib problems, try
+ setting the LD_LIBRARY_PATH</p>
+ <ul>
+ <li>export
+ LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/your_path_to_axis2c/lib</li>
+ </ul>
</ul>
</li>
-</ul>
</ol>
-<ai id="linux_source"></a>
-
-<h3>2. Using source release</h3>
+<ai id=linux_source>
+<h3>1. 2. Using Source Release</h3>
<p>The following steps need to be taken to install and run Axis2/C using
source distribution on Linux</p>
@@ -152,13 +145,15 @@
want to install Axis2C.
<ul>
<li>AXIS2C_HOME='/your_desired_path_to_axis2c_installation'</li>
- <li>export AXIS2C_HOME</li>
- <br />
-
- <li><strong>NOTE:</strong> You will need to set AXIS2C_HOME only if you
- need to run Axis2C samples or tests. The reason is that the samples
- and test codes use AXIS2C_HOME to get the path to Axis2C. To write
- your own services or clients this is not a requirement.</li>
+ <li>export AXIS2C_HOME
+ <ul>
+ <li><strong>Note :</strong> You will need to set AXIS2C_HOME only
+ if you need to run Axis2C samples or tests. The reason is that
+ the samples and test codes use AXIS2C_HOME to get the path to
+ Axis2C. To write your own services or clients this is not a
+ requirement.</li>
+ </ul>
+ </li>
</ul>
</li>
<li>Then go to the folder where you extracted the source
@@ -176,12 +171,12 @@
<li>make install</li>
</ul>
</li>
- <li>use './configure --help' for possible command line options.</li>
- <li><strong>NOTE:</strong> If you don't provide a --prefix configure
- option, it will by defaul be installed into /usr/local/axis2c
+ <li>Use './configure --help' for possible command line options.</li>
+ <li><strong>Note :</strong>If you don't provide a --prefix configure
+ option, it will by default be installed into /usr/local/axis2c
directory.</li>
- <li>You may need to try axis2c with guththila xml parser. You can do it
- by giving --enable-guththila=yes
+ <li>You may need to try Axis2/C with Guththila XML parser. You can do
+ it by giving --enable-guththila=yes
<ul>
<li>./configure --enable-guththila=yes [other configuration
options]</li>
@@ -189,7 +184,7 @@
<li>make install</li>
</ul>
</li>
- <li>In order to build rampart (axis2c security module)
+ <li>In order to build Rampart (Axis2/C security module)
<ul>
<li>./configure --enable-rampart=yes [other configuration
options]</li>
@@ -198,27 +193,27 @@
</ul>
</li>
<li>If you need to get the samples working, you also need to build the
- samples.
- <br />To build the samples:
+ samples. <br />
+ To build the samples:
<ul>
<li>export
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/axis2c/lib/</li>
<li>cd samples</li>
- <li>./configure --prefix=${AXIS2C_HOME}</li>
- <li>--with-axis2_util=${AXIS2C_HOME}/include</li>
- <li>--with-axiom=${AXIS2C_HOME}/include</li>
+ <li>./configure --prefix=${AXIS2C_HOME}
+ --with-axis2_util=${AXIS2C_HOME}/include
+ --with-axiom=${AXIS2C_HOME}/include</li>
<li>make</li>
<li>sudo make install</li>
</ul>
</li>
<li>Please run "./configure --help" in samples folder for more
information on configure options.</li>
- <li><strong>NOTE:</strong> If you don't provide a --prefix configure
+ <li><strong>Note :</strong> If you don't provide a --prefix configure
option, samples will by default be installed into
"/usr/local/axis2c/samples" directory.</li>
</ul>
</li>
- <li>Go to where you installed axis2c.</li>
+ <li>Go to where you installed Axis2/C.</li>
<li>Start simple axis server
<ul>
<li>To start the simple axis server on port 9090 run the following
@@ -230,7 +225,7 @@
</li>
<li>To see the possible command line options run ./axis2_http_server
-h</li>
- <li> <strong>NOTE:</strong> You may need to be login as superuser to
+ <li><strong>Note :</strong> You may need to be login as superuser to
run the simple axis server.</li>
</ul>
</li>
@@ -252,30 +247,30 @@
</ul>
</li>
</ol>
-
<a id="win"></a>
-<h2>Installing and running on Microsoft Windows (win32)</h2>
-<p>This too can be done using either binary or source distributions</p>
+<h2>2. Installing and Running on Microsoft Windows (win32)</h2>
+
+<p>This too can be done using either binary or source distributions.</p>
-<p>For both the binary and source distributions, you need libxml2 from <a
-href="http://xmlsoft.org/downloads.html">here</a>.</p>
+<p>For both the binary and source distributions, you need to <a
+href="http://xmlsoft.org/downloads.html">download</a> libxml2.</p>
<p>(NOTE: most Linux systems has libxml2 by default. On Windows you need to
download and install libxml2)</p>
<a id="win_binary"></a>
-<h3>1. Using binary release</h3>
+<h3>2. 1. Using Binary Release</h3>
<a id="bin_req"></a>
-<h4>Requirements</h4>
+<h4>2.1.1. Requirements</h4>
<ul>
<li>The binaries shipped with this version is compiled with Microsoft
- visual studio compiler (cl)</li>
+ Visual Studio Compiler (cl)</li>
<p>(Note: you can download Microsoft VSExpress2005 edition from Microsoft
- web site and install it to run these binaries)</p>
- <li>You also need the following dlls
+ Web site and install it to run these binaries)</p>
+ <li>You also need the following dlls:
<ul>
<li>libxml2.dll [http://www.xmlsoft.org - download the version >=
libxml2-2.6.20.win32]</li>
@@ -288,7 +283,7 @@
</ul>
<a id="bin_binaries"></a>
-<h4>Binaries in the release</h4>
+<h4>2.1.2. Binaries in The Release</h4>
<ul>
<li>Extract the binary distribution to a folder of your choice. (example:
C:\axis2c)</li>
@@ -312,12 +307,12 @@
</ul>
<a id="bin_run"></a>
-<h4>Running the binaries</h4>
+<h4>2.1.3. Running The Binaries</h4>
<ul>
<li>First you need to set couple of environment variables before you can
run the server and samples.
<ul>
- <li>Set the varibale AXIS2C_HOME to the deploy folder (C:\axis2c)</li>
+ <li>Set the variabale AXIS2C_HOME to the deploy folder (C:\axis2c)</li>
<li>Add the path to lib directory to PATH variable
(%AXIS2C_HOME%\lib)</li>
</ul>
@@ -339,16 +334,16 @@
</ul>
<a id="win_source"></a>
-<h3>2. Using the source release.</h3>
+<h3>2. 2. Using The Source Release</h3>
<a id="src_req"></a>
-<h4>Requirements</h4>
+<h4>2.2.1. Requirements</h4>
<ul>
- <li>The makefile shipped with this version needs Microsoft visual studio
- compiler (cl) and nmake build tool</li>
+ <li>The makefile shipped with this version needs Microsoft Visual Studio
+ Compiler (cl) and nmake build tool</li>
<p>(Note: you can download Microsoft VSExpress2005 edition and Platform SDK
- from Microsoft web site. You will need to add the path to Platform SDK
+ from Microsoft Web site. You will need to add the path to Platform SDK
Include and Lib folders to makefile)</p>
<li>You also need
<ul>
@@ -363,15 +358,15 @@
</ul>
<a id="edit"></a>
-<h4>Editing configure.in file</h4>
+<h4>2.2.3. Editing configure.in File</h4>
<ul>
- <li>The default paths for libxml2 and iconv are speceficed in configure.in.
+ <li>The default paths for libxml2 and iconv are specified in configure.in
<ul>
<li>Example:Default location for libxml2 is C:\libxml2</li>
</ul>
</li>
<li>You can either extract libxml2 to this folder, in which case folder
- structure for C:\libxml2 should look like the following.</li>
+ structure for C:\libxml2 should look like the following:</li>
<p><img alt="Figure: C:\libxml2 Folder Structure"
src="images/folder_structure_libxml2.jpg" /></p>
@@ -383,7 +378,7 @@
</ul>
<a id="src_compile"></a>
-<h4>Compiling the source.</h4>
+<h4>2.2.4. Compiling The Source</h4>
<p>The following steps will take you through the source compilation</p>
<ul>
@@ -422,7 +417,7 @@
</ul>
<a id="src_run"></a>
-<h4>Running the binaries</h4>
+<h4>2.2.5. Running The Binaries</h4>
<ul>
<li>You need to set couple of environment variables before you can run the
server and samples.
@@ -453,44 +448,52 @@
</ul>
<a id="installing-apache2"></a>
-<h3>3. Installing Apache2 Web Server integration module (mod_axis2).</h3>
+<h3>3. Installing Apache2 Web Server Integration Module (mod_axis2).</h3>
<a id="building-apache2"></a>
-<h4>3.1 Building mod_axis2 from source tree</h4>
-<h4>3.1.1 On Linux Platform</h4>
+<h4>3.1. Building mod_axis2 From Source Tree</h4>
+
+<h4>3.1.1 On Linux Platform:</h4>
<ul>
<li>Provide the apache2 include files location as configure option
./configure --with-apache2="<apache2 include files location>"
[other configure options] - Some apache2 distributions install APR
- (Apache Portable Runtime) include files in a seperate location which is
- requred to build mod_axis2. In that case use
- <p>./configure --with-apache2="<apache2 include files location>"
- --with-apr="<apr include files location>" [other configure
- options]</p>
- </li>
- <li>Then build the source tree<br />
- make<br />
- make install<br />
- - This will install mod_axis2.so into your
- "<your_path_to_axis2c>/lib"</li>
+ (Apache Portable Runtime) include files in a separate location which is
+ required to build mod_axis2. In that case use
+ <ul>
+ <li>./configure --with-apache2="<apache2 include files location>"
+ --with-apr="<apr include files location>" [other configure
+ options]</li>
+ </ul>
+ </li>
+ <li>Then build the source tree
+ <ul>
+ <li>make</li>
+ <li>make install</li>
+ <p>This will install mod_axis2.so into your
+ "<your_path_to_axis2c>/lib"</p>
+ </ul>
+ </li>
</ul>
-<h4>3.1.2 On Win32 platform</h4>
+<h4>3.1.2 On Win32 Platform:</h4>
<ul>
<li>Provide the apache2 location in configure.in file in
APACHE_INSTALL_DIR<br />
eg : APACHE_INSTALL_DIR = E:\Apache</li>
- <li>After compiling the sources (as described in section 2) build the
- mod_axis2.dll by issuing the command "nmake axis2_apache_module".</li>
+ <li>After compiling the sources (As described in <a
+ href="#win">Section 2</a>) build the mod_axis2.dll by issuing the
+ command "nmake axis2_apache_module".</li>
<li>This will build the mod_axis2.dll and copy it to %AXIS2C_HOME%\lib
directory.<br />
eg: C:\axis2c\build\deploy\lib</li>
</ul>
<a id="deploying-apache2"></a>
-<h4>3.2 Deploying in Apache2 Web Server</h4>
-<p><b>Note: To do the following tasks you might need super user privileges in
-your machine.</b></p>
+<h4>3.2. Deploying in Apache2 Web Server</h4>
+
+<p><b>Note:</b> To do the following tasks you might need super user
+privileges in your machine.</p>
<ul>
<li>Copy the mod_axis2 (libmod_axis2.so.0.0.0 on Linux and mod_axis2.dll in
Windows) to "<apache2 modules directory>" (eg:
@@ -511,8 +514,8 @@
Axis2LogLevel LOG_LEVEL
</Location>
</pre>
- <p>LOG_LEVEL can be one of following <br />
- AXIS2_LOG_LEVEL_CRITICAL - Log critical errors only <br />
+ <p>LOG_LEVEL can be one of following</p>
+ <p>AXIS2_LOG_LEVEL_CRITICAL - Log critical errors only <br />
AXIS2_LOG_LEVEL_ERROR - Log errors critical errors <br />
AXIS2_LOG_LEVEL_WARNING - Log warnings and above <br />
AXIS2_LOG_LEVEL_INFO - Log info and above <br />
@@ -524,8 +527,12 @@
path></li>
<li>Make sure that the apache2 user has correct permissions to above
paths<br />
- - Read permission to the repository<br />
- - Write permission to the log file</li>
+
+ <ul>
+ <li>Read permission to the repository</li>
+ <li>Write permission to the log file</li>
+ </ul>
+ </li>
<li>Restart apache2 and test whether mod_axis2 module is loaded by typing
the URL http://localhost/axis2/services</li>
</ul>
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org