BrokerLockedQueueBrowser and BrokerLockedClientQueueBrowser
Note:BrokerLockedQueueBrowser is the interface for queue browser methods, implementations of which allow you to browse both client queue and forwarding queue. BrokerLockedQueueBrowser interface has two implementations, BrokerLockedClientQueueBrowser for browsing client queues and BrokerLockedForwardQueueBrowser for forwarding queues.
BrokerLockedQueueBrowser extends the BrokerQueueBrowser interface. In addition to browsing the queue, the BrokerLockedQueueBrowser interface allows you to manipulate the contents of the queue.
An application might use the BrokerLockedQueueBrowser interface to perform the following functions on the forwarding queue for a remote Broker, and the client queue.
Obtain a queue lock to manage a client queue.
Browse documents in the locked client's queue.
Modify documents in the locked client's queue.
Insert documents into the locked client's queue.
Delete documents from the locked client's queue.
Set filters for browse and delete operations.
Release an acquired queue lock.
All methods throw BrokerQueueBrowserException (and other exceptions) when necessary.
The additional methods that are available only on BrokerLockedQueueBrowser are listed in the following table.
Method | Description |
modifyEvents | Modify documents in the queue. The documents are identified by the specified receipt sequence numbers for an in-place replacement in the queue. |
deleteEvents | Delete documents in the queue. The documents are identified by the receipt sequence numbers. |
insertEventsAtHead | Insert documents into the queue at head position. |
insertEventsAtTail | Insert documents into the queue at tail position. |
All methods throw BrokerQueueBrowserException (and other exceptions) when necessary.