AMQP Bridge Extension Swiftlet

The AMQP Bridge Swiftlet provides bridging functionality between AMQP brokers. Bridges can be defined between SwiftMQ and foreign AMQP brokers as well as between foreign AMQP brokers only. Supported AMQP versions are 0.9.1 and 1.0.

An AMQP bridge consists of a source from which messages are consumed and a target to which messages are sent. Both must have the same AMQP version. Since SwiftMQ supports AMQP 0.9.1 and AMQP 1.0, it is possible to use SwiftMQ as a relay from 2 bridges to convert AMQP 0.9.1 to AMQP 1.0 messages and vice versa.

Example: Bridging between SwiftMQ and foreign AMQP Brokers

In this example, the SwiftMQ Router acts as a source or target and is connected to a foreign AMQP Broker like Qpid Java broker with AMQP 1.0 or RabbitMQ with AMQP 0.9.1.

Example: Bridging between foreign AMQP Brokers

In this configuration, the SwiftMQ Router only provides the bridge between foreign AMQP Broker pairs with the same AMQP version.

Example: Bridging between AMQP 0.9.1 and AMQP 1.0 with SwiftMQ as a Relay

Here two AMQP brokers of different AMQP versions are connected to a SwiftMQ Router with a relay queue acting as a source or target, respectively. RabbitMQ produces AMQP messages with AMQP version 0.9.1 and stores them into a relay queue at the SwiftMQ Router. From here the messages are transferred as AMQP version 1.0 to the Qpid Java broker.

AMQP 1.0 Bridges

Create/Delete a Bridge

Select the AMQP 1.0 Bridges:

Click on Create a new Entity and enter the name of the bridge but do NOT yet enable it because it needs to be configured first:

The new bridge appears in the above table. It can be deleted by clicking Delete Entity:

Configure a Bridge

Entity Source specifies the broker where the messages are consumed from, entity Target the broker where the messages are sent to. The attributes of the entities are used to configure the SwiftMQ AMQP 1.0 Java Client which is used internally.

The source and target of a bridge do reference a connection template which is configured here:

If the name of the connection template is default, default values are used as shown here (a connection template with the name default doesn't need to be created):

Custom templates can be created and referenced from source and/or targets:

Please have a look at the SwiftMQ AMQP 1.0 Java Client documentation to get further information.

The configuration can be changed at any time but should be done in a disabled state. The changes take effect after the bridge has been enabled again.

Enable/Disable a Bridge

The bridge will be activated by checking the Enabled box:

The bridge now transfers messages if everything is configured properly. To stop it, uncheck the Enabled box.

Monitor a Bridge

Active bridges are listed under the Usage entity of the Swiftlet:

AMQP 0.9.1 Bridges

Install the RabbitMQ Java Client

AMQP 0.9.1 bridges use the RabbitMQ Java client internally. You need to install it first before an AMQP 0.9.1 bridge can be created.

Download here.

After this Swiftlet has been successfully deployed, unpack it and copy commons-io-x.x.jar and rabbitmq-client.jar into the deployment directory of this Swiftlet.

The Swiftlet then gets automatically redeployed (hot deployment). AMQP 0.9.1 bridges can now be created.

Create/Delete a Bridge

Select the AMQP 0.9.1 Bridges:

Click on Create a new Entity and enter the name of the bridge but do NOT yet enable it because it needs to be configured first:

The new bridge appears in the above table. It can be deleted by clicking Delete Entity:

Configure a Bridge

Entity Source specifies the broker where the messages are consumed from, entity Target the broker where the messages are sent to. The attributes of the entities are used to configure the RabbitMQ client.

The configuration can be changed at any time but should be done in a disabled state. The changes take effect after the bridge has been enabled again.

Enable/Disable a Bridge

The bridge will be activated by checking the Enabled box.

The bridge now transfers messages if everything is configured properly. To stop it, uncheck the Enabled box.

Please save your configuration! See top of this page.

Monitor a Bridge

Active bridges are listed under the Usage entity of the Swiftlet:

Jobs

The AMQP Bridge Swiftlet registers jobs in job group AMQP Bridge at the Scheduler Swiftlet:

These jobs can be scheduled via the Scheduler Swiftlet to run at specific times or in intervals, based on calendars and so on.

Bridge

The Bridge job activates an AMQP bridge on the job start and deactivates it on the job stop. The name of the bridge must be specified as a parameter. The job requires setting a maximum runtime to deactivate the bridge. Otherwise, it would be active forever.

The implementation of the Bridge job is quite simple. It sets the enabled attribute to true on job start and to false on job stop. Therefore, a server bridge that should run as a job should be initially disabled.

Installation

The installation takes place via 'hot deployment'. See the documentation of the Deploy Swiftlet for further information.

Configuration

The configuration of the AMQP Bridge Extension Swiftlet is defined within the element

      <swiftlet name="xt$amqpbridge" .../>

of the router's configuration file.

Element List "connection-templates", Parent Element: "swiftlet"

Templates for Connections. This element list contains zero or more "connection-template" elements with this template definition:

Definition

Values

Element List "bridges100", Parent Element: "swiftlet"

AMQP 1.0 Bridges. This element list contains zero or more "bridge100" elements with this template definition:

Definition

Values

Element "source", Parent Element: "bridge100"

Source.

Definition

Values

Element "target", Parent Element: "bridge100"

Target.

Definition

Values

Element List "bridges091", Parent Element: "swiftlet"

AMQP 0.9.1 Bridges. This element list contains zero or more "bridge091" elements with this template definition:

Definition

Values

Element "source", Parent Element: "bridge091"

Source.

Definition

Values

Element "target", Parent Element: "bridge091"

Target.

Definition

Values

Element "usage", Parent Element: "swiftlet"

Active AMQP Bridges.

Element List "bridges091", Parent Element: "usage"

AMQP 0.9.1 Bridges. This element list contains zero or more "bridge091" elements with this template definition:

Definition

Values

Element List "bridges100", Parent Element: "usage"

AMQP 1.0 Bridges. This element list contains zero or more "bridge100" elements with this template definition:

Definition

Values

CLI Commands During Deployment

This Swiftlet performs the following CLI commands during deployment:

      cc /sys$threadpool/pools
      new amqpbridge.poll
      cc /sys$threadpool/pools/amqpbridge.poll/threads
      new extension.xt$amqpbridge.poller
      cc /sys$threadpool/pools
      new amqpbridge.client.connection
      cc /sys$threadpool/pools/amqpbridge.client.connection/threads
      new extension.xt$amqpbridge.client.connection
      cc /sys$threadpool/pools
      new amqpbridge.client.session
      cc /sys$threadpool/pools/amqpbridge.client.session/threads
      new extension.xt$amqpbridge.client.session

CLI Commands During Undeployment

This Swiftlet performs the following CLI commands during undeployment:

      cc /sys$threadpool/pools
      delete amqpbridge.poll
      delete amqpbridge.client.connection
      delete amqpbridge.client.session