coherence-command-pattern

Skip to end of metadata
Go to start of metadata
Deprecation Announcement
This release of the Coherence Incubator is now deprecated. For the latest supported release, help and documentation, please refer to the Coherence Incubator Project on java.net at http://cohinc.java.net.

The Command Pattern Project
Provides a distributed implementation of the classic Command Pattern.

Overview

This is an example implementation of the Command Pattern (Wikipedia) built using Oracle Coherence.

The Command Pattern advocates that;

  1. An action to be performed zero or more times at some point in the future should be represented as an object called a Command.
  2. All necessary parameters required to perform the said action, should be encapsulated as attributes with in the said Command object.
  3. The Command object must provide a mechanism to perform the action (typically represented an execute method defined on the said Command object)

This implementation of the Command Pattern additionally advocates that;

  1. A Command may only be executed with in the scope of a target object, called a Context.
  2. To execute a Command it must be submitted to a Context.
  3. Once submitted , Commands are executed asynchronously. That is, the submitter of the Command does not block or wait for the Command to be executed after it has been submitted.
  4. Commands are executed one-at-a-time, in the order in which they arrive at their Context.
  5. A Command may not return a value to the application that submitted the said Command. If you require a Command that returns a value after execution, you need a Functor (see the Functor Pattern)
Revision History
Version 2.8.5 (changes since 2.8.3)

Version 2.8.5 is a patch release to upgrade dependencies to Coherence Common. It also adds the ability to specify the number of threads provided for executing commands, using the command line argument com.oracle.coherence.commandpattern.threadpoolsize. The default size is 5.

Version 2.8.4 was an internal unreleased version.
Version 2.8.3 (changes since 2.8.2)

Version 2.8.3 is a patch release to upgrade dependencies to Coherence Common.

Version 2.8.2 (changes since 2.8.1)

Version 2.8.2 is a patch release to upgrade dependencies to Coherence Common.

Version 2.8.1 (changes since 2.8.0)

Version 2.8.1 is a patch release to upgrade dependencies to Coherence Common and support the out and coming Coherence release.

Version 2.8.0 (changes since 2.7.3)

The most significant upgrade for this release is the adoption of Coherence 3.7. Overtime this will allow the pattern to take advantage of the lastest features, like "lite transactions" to ensure atomicity of multi-cache updates, without the overhead of "heavy" transactions.

Legend | = Fixed | = Breaking Change / Deprecation | = Improved | = New
  • Removed the separate pof and non-pof cache configurations. Cache configuration files now use the system-wide defined serializer. This dramatically simplifies serialization configuration and halves the number of cache configuration files.
  • Explicitly specifies xsds in configuration files to strictly enforce document validation.

Release Version: Version 2.8.5.39174
Release Date: October 31, 2012
Coherence Version: 3.7.1+
Target Platforms: Java Standard Edition 6+
Dependencies: Coherence Common
Download: coherence-commandpattern-2.8.5.39174.jar
MD5: bfe70a42bc8604dd5e2a01ebecb33366
Source and
Java Doc:
coherence-commandpattern-2.8.5.39174-src.zip

* Previous releases are available from the attachments page

Examples

Example source code and uses of this pattern can be found in the Coherence Incubator Examples project.

Structure

The following diagram outlines the core classes and interfaces defined in this implementation of the Command Pattern.

The Command interface specifies the minimum requirements for Command objects. It defines a single method called execute that is invoked by the internal CommandExecutor when a Command is to be executed. The execute method requires a single parameter, called the ExecutionEnvironment. The ExecutionEnvironment provides valuable information to the execute method, including the Context in which the Command is being executed. To submit Commands for execution by CommandExecutor s, you must use an implementation of the CommandSubmitter interface (the DefaultCommandSubmitter class provides the standard implementation).

To define and register a Context about which you may submit Command s for execution, use an implementation of the ContextsManager interface (the DefaultContextsManager class provides the standard implementation). Once a Context is registered, you may use the returned Identifier to submit Command s for execution with a CommandSubmitter.

Be Careful
As Context and Command instances are stored in Coherence cluster members within the Data Grid, they must be Serializable or better still, implement ExternalizableLite or PortableObject
Command Pattern Usage Walkthrough
Step 1: The Initial Environment

  • One Client Application
  • Two Coherence Cache Servers
  • All part of the same Coherence Cluster *

* The Client Application may be external to the Coherence Cluster when using Coherence *Extend

Step 2: Context Creation

  • The client application creates an instance of a Context
Step 3: Context Registration

  • The client application registers the created Context using a ContextsManager *
  • The ContextsManager places the Context into a "primary partition" of the "contexts" Distributed Cache.
  • Coherence ensures a backup of the Context is made to a "backup partition" (on separate JVMs and different machines where possible)

* Typically an instance of the DefaultContextsManager

Step 4: Establishing the CommandExecutor (automatic)

  • When a Context is registered, an internal event establishes an appropriate CommandExecutor and necessary infrastructure.
Step 5: Creating a Command

  • The client application creates an instance of a Command
Step 6: Submitting a Command for execution

  • The client application uses a CommandSubmitter to submit a Command for execution with an identified Context *
  • The submitted Command is placed into the "commands" Distributed Cache (and automatically backed up)
  • The submitted Command is then automatically queued (FIFO) and scheduled for asynchronous execution by the CommandExecutor for the Context

* An individual Command instance may be submitted any number of times for execution to one or more Contexts. There is no need to create new instances of the same Command if it needs to be submitted for execution multiple times.

Step 7: Numerous Commands Submitted

  • Multiple Commands may be submitted for execution at once.
  • Commands are queued for execution (FIFO) in order of arrival at the Context
Step 8: Commands are executed by the CommandExecutor (Asynchronously)

  • When Commands are queued for execution, an internal event notifies the CommandExecutor to start executing the Commands
  • For efficiency, the CommandExecutor may execute Commands in batches (but remaining in order).
Step 9: Commands Automatically Cleaned-up when Executed.

  • Once a Command has been executed, it is removed from the "commands" cache (as is the backup of the Command).
Example

Let's start with a simple example where we use the Command Pattern to setValue(T) on the GenericContext.

First, we'll start by writing a simple SetValueCommand that extends AbstractCommand as seen here:

SetValueCommand.java

Second, let's write a quick test that submits a number (iCount) of SetValueCommand s on "mycontext" as seen here:

CommandPatternExample.java

To run this test you will need to start a Coherence cache server, in this example we use the DefaultCacheServer that ships with Coherence as seen here:

Once the cache server is running you can start the CommandPatternExample as a cache client as seen here:

The SetValueCommand.java, CommandPatternExample.java and coherence-commandpattern-cache-config.xml files are included in the source code distribution.
Frequently Asked Questions

What is the relationship between the Functor Pattern, Command Pattern, Entry Processors and the Invocation Service for performing work in a cluster?

The following table outlines the main differences.

  Functor Pattern Command Pattern EntryProcessors InvocationService
Processing Target A Context A Context A Cache Entry A Cluster Member
Submission Behavior Non-Blocking Non-Blocking Blocking Blocking and Non-Blocking
Execution Order Order of Submission Order of Submission Order of Submission (unless using PriorityTasks) Order of Submission
Supports Return Values?
(and re-throwing Exceptions)
Yes No Yes Yes
Guaranteed to Execute?
(if Submitter terminates after submission)
Yes Yes Yes (submitter blocks) Yes (for blocking), No (for non-blocking)
Guaranteed to Execute?
(if Target JVM terminates during execution)
Yes Yes Yes (submitter automatically retries) No (retry up to developer)
Submitted requests recoverable from disk? Yes (when using Cache Store) Yes (when using Cache Store) No No
Request may be cancelled? Yes Yes No Yes (for non-blocking)

What is a ManagementStrategy ?

A ManagementStrategy defines how Commands are managed in a Coherence Cluster. By default Commands are always co-located in the JVM that is hosting the Context associated with the said Commands. This provides instant access to the Commands for a CommandExecutor but has the disadvantage of limiting the number of Commands that may be queued for execution (before a JVM may run out of memory). The alternative is to use the DISTRIBUTED strategy, where the Commands are distributed across the cluster and only retrieved for execution when required. This provides the advantage of enabling massive capacity (scaling to the size of the cluster and beyond when disk storage is configured), but has the disadvantage that retrieving Commands for execution may take longer.

How do I monitor the execution of Commands ?

The Command Pattern CommandExecutors are JMX enabled by default. In order to monitor Command execution for a Context, simply enable JMX for Coherence and look for the "CommandExecutors" in your JMX monitoring application (ie: Something like JConsole). All kinds of JMX information is available, including Min, Max and Average Execution time, together with the number of current Commands pending to be executed and those that have been executed.

References and Additional Information
Labels:
project project Delete
current current Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.