Table of Contents

1. Availability
   1. Requirements
   2. Extra requirements
   3. Currently supported ORBs
   4. Currently fully supported configurations
2. Distribution
   1. Extracting the contents of the OpenCCM archive
   2. The contents of the OpenCCM archive
3. Configuration instructions
4. Compilation instructions
   1. Compiling OpenCCM
   2. Generating OpenCCM documentation
   3. Compilation results
5. Installation instructions
   1. Installing OpenCCM
   2. Installation result
6. Installation instructions for PDA under Windows CE
   1. Requirements
   2. OpenCCM distribution architecture for PDA
   3. Installing OpenCCM on a PDA
   4. Running an OpenCCM server on your device

Availability

Requirements

To work correctly, OpenCCM has the following mandatory requirements:

• A full Java CORBA 2.4 ORB product, and
• A Java Development Kit.

Extra requirements

You may have to provide the following requirements:

• If you want to regenerate the OpenCCM IDL/PSDL/CIDL parser, you need to install the JavaCC tool, but this is not a mandatory requirement.
• If you want to generate the detailed OpenCCM APIs, you need to have the doxygen tool.
• If you are using the OpenORB product and if you want to use the OpenCCM's transactions facilities, you need to have OpenORB OTS libraries according to your OpenORB version number.
• If you want to use IDLscript deployment scripts for OpenCCM demonstrations, you need to have an IDLscript interpreter (you can have a look to CorbaScript or Java IDLscript).
• If you want to use the Persistent State Service (for PSS demonstration), you need to have a JDO implementation. At this time only Kodo JDO is supported. Speedo will be supported as soon as possible.

Currently supported ORBs

Currently fully supported configurations

Distribution

Extracting the contents of the OpenCCM archive

• On a Unix like system:

  Execute the following commands in a shell window to extract the contents of the OpenCCM archive:

  1. Uncompress the archive file:

     $ gunzip OpenCCM-0.7.tar.gz

  2. Untar the archive file:

     $ tar xvf OpenCCM-0.7.tar

• On a Microsoft Windows system, you can use a tool such as WinZip to extract the contents of the OpenCCM archive.

WinZip is a registered trademark of WinZip Computing, Inc.

The contents of the OpenCCM archive

The OpenCCM archive contains the following directories and files:

Configuration instructions

To configure and compile OpenCCM, you must have already installed an OpenCCM supported ORB product.

Then configuring OpenCCM requires:

1. To check if the JAVA_HOME shell variable is correctly set to the JDK you will use.

2. To go into the OpenCCM root directory, just do (on Unix or Windows systems):

   $ cd OpenCCM-0.7/openccm

3. To start the Ant tool a first time, just do on Unix systems:

   $ build.sh

   or on Windows systems:

   $ build.bat

   As result, the build.properties file is generated in the OpenCCM root directory.

4. To edit the generated build.properties file and set the following variables:

   Variable name	Description
   ORB.name	The name of your favorite ORB product.
   install.dir	The directory where the OpenCCM platform will be installed.
   ORB.home.dir	The directory where the used ORB is installed.
   NS.home.dir	The directory where the used Name Service is installed.
   OTS.home.dir	The directory where the used Transaction Service is installed.
   cpp.compiler	The path to an installed C/C++ preprocessor. If not set, then OpenCCM compilers will use a Java-based preprocessor by default.
   javacc.dir	The directory where JavaCC.zip is installed. Only required for compiling the OpenCCM's OMG IDL / PSDL / CIDL Parser.jj file and/or for generating the parser documentation.
   JDO.impl.name	The name of your favorite ORB product. Only required for compiling and running PSS demonstration.
   JDO.impl.version	The version of your favorite ORB product. Only required for compiling and running PSS demonstration.
   JDO.impl.prop.dir	The directory where your jdo property file is stored (e.g. kodo.properties). Only required for compiling and running PSS demonstration.
   JDO.impl.home.dir	The directory where the used JDO implementation is installed. Only required for compiling and running PSS demonstration.
   JDBC.driver.jar	The full path to the JDBC driver jar file used to access your DataBase. Only required for compiling and running PSS demonstration.

Compilation instructions

Compiling OpenCCM

After configurating OpenCCM, just do on Unix systems:

$ build.sh

or on Windows systems:

$ build.bat

Generating OpenCCM documentation

To generate OpenCCM APIs documentation you must have already installed the Doxygen tool. Then, just do:

$ build.sh doc

or

$ build.bat doc

Compilation results

After compilation, a directory is created according to the name of the used ORB product. It contains the following directories and files:

Installation instructions

Installing OpenCCM

Execute the following command to install OpenCCM:

$ build.sh install

or

$ build.bat install

Installation results

After installation, the following directories and files are created in the configured install.dir directory:

Installation instructions for PDA under Windows CE

Requirements

As for any other environment, the OpenCCM distribution for PDA needs an installed JVM and ORB to work correctly. In the following distribution, the OpenCCM command scripts are written for ORBacus-4.1 and the IBM J9 Java Virtual Machine for Pocket PC. However you can use any of supported ORBs or JVM for your device by easily adapting these scripts.

Moreover to run the following provided scripts, you need to install PocketConsole v1.3 on your PDA.

OpenCCM distribution architecture for PDA

The OpenCCM distribution architecture for PDA is the following:

Installing OpenCCM on a PDA

Create a directory called OpenCCM on your PDA root directory (usually named My Pocket PC/).

Copy the content of the src/PDA/ directory (that contains the build/ directory) in the OpenCCM/ you just created.

Running an OpenCCM server on your device

To run an OpenCCM server, edit the following scripts:

• jcs_start[n].bat:
  Replace the corbaloc::[your_host]:[number_port]/NameService by the corresponding values (the host and the port where the Naming Service is started) and start this script.
• ci_start.bat and activator_start.bat:
  Replace [my_pda] by the name of your device and start the ccm_server command.