The elements in Example 7.2, “JMS Message Broker Configuration” related to dependencies include:

In this case, a number of JARs are listed, including ActiveMQ itself and a number of dependencies. By leaving out the version numbers, this plan will work with whatever specific versions are installed.

The rest of the elements in Example 7.2, “JMS Message Broker Configuration” control the GBeans for the JMS Server. There are several JMS GBean types -- the management features, the core JMS Server configuration (or ActiveMQContainer), persistence methods used by the ActiveMQ broker, one or more transports (or ActiveMQConnectors) providing a pathway for JMS resources to communicate with the core JMS Server, and system properties used by ActiveMQ. Each of the GBean definitions has the same overall form, with elements and attributes including:

While that gives you a feel for the structure of the GBean configuration, each of the JMS GBean types requires specific configuration options.

First, create a deployment plan that's simply a wrapper around the dependencies and GBeans above, and save it to a file such as message-broker-plan.xml (you can use any name). The file should look like this:

message-broker-plan.xml

<module xmlns="http://geronimo.apache.org/xml/ns/deployment-1.1">
  <environment>
    <moduleId>
      <artifactId>MyJMSBroker</artifactId>
    </moduleId>
    <dependencies>
      <!-- dependency elements here -->
    </dependencies>
  </environment>

  <!-- gbean elements here -->
</configuration>

Next, deploy that with a command like this:

java -jar bin/deployer.jar deploy message-broker-plan.xml

(Note that this command assumes that the server is running.)

To deploy a JMS Server to a single application, you'll add the GBean definitions to the deployment plan for the application (which must be packaged as an EAR). This is typically a META-INF/geronimo-application.xml file in the application EAR. If you don't already have a Geronimo deployment plan for the application, you can create one with nothing but the message broker GBean configuration.

A typical geronimo-application.xml deployment plan would look like this:

META-INF/geronimo-application.xml

<application
   xmlns="http://geronimo.apache.org/xml/ns/j2ee/application-1.1">
    <environment>
        <moduleId>
            <artifactId>MyApplication</artifactId>
        </moduleId>
        <dependencies>
            <!-- dependency elements here -->
        </dependencies>
    </environment>
    ...

    <!-- gbean elements here -->
</application>

Then the application can be packaged and deployed like normal, and the message broker will be started when the application is started.

A client-scoped message broker is configured the same way as an application-scoped message broker, except the GBean configuration is inserted into the deployment plan for a single application module instead of for the application EAR. For example, here's an geronimo-application-client.xml file including a JMS Server as part of an client deployment:

META-INF/openejb-jar.xml

<application-client xmlns=
 "http://geronimo.apache.org/xml/ns/j2ee/application-client-1.1">
  <server-environment
        xmlns="http://geronimo.apache.org/xml/ns/deployment-1.1">
    <moduleId>
      <artifactId>MyClientJSR77</artifactId>
    </moduleId>
  </server-environment>
  <client-environment
        xmlns="http://geronimo.apache.org/xml/ns/deployment-1.1">
    <moduleId>
      <artifactId>MyClient</artifactId>
    </moduleId>
    <dependencies>
      <!-- dependency elements here -->
    </dependencies>
  </client-environment>
  ...
  <!-- gbean elements here -->
</openejb-jar>

For the specific ordering of elements within the different module deployment plans, see Chapter 11, Web Applications (WARs) [DRAFT (1.1)], Chapter 12, Enterprise Java Beans (EJB JARs) [DRAFT (1.0)], and Chapter 14, Client Applications (Client JARs) [IN PROGRESS 1.0].