Galleon layer for embedded broker messaging

In  messaging wf-galleon

Overview

The Jakarta Messaging Service (JMS) provides an API for sending messages between two or more clients and a programming model to handle the producer-consumer messaging problem. Users wishing to use JMS in their applications need a mechanism to be able to connect to a message broker which is responsible for accepting messages from producers and making them available to consumers. The WildFly server is responsible for providing that mechanism to applications in accordance with the JMS specification. There are a number of ways the server can be configured to provide the necessary facilities. An easy practice is use an embedded broker, even if in a cloud environment it would be better to use a remote broker. So, WildFly should make it easy for users to provision a server that can embed an ActiveMQ broker.

The goal of this feature is to supply a Galleon layer which will be responsible for providing the necessary embedded ActiveMQ Artemis broker integration.

The following is a configuration example of the WildFly bootable JAR Maven plugin to provision a server with the embedded-activemq layer:

<plugin>
    <groupId>org.wildfly.plugins</groupId>
    <artifactId>wildfly-jar-maven-plugin</artifactId>
    <configuration>
        <feature-pack-location>wildfly@maven(org.jboss.universe:community-universe)#${version.wildfly}</feature-pack-location>
        <layers>
            <layer>embedded-activemq</layer>
        </layers>
    </configuration>
    <executions>
        <execution>
            <goals>
                <goal>package</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Issue Metadata

Issue

QE Contacts

Testing By

  • [X] Engineering

  • QE

Affected Projects or Components

WildFly

Other Interested Projects

Apache Artemis

Relevant Installation Types

  • Traditional standalone server (unzipped or provisioned by Galleon)

  • [] Managed domain

  • OpenShift s2i

  • Bootable jar

Requirements

Hard Requirements

  • The Galleon layer must provide a messaging-activemq subsystem that provides the following resources:

    • /subsystem=messaging-activemq/server=default and its configuration.

    • /subsystem=messaging-activemq/pooled-connection-factory=activemq-ra using an in-vm connector.

    • /subsystem=messaging-activemq/pooled-connection-factory=RemoteConnectionFactory using a http connector.-

  • The Galleon layer must depend on the 'resource-adapters' layer in order to ensure that the necessary resource adapter support is provided.

  • The Galleon layer must depend on the 'cdi' layer in order to ensure that the necessary injection support is provided.

  • The Galleon layer must depend on the 'ee' layer in order to ensure that the necessary Jakarta EE support is provided.

  • The Galleon layer must depend on the 'naming' layer in order to ensure that the necessary JNDI support is provided.

  • The Galleon layer must depend on the 'elytron' layer in order to ensure that the necessary security support is provided.

  • The Galleon layer must depend on the 'remoting' layer in order to ensure that the necessary remoting support is provided.

  • The Galleon layer must depend on the 'resource-adaptersundertow' layer in order to ensure that the necessary http remoting support is provided.

  • The Galleon layer must configure the 'jms-connection-factory' attribute of the '/subsystem=ee/service=default-bindings' resource to use the 'java:jboss/DefaultJMSConnectionFactory' JNDI binding provided by the pooled-connection-factory=activemq-ra resource.

Nice-to-Have Requirements

Non-Requirements

Test Plan

The test coverage of the Galleon layer added by this proposal is divided in three main groups:

  1. Testing the Galleon layer provisioning. This testing is done by LayersTestCase. The testsuite will be modified to add a new server provisioned with this layer in isolation and with this layer combined with all the layers. For each kind of provisioning, this test does the following:

    1. Verifies the provisioned modules are the expected ones.

    2. Verifies the provisioned server starts successfully.

  2. Execution of existing WildFly tests available in the WildFly test suite, which are directly testing this layer’s functionalities, and execute them on a server installation provisioned with this layer.

  3. Execution of existing WildFly tests related to interaction with an embedded messaging broker. Most such tests do assume an embedded broker, as WildFly’s standard configuration historical includes one.

Note that some of the coverage in the 3rd category of tests will be delivered as part of this feature but will require other features, e.g. Galleon layers for EJB (WFLY-13354). Tests of EJB interaction with a broker require both an EJB layer and a broker layer.

Community Documentation

Community documentation plan is adding the layer to WildFly Galleon layers in the section it belongs to.

Release Note Content

A Galleon layer to provide support for Jakarta Messaging Service (JMS) integration with an embedded ActiveMQ Artemis broker.