Contact Us 1-800-596-4880
  1. Homepage

  2. Anypoint MQ Connector (3.x)

All Connectors

Anypoint MQ Connector 3.x — Mule 4

Support Category: Select

The Anypoint MQ connector provides publish-subscribe messaging to Mule apps using the Anypoint MQ cloud service.

Anypoint MQ supports a wide range of messaging use cases, such as enterprise messaging patterns, asynchronous communications between microservices, and IoT. Anypoint MQ also has a REST API for publishing or consuming messages using frameworks such as node.js, Java, Go, and DevOps bash scripts.

Requirements

To use this connector, you should be familiar with Anypoint Studio, Anypoint Connectors, and application flows. The Anypoint MQ connector is free, but connecting to the service in Anypoint Platform requires a license.

Compatibility

Software Version

Mule runtime engine

4.1.1 and later

Anypoint Studio

7 and later

This documentation applies to Anypoint MQ connector 3.x only. To migrate from version 2.x to the version 3.x, see the Anypoint MQ Connector 3.x Migration Guide - Mule 4.

Install Anypoint MQ Connector

You can use this connector with apps written in Anypoint Studio, standalone apps, or apps written in XML.

In Anypoint Studio:

  1. Create or open a Mule project.

  2. Click the Exchange icon in the Studio task bar.

  3. Enter your Anypoint Platform username and password and click Sign in.

  4. Select All assets and search for "MQ".

  5. Select "Anypoint MQ Connector - Mule 4", and click Add to project.

  6. Follow the prompts to install the connector.

For standalone apps or apps written in XML:

  1. Open your Mule project in Anypoint Studio.

  2. Add the connector as a dependency in the pom.xml file:

    <dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>anypoint-mq-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>

Replace x.x.x with the version that corresponds to the connector you are using.

To obtain the most up-to-date pom.xml file information, access the connector in Anypoint Exchange and click Dependency Snippets.

Configure an Operation in a Mule Project

In Anypoint Studio:

  1. Install the connector, if it’s not already installed. See Install Anypoint MQ Connector.

  2. Create or open a Mule project.

  3. Search for "mq" in the Mule Palette.

  4. Click Anypoint MQ to see the available operations for the connector.

    Anypoint MQ Mule Palette

  5. Configure the operation accordingly.

    Operation Description

    ACK

    Indicates that the message has been consumed correctly and deletes the message from In Flight status.

    Consume

    Consumes messages from a queue.

    NACK

    Changes the status of the message from In Flight to In Queue to be consumed again by an available consumer.

    Publish

    Publishes messages to a destination.

    Subscriber

    Listens for messages from a queue.

Configure the Connection to the Default Subscriber

For each operation, you must configure a connection to a subscriber.

In Anypoint Studio:

  1. Drag the name of the operation from the Mule Palette to the canvas, and then select it.

  2. Click the green plus sign to the right of Connector configuration.

  3. In Anypoint Platform, click MQ > Destinations.

  4. Copy the URL for your region to the URL field in Studio.

  5. In Anypoint Platform, click MQ > Client Apps.

  6. If needed, create a client app.

  7. Copy the Client App ID value from Anypoint Platform to the Client App ID field in Studio.

  8. Copy the Client Secret value from Anypoint Platform to the Client Secret field in Studio.

  9. Click Test Connection to verify the Anypoint MQ Default subscriber.

  10. Click OK.

See Also

Back to top
View on GitHub