JavaEE API 8.0.1 · javax.jms.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 message must not be returned by a QueueBrowser before its delivery time has been reached.

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

Method Summary

Modifier and Type	Method and Description
public void	close() Redeclares java.lang.AutoCloseable.close. Closes the `QueueBrowser`.
public Enumeration<E>	Returns: an enumeration for browsing the messages getEnumeration() Gets an enumeration for browsing the current queue messages in the order they would be received.
public String	Returns: 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) getMessageSelector() Gets this queue browser's message selector expression.
public Queue	Returns: the queue getQueue() Gets the queue associated with this queue browser.

Method Detail

close back to summary

close	back to summary
public void close() throws JMSException Redeclares java.lang.AutoCloseable.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. Exceptions JMSException: if the JMS provider fails to close this browser due to some internal error.

public void close() throws JMSException

Redeclares java.lang.AutoCloseable.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.

Exceptions

JMSException:: if the JMS provider fails to close this browser due to some internal error.

getEnumeration	back to summary
public Enumeration<E> getEnumeration() throws JMSException Gets an enumeration for browsing the current queue messages in the order they would be received. Returns:Enumeration<E> an enumeration for browsing the messages Exceptions JMSException: if the JMS provider fails to get the enumeration for this browser due to some internal error.

getEnumeration

back to summary

public Enumeration<E> getEnumeration() throws JMSException

Gets an enumeration for browsing the current queue messages in the order they would be received.

Returns:Enumeration<E>

an enumeration for browsing the messages

Exceptions

JMSException:: if the JMS provider fails to get the enumeration for this browser due to some internal error.

getMessageSelector	back to summary
public String getMessageSelector() throws JMSException Gets this queue browser's message selector expression. Returns:String 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) Exceptions JMSException: if the JMS provider fails to get the message selector for this browser due to some internal error.

getMessageSelector

back to summary

public String getMessageSelector() throws JMSException

Gets this queue browser's message selector expression.

Returns:String

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)

Exceptions

JMSException:: if the JMS provider fails to get the message selector for this browser due to some internal error.

getQueue	back to summary
public Queue getQueue() throws JMSException Gets the queue associated with this queue browser. Returns:Queue the queue Exceptions JMSException: if the JMS provider fails to get the queue associated with this browser due to some internal error.

getQueue

back to summary

public Queue getQueue() throws JMSException

Gets the queue associated with this queue browser.

Returns:Queue

the queue

Exceptions

JMSException:: if the JMS provider fails to get the queue associated with this browser due to some internal error.

public Interface QueueBrowser

Method Summary

Method Detail