Mashroom Messaging External Provider AMQP

Plugin for Mashroom Server, a Microfrontend Integration Platform.

This plugin allows to use an AMQP 1.0 compliant broker as external messaging provider for server side messaging. This enables cluster support for server side messaging and also allows communication with 3rd party systems.

Usage

If node_modules/@mashroom is configured as plugin path just add @mashroom/mashroom-messaging-external-provider-amqp as dependency.

To activate this provider configure the Mashroom Messaging plugin like this:

{
    "plugins": {
        "Mashroom Messaging Services": {
            "externalProvider": "Mashroom Messaging External Provider AMQP"
        }
    }
}

And configure this plugin like this in the Mashroom config file:

{
  "plugins": {
        "Mashroom Messaging External Provider MQTT": {
              "internalRoutingKey": "mashroom",
              "brokerTopicExchangePrefix": "/topic/",
              "brokerTopicMatchAny": "#",
              "brokerHost": "localhost",
              "brokerPort": 5672,
              "brokerUsername": null,
              "brokerPassword": null
        }
    }
}

• internalRoutingKey: The base routing key the server should use for internal messages. E.g. if the value is mashroom.test all messages published internally are prefixed with mashroom.test before published to the broker and at the same time this provider listens to mashroom.test.# for messages (Default: mashroom)
• brokerTopicExchangePrefix: The prefix for the topic exchange (default: /topic/ (RabbitMQ))
• brokerTopicMatchAny: The wildcard for match any words (default: # (RabbitMQ))
• brokerHost: AMQP broker host (Default: localhost)
• brokerPort: AMQP broker port (Default: 5672)
• brokerUsername: AMQP broker username (optional)
• brokerPassword: AMQP broker password (optional)

Broker specific configuration

RabbitMQ

 "brokerTopicExchangePrefix": "/topic/",
 "brokerTopicMatchAny": "#",

ActiveMQ

 "brokerTopicExchangePrefix": "topic://",
 "brokerTopicMatchAny": ">",

Qpid Broker

 "brokerTopicExchangePrefix": "amq.topic/",
 "brokerTopicMatchAny": "#",