Changes

v0.2

It is no longer a mandatory to provide a JMS ConnectionFactory. For a single JVM simple usage, you may use the default in-memory, non-persistent ActiveMQ connection factory, or you could configure your JMSProvider in several ways.

The library is no longer used as a Groovy Category. The Groovy Category are hidden. There are a few different ways to use:

The base Category API are slightly modified and are refactored to the JMSCoreCategory. Two sets of new APIs: GroovyJMS API and Groovy Messaging Service API are provided. The latter are designed base on the Groovy Sql.

Usage

Concepts

GroovyJMS Execution Context

GroovyJMS mainly provide an execution context that you can use enhanced JMS API and convenient methods, and access to implicit variables

GroovyJMS is based on JMS and preserve any JMS concepts and keywords. You could mix the usage of GroovyJMS API and JMS API in the execution context.

GroovyJMS Core API

GroovyJMS Core API is based on the JMSCoreCategory, and shall be used in Execution Context. APIs are provided for JMS Resource and Destination

JMS Resource - ConnectionFactory, Connection and Session. You could create any of them outside the execution context and pass to the constructor of GroovyJMS, or you could use the implicitly created instances.

Refer to the next section about JMS ConnectionFactory

Inside the execution context, you could get a copy of the thread-scope connection and session instance. But you cannot set a new connection or session.

GroovyJMS provides high level API that use a single connection and session per thread. Unless you want a fine-grained control over the re-use of Connection and Session, it is not necessary to care about these resources.

JMS Destination - Queue, Topic

There are two types of JMS destination. GroovyJMS provides high level API to operate on any Queue or Topic, unless you need to get a reference for JMS Destination, you don't need to care about JMS Destinations.

Short API are provided for creating JMS Destinations. Similar to JMS Resource, calling subject is interchangable.

The return value of topic() and queue() are JMS Topic and Queue respectively. However, in GroovyJMS Execution Context, you could use some operation APIs such as send(), receive() etc. directly on JMS Destination.

GroovyJMS API

GroovyJMS API is based on the JMSCoreCategory, and shall be used in Execution Context

For simple usage, it is the only thing you need to learn. GroovyJMS API uses keywords from JMS API.

fromTopic and fromQueue could be used together
fromQueue always call receiveAll (to be enhanced to take a parameter to return only 1 message)
if fromQueue has more than one queue, it return all messages of all queues
fromTopic is asynchronous durable subscription, if both fromQueue and fromTopic are used together, any immediately available messages in any fromQueue will return first, and new message will be delivered to the same with closure in a later time
either use jms.receive([:]){ } or jms.receive([xxx:yyy, with:{}]) ; the former override the later
within is a per queue timeout interval, not total; if there are more than one queue, each are retrieved in sequence

sql.executeUpdate()

jms.send( toTopic:'myTopic', message:[key:value], replyTo:'')

toTopic and toQueue could be used together
toTopic and toQueue support collection

All return value or closure handler result are JMS Message. It might be changed to String, Map, Byte[], Stream and Object in the future.

Similar to Sql, fine-grained control over connection/session could be done by passing in a JMS Connection or Session in the JMS.newInstance(), and user has to close the session/connection themselves

JMS Connection Factory

To use GroovyJMS, you need to decide which JMS implementation you'll use. There are several options:

use the default in-memory, not-persistent ActiveMQ broker and connection factory, this is created by the ActiveMQJMSProvider class. Notice that the ActiveMQJMSProvider will start a ActiveMQ broker if it is not existed already, and will add a "vm://localhost" transport connector URL if not existed. In this case, the syntax is as simple as:

Provide a JMSProvider by

specific a "groovy.jms.provider" system property that point to a class that implements groovy.jms.provider.JMSProvider

set a JMSProvider to the JMS.provider static variable, e.g.

Provide Connection Factory or Connection in runtime. it is the most recommended approach. You may utilize your JEE container or dependency injection framework to inject the required JMS resources to your class, and support the connection or factory to GroovyJMS.

Other important information

autoClose

by default, all connection are closed at the end of an execution context, or after any operation for Groovy Messaging Service API.

For Groovy Messaging Service API, if you need to do more than one operation, you have to set autoClose to false, and call close() explicitly

When using in execution context, it's unommon to disable autoClose. As one of the purpose of the execution context is to autoClose resource for you. If you need to use execution context and want to disable autoClose, one of the ways is:

Or you'd better directly use the JMS Category without setting up an execution context.

Unsupported Features or Limitation

nested usage is not supported yet. you may still use the lib in nested manner but you have manage the Connection and Session carefully.

For example:

you are recommended to avoid nestled usage. If you use it, try to use a multiple connection.