File Doc Category Size Date Package
QueueBrowser.java API Doc Glassfish v2 API 5051 Fri May 04 22:36:16 BST 2007 javax.jms

QueueBrowser

public interface QueueBrowser

A client uses a QueueBrowser object to look at messages on a queue without removing them.

The getEnumeration method returns a java.util.Enumeration that is used to scan the queue's messages. It may be an enumeration of the entire content of a queue, or it may contain only the messages matching a message selector.

Messages may be arriving and expiring while the scan is done. The JMS API does not require the content of an enumeration to be a static snapshot of queue content. Whether these changes are visible or not depends on the JMS provider.

A QueueBrowser can be created from either a Session or a QueueSession.

version: 1.1 April 9, 2002
author: Mark Hapner
author: Rich Burridge
author: Kate Stout
see: javax.jms.Session#createBrowser
see: javax.jms.QueueSession#createBrowser
see: javax.jms.QueueReceiver

Fields Summary
Constructors Summary
Methods Summary
public void close()
Closes the QueueBrowser.
Since a provider may allocate some resources on behalf of a QueueBrowser outside the Java virtual machine, clients should close them when they are not needed. Relying on garbage collection to eventually reclaim these resources may not be timely enough.
exception
JMSException if the JMS provider fails to close this browser due to some internal error.
public java.util.Enumeration getEnumeration()
Gets an enumeration for browsing the current queue messages in the order they would be received.
return
an enumeration for browsing the messages
exception
JMSException if the JMS provider fails to get the enumeration for this browser due to some internal error.
public java.lang.String getMessageSelector()
Gets this queue browser's message selector expression.
return
this queue browser's message selector, or null if no message selector exists for the message consumer (that is, if the message selector was not set or was set to null or the empty string)
exception
JMSException if the JMS provider fails to get the message selector for this browser due to some internal error.
public Queue getQueue()
Gets the queue associated with this queue browser.
return
the queue
exception
JMSException if the JMS provider fails to get the queue associated with this browser due to some internal error.