# RabbitMQ ## Overview RabbitMQ is a lightweight and easy-to-deploy messaging platform that supports multiple messaging protocols. It can be configured in distributed and federated setups to meet high-scale and high-availability requirements. Joule enables publishing to RabbitMQ queues, exchanges and topics, providing flexible event-driven architectures. Additionally, the page highlights the usage of Joule to consume events via RabbitMQ messaging subscriptions. {% hint style="info" %} **Client library**: [com.rabbitmq:amqp-client:5.16.0](https://mvnrepository.com/artifact/com.rabbitmq/amqp-client/5.16.0) {% endhint %} ## Examples & DSL attributes This example shows how to configure a RabbitMQ consumer that subscribes to specific event types using routing keys with a topic exchange. The consumer listens for events related to quotes for specific stocks (IBM, MSFT and GOOG) from the `marketQuotes` exchange. The events are deserialised from a `StreamEvent` JSON object into a `Joule StreamEvent` object using a custom parser. ```yaml rabbitConsumer: host: localhost exchange: name: marketQuotes type: TOPIC routing: keys: - NASDAQ.IBM - NASDAQ.MSFT - NASDAQ.GOOG deserializer: parser: com.fractalworks.examples.banking.data.QuoteToStreamEventParser ``` ### Attributes schema

Attribute	Description	Data Type	Required
host	RabbitMQ server hostname or Ip address	String Default: localhost	false
port	RabbitMQ server port, must be greater than 0	Integer Default: 5672	false
username	User name	String Default: guest	false
password	password	String Default: guest	false
virtualHost	Creates a logical group of connections, exchanges, queues, bindings, user permissions, etc. within an instance See vhost documentation for further information	String Default: /	false
autoAck	Flag to consider if server should message acknowledged once messages have been delivered. False will provide explicit message acknowledgment	Boolean Default: true	false
prefetchCount	QoS -maximum number of messages that the server will deliver, 0 if unlimited	Integer Default: 1	false
global	QoS - true if the settings should be applied to the entire channel rather than each consumer	Boolean Default: true	false
durable	Set a durable queue (queue will survive a server restart)	Boolean Default: true	false
autoDelete	Server deletes queue when not in use	Boolean Default: true	false
exclusive	Exclusive queue to this connection	Boolean Default: false	false
arguments	Additional queue properties	Map<String, Object> Default: null	false
exchange	Exchange configuration	See exchange sttributes section	false
routing	Routing configuration	See routing attributes section	false
deserializer	Deserialisation configuration	See Deserialisation documentation	false

### **Exchange attributes schema**

Attribute	Description	Data Type	Required
name	Name of exchange	String	true
type	In RabbitMQ, messages are published to an exchange and depending on the type of exchange, the message gets routed to one or more queues	TOPIC, DIRECT, FANOUT, HEADERS Default: TOPIC	false
arguments	Additional binding properties	Map<String, Object> Default: null	false

Attribute

Description

Data Type

Required

name

Name of exchange

String

true

type

In RabbitMQ, messages are published to an exchange and depending on the type of exchange, the message gets routed to one or more queues

TOPIC, DIRECT, FANOUT, HEADERS

Default: TOPIC

false

arguments

Additional binding properties

Map<String, Object>

Default: null

false

### **Exchange example** ```yaml rabbitConsumer: ... exchange: name: marketQuotes type: DIRECT ``` ### **Routing attributes schema**

Attribute Description Data Type Required

keys

Attribute	Description	Data Type	Required
keys	Consumers can selectively consume events sent to a `topic` exchange by specifying one or more words delimited by dots. Learn more about how to apply it here. Valid key format examples: 'nasdaq.ibm', 'dept.inventory.bolts'. There are two important special cases to define keys: `*`(star) can be substituted for exactly one word `#`(hash) can be substituted for zero or more words	String Default: All Constraints: Any number of dot separated words to a limit of 255 bytes	false

Consumers can selectively consume events sent to a topic exchange by specifying one or more words delimited by dots. Learn more about how to apply it here.

Valid key format examples: 'nasdaq.ibm', 'dept.inventory.bolts'.

There are two important special cases to define keys:

*(star) can be substituted for exactly one word
#(hash) can be substituted for zero or more words

String

Default: All

Constraints: Any number of dot separated words to a limit of 255 bytes

false

### **Routing example** This example will subscribe to all events that match the first component of the key `'NASDAQ'` ```yaml rabbitConsumer: ... routing: keys: - NASDAQ.# ``` ## Additional resources Further AMQP resources can be found on the following links: * Official [RabbitMQ documentation](https://www.rabbitmq.com/documentation.html) * CloudAMQP [documentation](https://www.cloudamqp.com/docs/index.html) --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.fractalworks.io/joule/components/connectors/sources/rabbitmq.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.