Table of Contents

1. Availability
   1. Requirements
   2. Extra Requirements
   3. Supported CORBA Products
   4. 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 Results
6. Installation Instructions for Windows CE / Linux PDA
   1. Requirements
   2. Fully Supported Configurations
   3. OpenCCM distribution architecture for PDA
   4. Installation, Compilation and Configuration Instructions
   5. Deinstalling OpenCCM for PDA
7. Installation Instructions for the Packaging/Assembling Tool
   1. Requirements
   2. Build Instructions
   3. Setting The Environment

Availability

Requirements

To work correctly, OpenCCM has the following mandatory requirements:

• A Java Development Kit, and
• A full Java CORBA 2.4 compliant product, see currently supported CORBA products.

Extra Requirements

You may have to provide the following extra requirements:

• If you want to generate the detailed OpenCCM APIs, you need to have the doxygen tool (http://www.doxygen.org).
• If you are using the OpenORB product and if you want to use the OpenCCM 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 (http://corbaweb.lifl.fr/CorbaScript) or Java IDLscript (http://www.lifl.fr/~roos/jidlscript).
• If you want to use the OpenCCM Persistent State Service (for PSS demonstrations), you need to have a Java Data Objects (JDO) implementation.
  At this time, only the Kodo JDO product (http://www.solarmetric.com) is supported.
  The ObjectWeb Speedo project (http://speedo.objectweb.org) will be supported as soon as possible.
• If you are an Apple MacOS X user and did not install a Java Development Kit, the provided Java Framework from MacOS X updates should be sufficient. Make sure to have the latest JavaVM update.

Supported CORBA Products

Currently, OpenCCM is supported on the following CORBA products:

If you want to use the CosTrading Service (mainly for deployment purpose), you need to have a CosTrading Service implementation. The table below shows currently fully supported configuration of CosTrading Services.

Warning: For The Community OpenORB 1.4.0-BETA1, it is required to download at least all the following packages and uncompress them in a same directory.

Fully Supported Configurations

Currently, OpenCCM was successfully tested on the following configurations:

Thank you to report to the OpenCCM community mailing list any other configurations where you have successfully tested OpenCCM.

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

  2. Untar the archive file:

     $ tar xvf OpenCCM-0.8.1.tar

• On a Microsoft Windows system, you can use a tool such as WinZip to extract the contents of the OpenCCM archive.
• On an Apple MaxOS X system, you can use your favorite tool 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 a CORBA product supported by OpenCCM.

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.8.1/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	Description	Mandatory
   ORB.name	The name of the ORB product used to compile and execute OpenCCM. Select one ORB name in the proposed list.	Yes
   install.dir	The directory where the OpenCCM platform will be installed. Default value is the local build directory.	No
   ORB.home.dir	The directory where the used ORB product is installed.	Yes
   NS.home.dir	The directory where the used CosNaming Service is installed. Default value is ORB.home.dir. Must be set when the used CosNaming Service is installed in a directory different that the ORB one.	No
   trader.home.dir	The directory where the used CosTrading Service is installed. Default value is ORB.home.dir. Must be set when the used CosTrading Service is installed in a directory different that the ORB one.	No
   OTS.home.dir	The directory where the used CosTransaction Service is installed. If not set then OpenCCM will not be able to use the CosTransaction Service.	No
   cpp.compiler	The path to an installed C/C++ preprocessor. By default, if not set then OpenCCM compilers will use their own Java-based preprocessor.	No
   JDO.impl.name	The name of the JDO product used by the OpenCCM Persistent State Service. Only required for compiling and running PSS demonstrations.	No
   JDO.impl.version	The version of the JDO product used by the OpenCCM Persistent State Service. Only required for compiling and running PSS demonstrations.	No
   JDO.impl.prop.dir	The directory where your JDO property file is stored (e.g. kodo.properties). Only required for compiling and running PSS demonstrations.	No
   JDO.impl.home.dir	The directory where the used JDO implementation is installed. Only required for compiling and running PSS demonstrations.	No
   JDBC.driver.jar	The full path to the JDBC driver Jar file used to access your database. Only required for compiling and running PSS demonstrations.	No
   jre.jars.dir	This is the location for your Java Runtime Environment JAR files, typically the lib/ directory of your JDK. This is the default, but MacOS X users must change this value to the commented one in case they're using built-in Java Framework.	No

   Warning: On Windows systems, directories must be separated by '/' instead of '\', e.g. write c:/dev/OpenCCM instead of c:\dev\OpenCCM. Else a lot of errors will appear at compilation and execution times.

   Warning: Don't put some space characters at the end of lines of the previously configurated properties, else some Ant build errors would raise.

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 install.dir directory configurated in the build.properties file:

Installation Instructions for Windows CE / Linux PDA

The OpenCCM for PDA distribution is now available as a separated module on the CVS. The OpenCCM runtime archive provided with this PDA distribution support now the Distributed Computing Infrastructure (DCI) features. To get the pda module, execute the following command:

$ cvs checkout pda

Requirements

As for any other environment, the OpenCCM distribution for PDA needs an installed JVM and ORB to work correctly. In the following distribution, OpenCCM has been succesfully tested with ORBacus-4.1 CORBA product, the IBM J9 Java Virtual Machine (Windows CE device) and Blackdown Java Virtual Machine (Familiar Linux device). However you can use any of supported ORBs or JVM for your device by easily editing the build.properties configuration file.

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

Let's note also that if you want to deploy and execute OpenCCM applications on a PDA, you should (or have to) compile your application and build the Java archive of your application (more precisely the archive of the CORBA component that will be installed and instanciated on the device) using the Java compiler provided with the JVM installed in your device (for example the IBM j9c Java compiler if you use the IBM J9 JVM).

Fully Supported Configurations

OpenCCM has been succesfully tested for the following configurations of devices:

OpenCCM distribution architecture for PDA

The OpenCCM distribution architecture for PDA is the following:

Installation, Compilation and Configuration Instructions

To install and compile OpenCCM for PDA, you have to:

1. Go into the pda root directory corresponding to your OS device (Windows CE or Linux):

   $ cd pda/linux/ or $ cd pda/wince/

2. Edit the build.properties configuration file and set the following variables:

   
   

   Variable	Description	Example (WinCE/Linux)	Mandatory
   orb.install.dir	Path to the installed ORB on the device.	/ORB/JOB-4.1.0	Yes
   openccm.install.dir	Path where OpenCCM build dir will be installed (on the device).	/OpenCCM/build	Yes
   openccm.config.dir	Path to the OpenCCM configuration directory (Linux only).	/OpenCCM_CONFIG_DIR (Linux)	Yes
   java.install.dir	Path to the installed JVM on the device.	\\WSDD (Windows CE / IBM J9 JVM) /j2re1.3.1 (Linux / Blackdown JVM)	Yes
   CLASSPATH	Classpath for Java and OpenCCM.	Windows CE: -cp:xerces.jar;OpenCCM_Launcher.jar Linux: -classpath xerces.jar:OpenCCM_Launcher.jar	Yes
   zip_archive.dir	Path to CORBA Component Assembly archive to deploy (AAR).	${openccm.install.dir}/archives	No

   
   

   Windows CE specific configuration parameters:

   Variable	Description	Example (WinCE/Linux)	Mandatory
   NS.IOR	The default CosNaming service host (Windows CE).	http://host.domain:8080/NameService.IOR mcast://multicast_address_group/NameService.IOR corbaloc::host.domain:2000/NameService	No
   DCI.IOR	The default DCI Manager host (Windows CE).	http://host.domain:8080/DCI.IOR mcast://multicast_address_group/DCI.IOR corbaname::host.domain:2000/NameService#ctx/DefaultDCI (ctx default value is OpenCCM/DCImanagers)	No
   DCI_NAME FACTORY_NAME CS_NAME NODE_NAME ASSEMBLY_NAME DEMO_NAME	Default CosNaming service registration parameters (Windows CE).	DCI_NAME=DefaultDCI FACTORY_NAME=DefaultFactory CS_NAME=ComponentServer2 NODE_NAME=MainNode ASSEMBLY_NAME=MyAssembly DEMO_NAME=MyApp.aar	No

3. Start the Ant tool to compile OpenCCM and generate scripts and configuration files for your device:

   $ ant build

   This create the [linux-or-wince]/build directory that contain the whole OpenCCM distribution for your PDA.

4. Copy the content of this build/ directory to the openccm.install.dir of your device.

   Note:
   The pda/wince/build.bat script allows to compile, generate scripts and configuration files and automatically install OpenCCM on your WinCE device, using an external tool called Remote Command (RCMD) which copy via an ActiveSync link the content of the generated build directory from the desktop to the PDA (assuming your PDA is connected to your desktop via an active ActiveSync link). The first time you use this script, you have to unfortunately create the entire structure of the OpenCCM architecture directories on your device as the RCMD tool is not able to remotely create directory on device (or simply by copying the content of the build/ to the openccm.install.dir directory).
   Nevertheless, if you download the (free) Windows Mobile Developer Toys from Microsoft, you'll be able to easily deploy OpenCCM to your device via ActiveSync (copy files from desktop to device, create or remove directories on device, etc.)

   To use this, just type:
   \pda\wince\> build.bat

Deinstalling OpenCCM for PDA

To deinstall OpenCCM for Linux PDA:

1. Move to the Linux directory with:

   $ cd pda/linux/

2. Execute the following command:

   $ ant clean

This will remove the linux/build directory from the desktop.

To deinstall OpenCCM for Windows CE PDA:

1. Move to the Windows CE directory with:

   $ cd pda/wince/

2. Execute the following command:

   $ ant clean

This will remove the wince/build directory from the desktop.

Warning: To remove the OpenCCM build directory from the WinCE device connected to the desktop via ActiveSync, launch:

$ build.bat clean

Installation Instructions for the Packaging/Assembling Tool

The OpenCCM's Packaging/Assembling Tool is now available as a separate module in the CVS. Still available in its former version within the OpenCCM's main module, we recommend to use this version, since of course it's more up to date, and can be used without building a complete version of OpenCCM. Being dependant on the utils module, everything can be downloaded using :

$ cvs checkout openccm-pat

This will download in your current working director both utils module and packaging_assembling_tool, in two separate folders that interact together during the build process. ATTENTION, you must not separate them until the tool build process isn't complete.

Requirements

The Apache/Jakarta Ant compilation tool is NOTshipped with these modules. You have to have your own installation of this software in order to build the OpenCCM's Packaging/Assembling Tool.

There are no other specific requirements, except for a Java Development Kit. No ORB implementation is required to build or run the tool

Build Instructions

The build process must be intiated from the packaging_assembling_tool directory. Everything builds in a build subdirectory, and all final JARs are copied to the build/lib dir, calling the following ANT target (assuming the ANT_HOME environment variable is set, and the binary is in the path) :

$ ant ccm_tool

Setting The Environment

You don't need to setup your environment to use the tool. Of course, you can still add the appropriated build/bin directory to your path, for convenient access from anywhere in your system to the script, named ccm_assembling.

Usage instructions for the OpenCCM's Packaging/Assembling Tool can be found here.