Using Client Queue Browser

Client queue browser works in three different modes.

1. Client queue browser. A client can open a queue browser on its own queue and browse documents without requiring any administrative privileges. A client queue browser requires a dedicated client session and allows browse operations on the queue from any queue position and exposes all documents in the queue.

2. Administrative Queue Browser - Unlocked Mode. An administrative queue browser allows an administrative client to access the contents of a client queue owned by a different client at runtime. In the unlocked browse mode the client 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 client queue.

3. Administrative Queue Browser - Locked Mode. An administrative queue browser allows an administrative client to access the contents of a client queue owned by a different client at runtime. In this mode, the client 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.

In order to invoke any queue browser operation on a client queue, you must first create a client queue browser using one of the following methods:

BrokerClient.createClientQueueBrowser()

Broker client creates a queue browser to browse its own queue.

BrokerAdminClient.createClientQueueBrowser()

Broker administrative client creates a queue browser to browse another client's queue

BrokerAdminClient.createLockedClientQueueBrowser()

Broker administrative client creates a queue browser to manipulate the contents of another client's queue.

These functions will return a queue browser that can be used to invoke various queue management functions on the client queue.

Note:
Pre-6.5 Brokers do not support the queue browser API. You will receive an error if your client attempts to open a queue browser on pre-6.5 versions of Broker clients.

The BrokerClientQueueBrowserInfo object represents information of a client queue browser with data members described in the following table.

Data Member	Description
String clientId	This member contains the ID of the client on which the queue browser is currently open. For information on client IDs, see Managing Broker Clients.
String browserId	This member contains the ID of the client that created the queue browser. For information on client IDs, see Managing Broker Clients.
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.