public interface QueueBrowser extends AutoCloseable
QueueBrowserobject to look at messages on a queue without removing them.
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
Messages may be arriving and expiring while the scan is done. The Jakarta Messaging 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 message must not be returned by a
QueueBrowser before its delivery time has been reached.
QueueBrowser can be created from either a
Session or a
|Modifier and Type||Method and Description|
Gets an enumeration for browsing the current queue messages in the order they would be received.
Gets this queue browser's message selector expression.
Gets the queue associated with this queue browser.
Queue getQueue() throws JMSException
JMSException- if the Jakarta Messaging provider fails to get the queue associated with this browser due to some internal error.
String getMessageSelector() throws JMSException
JMSException- if the Jakarta Messaging provider fails to get the message selector for this browser due to some internal error.
Enumeration getEnumeration() throws JMSException
JMSException- if the Jakarta Messaging provider fails to get the enumeration for this browser due to some internal error.
void close() throws JMSException
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.
Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.