|
||||||||||
PREV CLASS (src) NEXT CLASS (src) | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
.
Session.createBrowser(javax.jms.Queue)
,
QueueSession.createBrowser(javax.jms.Queue)
,
QueueReceiver
(src) Method Summary | |
void |
close()
Closes the QueueBrowser . |
java.util.Enumeration |
getEnumeration()
Gets an enumeration for browsing the current queue messages in the order they would be received. |
java.lang.String |
getMessageSelector()
Gets this queue browser's message selector expression. |
Queue (src) |
getQueue()
Gets the queue associated with this queue browser. |
Method Detail |
public Queue (src) getQueue() throws JMSException (src)
JMSException (src)
- if the JMS provider fails to get the
queue associated with this browser
due to some internal error.public java.lang.String getMessageSelector() throws JMSException (src)
JMSException (src)
- if the JMS provider fails to get the
message selector for this browser
due to some internal error.public java.util.Enumeration getEnumeration() throws JMSException (src)
JMSException (src)
- if the JMS provider fails to get the
enumeration for this browser
due to some internal error.public void close() throws JMSException (src)
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.
JMSException (src)
- if the JMS provider fails to close this
browser due to some internal error.
|
||||||||||
PREV CLASS (src) NEXT CLASS (src) | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |