blob: ac30083d6c27f0b1107174e73679cfb304a40289 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Apache Sandesha2/C - Installation Guide</title><style type="text/css" media="all">
@import url("../style/maven-base.css");
@import url("../style/maven-classic.css");</style><link rel="stylesheet" href="../style/print.css" type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta></head><body class="composite"><div id="banner"><a href="http://www.apache.org/" id="organizationLogo"><img alt="Apache Software Foundation" src="http://www.apache.org/images/asf-logo.gif"></img></a><a href="http://ws.apache.org/sandesha2/c" id="projectLogo"><img alt="Apache Sandesha2/C" src="http://ws.apache.org/sandesha2/c/images/sandesha2c_logo.jpg"></img></a><div class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xleft">
Last published: 05 October 2007
| Doc for 0.91</div><div class="xright"></div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuApache_Sandesha2_C"><h5>Apache Sandesha2/C</h5><ul><li class="none"><a href="../index.html">Apache Sandesha2/C Home</a></li><li class="expanded"><a href="../download.cgi">Download Sandesha2/C</a><ul><li class="none"><a href="../download.cgi">Releases</a></li></ul></li><li class="expanded"><a href="../docs/index.html">Documentation</a><ul><li class="none"><a href="../docs/installationguide.html">Installation Guide</a></li><li class="none"><a href="../docs/sandesha2c_manual.html">Sandesha2/C manual</a></li></ul></li><li class="expanded"><a href="../lists_issues.html">Get Involved</a><ul><li class="none"><a href="../lists_issues.html">Mailing Lists &amp; Issue Tracking</a></li><li class="none"><a href="../svn.html">Checkout Source Code</a></li></ul></li><li class="expanded"><a href="../coding_conventions.html">Developer Guidelines</a><ul><li class="none"><a href="../coding_conventions.html">Coding Convention</a></li><li class="none"><a href="../versioning.html">Versionning</a></li></ul></li><li class="expanded"><a href="../team-list.html">Project Information</a><ul><li class="none"><a href="../team-list.html">Project Team</a></li><li class="none"><a href="http://svn.apache.org/viewvc/webservices/sandesha/trunk/c/" class="externalLink" title="External Link">Source Code</a></li></ul></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="../images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><a name="Apache_Sandesha2_C_Installation_Guide"></a><h2>Apache Sandesha2/C Installation Guide</h2><p>This document guides you on how to install Sandesha2/C with Axis2/C, and
run the server and client samples on Linux and Microsoft Windows operating
systems.</p><p>This release comes in two forms, source and binary. This document covers
both forms.</p><p>Please send your feedback to the developer mailing list: <a href="mailto:c-dev@axis.apache.org">c-dev@axis.apache.org</a>
(Subscription details are available on the <a href="http://ws.apache.org/sandesha/sandesha2/c" class="externalLink" title="External Link">Sandesha2 site</a>.) Please
remember to prefix the subject with [Axis2].</p><div class="subsection"><a name="Contents"></a><h3>Contents</h3><ul>
<li><a href="#linux">Installing and Running on Linux</a>
<ul>
<li><a href="#linux_source">Using the Source Release</a></li>
<li><a href="#linux_binary">Using the Binary Release</a></li>
</ul>
</li>
<li><a href="#win">Installing and Running on Microsoft Windows (win32)</a>
<ul>
<li><a href="#win_source">Using the Source Release</a></li>
<li><a href="#win_binary">Using the Binary Release</a></li>
</ul>
</li>
</ul><p><a id="linux"></a></p></div><div class="subsection"><a name="1__Installing_and_Running_on_Linux"></a><h3>1. Installing and Running on Linux</h3><p>This can be done using binary or source distributions. (<a href="http://ws.apache.org/sandesha/sandesha2/c/download.cgi" class="externalLink" title="External Link">Download</a> the two
distributions)</p><p><a id="linux_source"></a></p></div><div class="subsection"><a name="1_1__Installing_Sandesha2_C_Source_Release_on_Linux"></a><h3>1.1. Installing Sandesha2/C Source Release on Linux</h3><p>This version of Sandesha2/C depends on Axis2/C 1.1.0 <a href="http://ws.apache.org/axis2/c/download.cgi" class="externalLink" title="External Link">Download Axis2/C</a> from and
install. </p><ol>
<li> Download Sandesha2 source distribution</li>
<li> Extract the source distribution and go to extracted directory</li>
<li> Run configure with AXIS2 include path.
<pre>./configure --prefix=&lt;axis2c_deploy_path&gt; --enable-static=no --with-axis2=&lt;axis2c_include_path&gt;</pre>
</li>
<li>Run make and make install</li>
</ol><p>
This will install the Sandesha2/C as a module in Axis2/C in &lt;axis2c_deploy_path&gt;/modules folder. The module
folder contains the Sandesha2/C libraries and the module.xml file.
<a id="linux_binary"></a></p></div><div class="subsection"><a name="1_2__Installing_Sandesha2_C_Binary_Release_on_Linux"></a><h3>1.2. Installing Sandesha2/C Binary Release on Linux</h3><p>Sandesha2/C binary distribution for Linux has the following folder structure. </p>
<div class="source"><pre>
Sandesha2
|
+ - modules/sandesha2 (sandesha2 module library and module.xml file)
+ - docs
+ - config (Contain sample module.xml and axis2.xml files)
|
+ - samples
|
+ - source files of samples in folders
+ - services (Contain sample service)
|
+ - include ( header files)
+ - bin (database scripts)
+ - bin/samples ( sample executables)
</pre></div>
<p>
To deploy Sandesha2/C in Axis2/C running environment copy the modules/sandesha2 into &lt;axis2c_deploy_path&gt;/modules folder.
Do the necessary changes to the &lt;axis2c_deploy_path&gt;/axis2.xml to run Sandesha2/C(Refer to the sample config/axis2.xml
for help).
</p><p><a id="win"></a></p></div><div class="subsection"><a name="2__Installing_and_Running_on_Microsoft_Windows"></a><h3>2. Installing and Running on Microsoft Windows</h3><p>This too can be done using binary or source distributions. (<a href="http://ws.apache.org/sandesha/sandesha2/c/download.cgi" class="externalLink" title="External Link">Download</a> the two
distributions.)</p><p><a id="win_source"></a></p></div><div class="subsection"><a name="2_1__Installing_Sandesha2_C_Source_Release_on_Windows"></a><h3>2.1. Installing Sandesha2/C Source Release on Windows</h3><ol>
<li> You need to have unziped Axis2/C 1.1.0 release binary to some folder.</li>
<li> Sandesha2/C can be used with one of following two database systems.
<ul>
<li>sqlite</li>
<li>MySQL</li>
</ul>
So install one of above database systems on your machine.
</li>
<li> On your cmd.exe cd to &lt;sandesha2 src&gt;\build\win32 <br></br>
Edit configure.in file with your binary locations. <br></br>
To select MySQL have your configure.in entry WITH_MYSQL = 1. <br></br>
To Select Sqlite have your configure.in entry WITH_SQLITE = 1.
</li>
<li> To set necessary environment variables on command line run vcvars32.bat file. </li>
<li> Run nmake dist command on command line. This will build the Sandesha2/C binary and samples to a directory sandesha2 in &lt;sandesha2 src&gt;\build\sandesha2. </li>
</ol><p><a id="bin_binaries"></a></p></div><div class="subsection"><a name="2__2__Installing_Sandesha2_C_Binary_Release_on_Windows"></a><h3>2. 2. Installing Sandesha2/C Binary Release on Windows</h3><p>Sandesha2/C binary distribution will have following directory structure. </p>
<div class="source"><pre>
Sandesha2
|
+ - Sandesha2 (sandesha2 module dll and module.xml file)
|
+ - samples
|
+ - bin
|
+ - source files of samples in folders
|
+ - include ( header files)
</pre></div>
<ol>
<li> Copy Sandesha2 directory ( containing sandesha2 dll and module.xml ) to &lt;AXIS2C_HOME&gt;\modules directory.</li>
<li> Copy RMSampleService directory in samples\bin directory to &lt;AXIS2C_HOME&gt;\services directory </li>
<li> Copy axis2.xml file in Sandesha2 directory to &lt;AXIS2C_HOME&gt; </li>
</ol><p>
Now you should be able to run the samples.
</p></div><div class="subsection"><a name="Notes"></a><h3>Notes</h3><ol>
<li>
Sandesha2/C has two main storage mechanisms call in-memory and persistent. The persistent storage could use
either sqlite or MySQL as it's database manager. <br></br>
By default sandesha2 use the persistent storage with sqlite as the database. <br></br>
It is assumed that sqlite3.h in /usr/include include directory. If you have different include path for
sqlite3.h then add the configure option --with-sqlite=&lt;sqlite include file path&gt; to the configure options
above. If is assumed that libsqlite3.so is in the /usr/lib folder <br></br>
To run samples in persistent/sqlite mode copy sandesha2c/config/sqlite_schema.sh/.bat to a directory where you
will create your sqlite database file and execute it to create the database schema. sqlite3 is an embedded
database which need no configuration. If you use Axis2/C Apache2 module instead of simple_axis2_server make
sure that Apache2 user can access the sqlite database files sandesha2_svr_db and sandesha2_client_db. <br></br>
if you want to use the in-memory storage instead, change the entry in the sandesha2_constants.h
file. <br></br>
<pre>#define SANDESHA2_DEFAULT_STORAGE_MGR "persistent"
as
#define SANDESHA2_DEFAULT_STORAGE_MGR "inmemory". </pre>
<p>Or you can change the following entry in the module.xml file.</p>
<p>
</p><p>&lt;parameter name="StorageManager" locked="false"&gt;inmemory&lt;parameter&gt;</p>
<p>&lt;parameter name="StorageManager" locked="false"&gt;persistent&lt;parameter&gt;</p>
<p>
If you want to use persistent storage with MySQL then add the option --with-mysql=&lt;MySQL include file path&gt;
to the configure options above. It is assumed that libmysqlclient.so is in /usr/lib folder. It is recommended
to use MySQL database for any serious use. It is not included as as the default database because of licensing issues.
To run samples in persistent/mysql mode run sandesha2c/config/mysql_schema.sh and sandesha2c/config/init_mysql.sh
to create the database schema. The database parameters for MySQL should be included in module.xml. The defaults for server, user and password are localhost, g,g.
</p>
</li>
<li>
Sandesha2/C module is installed into &lt;axis2c_deploy_path&gt;/modules/sandesha2c directory. The installed module contain
libsandesha2.so, module.xml. The sample clients are installed into &lt;axis2c_deploy_path&gt;/bin/samples
directory. Sample services are installed into &lt;axis2c_deploy_path&gt;/services directory.
</li>
</ol></div></div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 2005-2007, Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>