public class ActiveMQQueueBrowser extends java.lang.Object implements javax.jms.QueueBrowser, java.util.Enumeration
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)
,
QueueBrowser
,
QueueReceiver
Modifier | Constructor and Description |
---|---|
protected |
ActiveMQQueueBrowser(ActiveMQSession session,
ConsumerId consumerId,
ActiveMQDestination destination,
java.lang.String selector,
boolean dispatchAsync)
Constructor for an ActiveMQQueueBrowser - used internally
|
Modifier and Type | Method and Description |
---|---|
void |
close() |
java.util.Enumeration |
getEnumeration()
Gets an enumeration for browsing the current queue messages in the order
they would be received.
|
java.lang.String |
getMessageSelector() |
javax.jms.Queue |
getQueue()
Gets the queue associated with this queue browser.
|
boolean |
hasMoreElements() |
java.lang.Object |
nextElement() |
protected void |
notifyMessageAvailable() |
java.lang.String |
toString() |
protected void |
waitForMessage()
Wait on a semaphore for a fixed amount of time for a message to come in.
|
protected ActiveMQQueueBrowser(ActiveMQSession session, ConsumerId consumerId, ActiveMQDestination destination, java.lang.String selector, boolean dispatchAsync) throws javax.jms.JMSException
theSession
- dest
- selector
- javax.jms.JMSException
public java.util.Enumeration getEnumeration() throws javax.jms.JMSException
getEnumeration
in interface javax.jms.QueueBrowser
javax.jms.JMSException
- if the JMS provider fails to get the enumeration for
this browser due to some internal error.public boolean hasMoreElements()
hasMoreElements
in interface java.util.Enumeration
public java.lang.Object nextElement()
nextElement
in interface java.util.Enumeration
public void close() throws javax.jms.JMSException
close
in interface javax.jms.QueueBrowser
javax.jms.JMSException
public javax.jms.Queue getQueue() throws javax.jms.JMSException
getQueue
in interface javax.jms.QueueBrowser
javax.jms.JMSException
- if the JMS provider fails to get the queue
associated with this browser due to some internal error.public java.lang.String getMessageSelector() throws javax.jms.JMSException
getMessageSelector
in interface javax.jms.QueueBrowser
javax.jms.JMSException
protected void waitForMessage()
javax.jms.JMSException
protected void notifyMessageAvailable()
public java.lang.String toString()
toString
in class java.lang.Object
Copyright © 2005-2017. All Rights Reserved.