-
- All Superinterfaces:
- AutoCloseable
public interface QueueBrowser extends AutoCloseable
A client uses aQueueBrowser
object to look at messages on a queue without removing them.The
getEnumeration
method returns ajava.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 aSession
or aQueueSession
.- Since:
- JMS 1.0
- Version:
- JMS 2.0
- See Also:
Session.createBrowser(javax.jms.Queue)
,QueueSession.createBrowser(javax.jms.Queue)
,QueueReceiver
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description void
close()
Closes theQueueBrowser
.Enumeration
getEnumeration()
Gets an enumeration for browsing the current queue messages in the order they would be received.String
getMessageSelector()
Gets this queue browser's message selector expression.Queue
getQueue()
Gets the queue associated with this queue browser.
-
-
-
Method Detail
-
getQueue
Queue getQueue() throws JMSException
Gets the queue associated with this queue browser.- Returns:
- the queue
- Throws:
JMSException
- if the JMS provider fails to get the queue associated with this browser due to some internal error.
-
getMessageSelector
String getMessageSelector() throws JMSException
Gets this queue browser's message selector expression.- 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)
- Throws:
JMSException
- if the JMS provider fails to get the message selector for this browser due to some internal error.
-
getEnumeration
Enumeration getEnumeration() throws JMSException
Gets an enumeration for browsing the current queue messages in the order they would be received.- Returns:
- an enumeration for browsing the messages
- Throws:
JMSException
- if the JMS provider fails to get the enumeration for this browser due to some internal error.
-
close
void close() throws JMSException
Closes theQueueBrowser
.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.
- Specified by:
close
in interfaceAutoCloseable
- Throws:
JMSException
- if the JMS provider fails to close this browser due to some internal error.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/08/2025 17:22:02 Cette version de la page est en cache (à la date du 21/08/2025 17:22:02) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 14/04/2008, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/jms/queuebrowser.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.