Apache Sandesha2/C Installation Guide

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.

This release comes in two forms, source and binary. This document covers both forms.

Please send your feedback to the developer mailing list: axis-c-dev@ws.apache.org (Subscription details are available on the Sandesha2 site.) Please remember to prefix the subject with [Axis2].

Contents

1. Installing and Running on Linux

This can be done using binary or source distributions. (Download the two distributions)

1.1. Installing Sandesha2/C Source Release on Linux

This version of Sandesha2/C depends on Axis2/C 1.3.0 Download Axis2/C from and install.

  1. Download Sandesha2 source distribution
  2. Extract the source distribution and go to extracted directory
  3. Run configure with AXIS2 include path. 
    ./configure --prefix=<axis2c_deploy_path> --enable-static=no --with-axis2=<axis2c_deploy_path>
  4. Run make and make install
This will install the Sandesha2/C as a module in Axis2/C in <axis2c_deploy_path>/modules folder. The module folder contains the Sandesha2/C libraries and the module.xml file. It will also install the libsandesha2_client.so into <axis2c_deploy_path>lib folder. Sandesha2 include files are copied into <axis2c_deploy_path>include folder.

To install the samples go into samples folder and do

./configure --prefix=<axis2c_deploy_path> --with-axis2=<axis2c_include_path>

make

make install

1.2. Installing Sandesha2/C Binary Release on Linux

Sandesha2/C binary distribution for Linux has the following folder structure.

   
    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/samples ( sample executables)
        + - lib (libsandesha2_client.so)

To deploy Sandesha2/C in Axis2/C running environment copy the modules/sandesha2 into <axis2c_deploy_path>/modules folder. Also copy the libsandesha2_client.so into <axis2c_deploy_path>/lib folder. Do the necessary changes to the <axis2c_deploy_path>/axis2.xml to run Sandesha2/C(Refer to the sample config/axis2.xml for help). To run samples copy the server sample services/RMSampleService into <axis2c_deploy_path>/services folder and start the server. Then you can run the client samples in bin/samples/sandesha2. To see the messages passing through the wire use a Tcp Monitor.

2. Installing and Running on Microsoft Windows

This too can be done using binary or source distributions. (Download the two distributions.)

2.1. Installing Sandesha2/C Source Release on Windows

  1. You need to have unzipped Axis2/C 1.3.0 release binary to some folder.
  2. On your cmd.exe cd to <sandesha2 src>\build\win32
    Edit configure.in file with your binary locations.
  3. To set necessary environment variables on command line run vcvars32.bat file.
  4. Run nmake dist command on command line. This will build the Sandesha2/C binary and samples to a directory sandesha2 in <sandesha2 src>\build\sandesha2.

2. 2. Installing Sandesha2/C Binary Release on Windows

Sandesha2/C binary distribution will have following directory structure.

    Sandesha2
        |
        + - Sandesha2 (sandesha2 module dll and module.xml file)
        |
        + - samples
               |
               + - bin 
               |
               + - source files of samples in folders
        |
        + - include ( header files)
        + - lib (sandesha2_client.dll)
  1. Copy Sandesha2 directory ( containing sandesha2 dll and module.xml ) to <AXIS2C_HOME>\modules directory.
  2. Copy RMSampleService directory in samples\bin directory to <AXIS2C_HOME>\services directory
  3. Copy axis2.xml file in Sandesha2 directory to <AXIS2C_HOME>

Now you should be able to run the samples.

Notes

  1. Sandesha2 internally uses an Sqlite3 embedded database. You need to provide where to create this database in

    module.xml file as following.

    <parameter name="sandesha2_db" locked="false"><path>/sandesha2_db</parameter>

    If you use Axis2/C Apache2 module instead of simple_axis2_server make sure that Apache2 user can access the above database file.

    If you do not provide the above database parameter, be aware that Sandesha2/C will create the database file named sandesha2_db in the current folder.

  2. Sandesha2/C module is installed into <axis2c_deploy_path>/modules/sandesha2c directory. The installed module contain libsandesha2.so, module.xml. The sample clients are installed into <axis2c_deploy_path>/bin/samples directory. Sample services are installed into <axis2c_deploy_path>/services directory.