Using Forwarding Queue Browser
Forwarding queue browser works in two modes.
1. Administrative Queue Browser - Unlocked Mode. An administrative queue browser allows an administrative client to access the contents of a forwarding queue for a remote Broker at runtime. In the unlocked browse mode the forwarding queue is not locked, meaning that the queue content could change between queue browser operations. In this unlocked mode, queue browsing is the only operation the administrative client can perform. The existence of an administrative queue browser in an unlocked mode does not impact the normal functioning of the forwarding queue.
2. Administrative Queue Browser - Locked Mode. An administrative queue browser allows an administrative client to access the contents of a forwarding queue for a remote Broker at runtime. In this mode, the forwarding queue is locked for the lifetime of the queue browser. You can browse queue contents, delete documents from queue, insert new documents into the queue, and modify documents in the queue.
To invoke a queue browser operation on the forwarding queue, the Broker administrative client must first create a forwarding queue browser using the BrokerAdminClient.createForwardQueueBrowser()method.
To invoke a queue browser operation on the forwarding queue, the Broker administrative client must first create a forwarding queue browser using one of the following methods:
BrokerAdminClient.createForwardQueueBrowser()Broker administrative client creates a queue browser to browse forwarding queue.
BrokerAdminClient.createLockedForwardQueueBrowser() Broker administrative client creates a queue browser to manipulate the contents of a forwarding queue.
This method will return a queue browser that you use to invoke various queue management functions on the queue.
Note:Brokers earlier than version 8.1 do not support the queue browser APIs.
The BrokerQueueBrowserInfo object represents information of a queue browser with data members described in the following table.
Data Member | Description |
String clientId | This member contains the ID of the client or remote Broker on which the queue browser is currently open. |
String browserId | This member contains the ID of the client that created the queue browser. For information on client IDs, see
Using Queue Browsers. |
int browserSessionId | This member contains the session ID of the client that created the queue browser. |
boolean locked | The value is set to true if the client queue is locked by this queue browser; otherwise, false. |
int createTime | This member contains the date and time when the queue browser was created. |