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 result
5. Installation Instructions
   1. Installing OpenCCM
   2. Installation result

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).

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.5.tar.gz

  2. Untar the archive file:

     $ tar xvf OpenCCM-0.5.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.5

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;
   OpenCCM.root.dir	The root directory where the OpenCCM platform package is installed;
   install.dir	The directory where the OpenCCM platform will be installed;
   ORB.home.dir	The directory where the used ORB is installed;
   cpp.compiler	The path to an installed C/C++ preprocessor;
   	on Unix, use /usr/bin/cpp or set to the Unix C/C++ preprocessor path on Windows, uncomment these two lines corresponding to the MinGW(1.0.1-20010726) C/C++ preprocessor:     cpp.compiler=${OpenCCM.root.dir}/externals/cpp/cpp.exe     cpp.compiler.add=${OpenCCM.root.dir}/externals/cpp/cpp0.exe
   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.

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 Result

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: