Package org.apache.activemq
Class ActiveMQQueueBrowser
java.lang.Object
org.apache.activemq.ActiveMQQueueBrowser
- All Implemented Interfaces:
jakarta.jms.QueueBrowser
,AutoCloseable
,Enumeration
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
.
- See Also:
-
Session.createBrowser(jakarta.jms.Queue)
QueueSession.createBrowser(jakarta.jms.Queue)
QueueBrowser
QueueReceiver
-
Constructor Summary
ModifierConstructorDescriptionprotected
ActiveMQQueueBrowser
(ActiveMQSession session, ConsumerId consumerId, ActiveMQDestination destination, String selector, boolean dispatchAsync) Constructor for an ActiveMQQueueBrowser - used internally -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Gets an enumeration for browsing the current queue messages in the order they would be received.jakarta.jms.Queue
getQueue()
Gets the queue associated with this queue browser.boolean
protected void
toString()
protected void
Wait on a semaphore for a fixed amount of time for a message to come in.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Enumeration
asIterator
-
Constructor Details
-
ActiveMQQueueBrowser
protected ActiveMQQueueBrowser(ActiveMQSession session, ConsumerId consumerId, ActiveMQDestination destination, String selector, boolean dispatchAsync) throws jakarta.jms.JMSException Constructor for an ActiveMQQueueBrowser - used internally- Throws:
jakarta.jms.JMSException
-
-
Method Details
-
getEnumeration
Gets an enumeration for browsing the current queue messages in the order they would be received.- Specified by:
getEnumeration
in interfacejakarta.jms.QueueBrowser
- Returns:
- an enumeration for browsing the messages
- Throws:
jakarta.jms.JMSException
- if the JMS provider fails to get the enumeration for this browser due to some internal error.
-
hasMoreElements
public boolean hasMoreElements()- Specified by:
hasMoreElements
in interfaceEnumeration
- Returns:
- true if more messages to process
-
nextElement
- Specified by:
nextElement
in interfaceEnumeration
- Returns:
- the next message
-
close
public void close() throws jakarta.jms.JMSException- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfacejakarta.jms.QueueBrowser
- Throws:
jakarta.jms.JMSException
-
getQueue
public jakarta.jms.Queue getQueue() throws jakarta.jms.JMSExceptionGets the queue associated with this queue browser.- Specified by:
getQueue
in interfacejakarta.jms.QueueBrowser
- Returns:
- the queue
- Throws:
jakarta.jms.JMSException
- if the JMS provider fails to get the queue associated with this browser due to some internal error.
-
getMessageSelector
- Specified by:
getMessageSelector
in interfacejakarta.jms.QueueBrowser
- Throws:
jakarta.jms.JMSException
-
waitForMessage
protected void waitForMessage()Wait on a semaphore for a fixed amount of time for a message to come in.- Throws:
jakarta.jms.JMSException
-
notifyMessageAvailable
protected void notifyMessageAvailable() -
toString
-