Class RabbitManagementAdapter

java.lang.Object

com.kingsrook.qqq.esb.management.RabbitManagementAdapter

All Implemented Interfaces:

EsbBrokerAdapter

public class RabbitManagementAdapter
extends Object
implements EsbBrokerAdapter

Broker adapter for RabbitMQ: queue info and purge through the management plugin's HTTP API, on the provider's managementUrl (e.g., http://host:15672). RabbitMQ can't pause a queue, or delete or move selected messages, so those throw UnsupportedOperationException (pausing QQQ's own consumers, via the trigger controls, covers QQQ's side). The vhost is the one in the provider's AMQP url, as the JMS client reads it: the url's path, less its leading slash, decoded; no path (or just a slash) is the default vhost, "/".

Field Summary

Fields

Modifier and Type	Field	Description
static final EsbBrokerCapabilities	CAPABILITIES

Constructor Summary

Constructors

Constructor	Description
RabbitManagementAdapter(QEsbProviderMetaData provider)	Constructor - for a provider with a managementUrl.

Method Summary

Modifier and Type	Method	Description
EsbBrokerCapabilities	capabilities()	The actions this adapter's broker supports.
int	deleteMessages(String brokerQueueName, List<String> messageIds)	Not supported by RabbitMQ.
int	deleteMessagesOlderThan(String brokerQueueName, Instant cutoff)	Not supported by RabbitMQ.
Optional<EsbQueueInfo>	getQueueInfo(String brokerQueueName)	GET /api/queues/VHOST/NAME: its messages (ready plus unacknowledged) and consumers.
int	moveMessages(String brokerQueueName, List<String> messageIds, String toBrokerQueueName)	Not supported by RabbitMQ.
void	pauseQueue(String brokerQueueName)	Not supported by RabbitMQ.
long	purgeQueue(String brokerQueueName)	DELETE /api/queues/VHOST/NAME/contents.
void	resumeQueue(String brokerQueueName)	Not supported by RabbitMQ.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CAPABILITIES

public static final EsbBrokerCapabilities CAPABILITIES

Constructor Details

RabbitManagementAdapter

public RabbitManagementAdapter(QEsbProviderMetaData provider)

Constructor - for a provider with a managementUrl.

Method Details

capabilities

public EsbBrokerCapabilities capabilities()

Description copied from interface: EsbBrokerAdapter

The actions this adapter's broker supports.

Specified by:

capabilities in interface EsbBrokerAdapter

getQueueInfo

public Optional<EsbQueueInfo> getQueueInfo(String brokerQueueName)
                                    throws QException

GET /api/queues/VHOST/NAME: its messages (ready plus unacknowledged) and consumers. (The API's counts are sampled, so they can lag by a few seconds.)

Specified by:

getQueueInfo in interface EsbBrokerAdapter

Throws:

QException

purgeQueue

public long purgeQueue(String brokerQueueName)
                throws QException

DELETE /api/queues/VHOST/NAME/contents. The API doesn't say how many messages it removed, so this returns how many the queue held just before (from getQueueInfo) - which, like all the API's counts, can lag a little.

Specified by:

purgeQueue in interface EsbBrokerAdapter

Throws:

QException

pauseQueue

public void pauseQueue(String brokerQueueName)

Not supported by RabbitMQ.

Specified by:

pauseQueue in interface EsbBrokerAdapter

resumeQueue

public void resumeQueue(String brokerQueueName)

Not supported by RabbitMQ.

Specified by:

resumeQueue in interface EsbBrokerAdapter

deleteMessages

public int deleteMessages(String brokerQueueName,
 List<String> messageIds)

Not supported by RabbitMQ.

Specified by:

deleteMessages in interface EsbBrokerAdapter

deleteMessagesOlderThan

public int deleteMessagesOlderThan(String brokerQueueName,
 Instant cutoff)

Not supported by RabbitMQ.

Specified by:

deleteMessagesOlderThan in interface EsbBrokerAdapter

moveMessages

public int moveMessages(String brokerQueueName,
 List<String> messageIds,
 String toBrokerQueueName)

Not supported by RabbitMQ.

Specified by:

moveMessages in interface EsbBrokerAdapter