Class EsbMessageBrowser

java.lang.Object

com.kingsrook.qqq.esb.management.EsbMessageBrowser

public final class EsbMessageBrowser
extends Object

Browses the messages on a broker queue (including dead-letter and topic subscription queues) with a JMS QueueBrowser - so on every broker, with or without a management API. Browsing leaves the messages on the queue. Needs a QContext with the provider's instance (it opens a session through EsbConnectionManager).

Field Summary

Fields

Modifier and Type	Field	Description
static final Integer	MAX_LIMIT
static final Integer	MAX_RAW_BODY_LENGTH

Method Summary

Modifier and Type	Method	Description
static List<EsbBrowsedMessage>	browse(String providerName, String brokerQueueName, int offset, int limit)	Up to limit messages from a queue, skipping the first offset (counting from the head of the queue, as the broker orders it).

Methods inherited from class java.lang.Object

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

Field Details

MAX_RAW_BODY_LENGTH

public static final Integer MAX_RAW_BODY_LENGTH

MAX_LIMIT

public static final Integer MAX_LIMIT

Method Details

browse

public static List<EsbBrowsedMessage> browse(String providerName,
 String brokerQueueName,
 int offset,
 int limit)
                                      throws QException

Up to limit messages from a queue, skipping the first offset (counting from the head of the queue, as the broker orders it). Messages being delivered to a consumer at that moment aren't shown. To tell whether there are more after a page, ask for one more than you show. Throws QUserFacingException for a negative offset, or a limit outside 0 to MAX_LIMIT; QException if the provider is unknown, or its broker can't be reached or browsed.

Throws:

QException