Installing SolOpenMAMA Components

To use Solace OpenMAMA API(SolOpenMAMA) , the following components must be installed and configured:

Solace Event Broker

For client applications to be able to publish and/or receive OpenMAMA messages through Solace , event brokers must be network‑accessible and properly configured to handle messaging clients.

To use an event broker specifically for OpenMAMA messaging, the following extra requirements must be met:

  • Solace Event Broker, Version 7.1 or higher must be used
  • a Solace-provided product key is required to use the OpenMAMA transport service
  • a Solace-provided product key is required to use the Solace Cache facility

    If the required product keys are not pre-entered on the event broker by Solace, valid product keys provided by Solace must be manually entered on the event broker. For assistance with product keys, contact Solace.

Client Systems

For client applications to be able to publish and/or receive OpenMAMA messages through Solace event broker, the following requirements must be met on the system on which the client application is installed:

Installing Solace Middleware and Payload Bridges

A Solace Middleware Bridge and a Solace Payload Bridge must be installed on:

  • each system that hosts an OpenMAMA client application
  • when last-value caching is to be used, each Linux server that will host a Solace Cache Instance

A Solace Middleware Bridge and a Solace Payload Bridge are provided in the single archive file (solopenmama_bridge_<supported_environment>_<releasenumber>.tar.gz) that can be downloaded from the Secure File Transfer Protocol (SFTP) server.

Archives are available for each of the following supported environments:

  • Windows 7 (32-bit and 64-bit versions)
  • Windows 8 (32-bit and 64-bit versions)
  • Windows Server 2008 (32-bit and 64-bit versions)
  • Linux26-i386
  • Linux26-x86_64

These archives may contain build artifacts for the particular environment you choose (for example, static/dynamic libraries, optimized/debug libraries, and so on).

To install a Solace Middleware Bridge and a Solace Payload Bridge on a system that hosts an OpenMAMA client application or a Solace Cache Instance, perform the following procedures:

  1. Download a SolOpenMAMA Bridge archive file for the appropriate system environment.
  2. Unzip the archive file.
  3. Copy the Solace Middleware Bridge and Payload Bridge runtime libraries from the lib directory to an install directory from which they can be statically or dynamically linked.

Installing OpenMAMA and OpenMAMDA APIs

The standard OpenMAMA and OpenMAMDA APIs must be installed on:

  • OpenMAMA client applications to allow them to interact with the Solace Middleware and Payload Bridges.

    The native C, or the C++, Java, or C# wrappers of the OpenMAMA and OpenMAMDA APIs may be installed, depending on the particular requirements of the client application and the system hosting that application.

  • each Linux system to host a Solace Cache Instance

    Only the native C versions of the OpenMAMA and OpenMAMDA APIs must be installed.

The OpenMAMA and OpenMAMDA APIs are maintained and freely distributed by the OpenMAMA project. They are not provided by Solace. To download the OpenMAMA and OpenMAMDA APIs, go to openmama.org.

For information on the supported OpenMAMA and OpenMAMDA APIs versions, see the Solace OpenMAMA Release Notes.

To install the OpenMAMA and OpenMAMDA APIs to a common install directory on a host system, follow the instructions provided with the downloaded OpenMAMA archive files.

The obtained APIs must then be configured to use Solace Middleware and Payload bridges. A mama.properties file is used for these configurations (refer to Configuring Solace OpenMAMA Bridges).

Installing the Solace C API

The Solace C API must be installed on each system that hosts an OpenMAMA client application. The Solace Messaging API for C is provided as an archive.

If Solace Cache is to be used, the C API must be installed on each Linux system that will host a Solace Cache Instance. For more information, follow the steps in the README file included with the Solace Cache installation package.

To install the C API on a system that hosts an OpenMAMA client application, perform the following procedures:

  1. Download a C API archive file for the appropriate system environment.

    The Solace C API will reside on the same host as the Solace Middleware Bridge and Solace Payload Bridge, therefore, the C API version that you download must support the same environment as the Solace Middleware Bridge and Solace Payload Bridge. For more information on the environments supported by the Solace Middleware Bridge and Solace Payload Bridge, refer to Installing Solace Middleware and Payload Bridges.

  2. Unzip the downloaded archive file.

    The sample C API applications contained in the ex directory should not be used or consulted for use with an OpenMAMA messaging environment because all application interaction with C API will occur through the Solace Middleware and Payload Bridges.

  3. Copy the C API runtime libraries from the lib directory to the same install directory that contains the OpenMAMA and OpenMAMDA APIs.

Last-Value Message Caching

If the Solace Cache last-value caching facility is to be used, the following components must be installed and properly configured on each 64-bit Linux system that will host a Solace Cache Instance:

Installing and Configuring Solace Cache Instances

A Solace Cache Instance consists of a single Solace Cache process that must be installed on a standalone Linux system and a corresponding Solace Cache Instance object on an event broker that is created through the Solace Event Broker CLI.

  • To install a Solace Cache Instance on standalone Linux systems, follow the steps in the README file included with the Solace Cache installation package.

    The Solace Cache installation package is available for download. Contact Solace if you do not have access to this download site.

    Solace Cache Instances to be used for OpenMAMA message caching must only use the debug and optimized 64-bit Linux versions of the Solace Cache Instance software.

  • To configure the corresponding Solace Cache Instance on the event broker, see Configuring Solace Cache Instances.

Installing SolOpenMAMA Plug-Ins

After you have installed a Solace Cache Instance on a Linux server, you must replace the default Solace Cache Plug-In provided with the Solace Cache Instance with a Solace-customized SolOpenMAMA Plug-In.

The SolOpenMAMA Plug-In is required for a Solace Cache Instance to properly handle received OpenMAMA messages according to their message type (for example, an initial message or an update) before they are cached. This special handling is used to facilitate OpenMAMA incremental/delta updates.

To install the SolOpenMAMA Plug-In for a Solace Cache Instance, follow this procedure:

  1. Download the SolOpenMAMA Plug-In archive file (solopenmama_plugin_<supported_environment>_<releasenumber>.tar.gz) from the Solace.
  2. Unzip the archive file.
  3. Replace the default Solace Cache Plug-In library (libSolCachePlugin.so) that is located in the Solace Cache install directory on the Linux server (for example, /usr/local/solace) with the Solace-customized SolOpenMAMA Plug-In library of the same name from the lib directory of the extracted package.
  4. Copy the Solace-provided dictionary from the extracted package or a customer-provided dictionary to the Solace Cache install directory on the Linux server.
  5. Copy the Solace-provided SolOpenMAMA Plug-In configuration file (mama.properties) to the Solace Cache install directory on the Linux server, and use a text editor to configure this file (refer to Configuring Message Caching).