Coherence Incubator Examples

The Coherence Incubator Examples project provides a collection of examples that demonstrate how to use various Incubator patterns. The current release of the examples project includes:

Page: Command Pattern Examples

Page: Push Replication Examples

Page: Functor Pattern Examples

Page: Processing Pattern Examples

Dependencies

This project only depends on the required Coherence versions and the underlying incubator patterns. All current patterns will ship with the Incubator Example project.

Incubator Examples Overview

The Incubator examples project provides a set of in depth examples relating to individual projects along with the infrastructure to easily execute them. The distribution ships with 4 main directories:

docs - Location of all the javadoc generated for the examples.
lib - Location of all the incubator jars that the examples depend on.
resource - Location of all the configuration and properties files used to execute the examples.
src - Location of all the source files for the examples.

Please Note:
On Windows, the Incubator examples directory must not have spaces in the path. Unzip the examples zip file into a directory that doesn't have spaces in the path.

Setting the environment for the examples

The Incubator examples require a supported copy of Coherence, Java 1.5+, and Ant 1.7+. Ensure that the following system properties are set in your shell:

COHERENCE_HOME - The location of your Coherence installation.
JAVA_HOME - The location of your Java 1.5+ installation.

With the environment variables set, run the Ant build script from the installation directory to see a list of supported targets.

Building the examples

The set of examples can be built using the provided Ant script build.xml. From the command line execute the following:

ant build

Coherence 3.6 Support

Release Name:	Version 1.2.3: November 22, 2010
Examples Included:	Coherence Common Functor Pattern Push Replication Pattern Processing Pattern
Target Platforms:	Java Standard Edition 6+
Requires Coherence Version: (not included)	3.6+
Dependencies: (all included)	Coherence Common Command Pattern Functor Pattern Messaging Pattern Push Replication Pattern Processing Pattern
Download: (includes source code)	coherence-3.6-incubator-examples-1.2.3.20019-src.zip MD5:7a5ea4606d860a7f51895c8444998724

Coherence 3.5 Support

Release Name:	Version 1.2.3: November 22, 2010
Examples Included:	Coherence Common Functor Pattern Push Replication Pattern Processing Pattern
Target Platforms:	Java Standard Edition 6+
Requires Coherence Version: (not included)	3.5.3 Patch 6+
Dependencies: (all included)	Coherence Common Command Pattern Functor Pattern Messaging Pattern Push Replication Pattern Processing Pattern
Download: (includes source code)	coherence-3.5-incubator-examples-1.2.3.20019-src.zip MD5:340df4712d79659f4ce749cd3c9b3999

Previous Releases

The following releases are provided for historical purposes only.
Command Pattern Examples 1.0.0, Push Replication Pattern Examples 1.0.0, Processing Pattern Examples 1.0.0

Detailed Documentation

Using Push Replication with Coherence*Web

Coherence*Web Example 1.2.0

Running the examples

Each set of examples will have a number of applications and cache servers that need to be run. Each individual process required for an example will have a corresponding properties file which will provide the set of configuration parameters required to start. The available configuration parameters are:

MAIN_CLASS - The main class to execute.
CACHE_CONFIG_FILE - The cache configuration file to use.
CLUSTER_PORT - The cluster port to start a coherence server with.
MAIN_CLASS_ARGS - Quoted set of arguments to pass to the main class.
LOCAL_STORAGE - True to enable local storage.
COH_OPTS - Additional Java options that you want to set for Coherence.

Properties files for each example will be provided out of the box. To run an example you specify the relative path to the properties file from the resources directory. To run the command pattern proxy server you would run ant -Dfile=commandpattern/proxy.properties run.

The directory containing a properties file is included in the classpath when running an example. This means that all the configuration files in this directory are available at runtime.

Please Note:
The scripts currently expect you to run them from the root directory of the examples project.

Coherence Incubator Examples