Packagecom.kaazing.gateway.jms.client
Interfacepublic interface QueueBrowser

A client uses a QueueBrowser object to look at messages on a queue without removing them. Not implemented.

The getEnumeration method returns a MethodEnumeration 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.



Public Properties
 PropertyDefined by
  enumeration : MessageEnumeration
[read-only] Gets an enumeration for browsing the current queue messages in the order they would be received.
QueueBrowser
  messageSelector : String
[read-only] Gets this queue browser's message selector expression.
QueueBrowser
  queue : Queue
[read-only] Gets the queue associated with this queue browser.
QueueBrowser
Public Methods
 MethodDefined by
  
close():void
Closes the QueueBrowser.
QueueBrowser
Property detail
enumerationproperty
enumeration:MessageEnumeration  [read-only]

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

Implementation
    public function get enumeration():MessageEnumeration
messageSelectorproperty 
messageSelector:String  [read-only]

Gets this queue browser's message selector expression.

Implementation
    public function get messageSelector():String
queueproperty 
queue:Queue  [read-only]

Gets the queue associated with this queue browser.

Implementation
    public function get queue():Queue
Method detail
close()method
public function close():void

Closes the QueueBrowser.

Since a provider may allocate some resources on behalf of a QueueBrowser outside the immediate environment, clients should close them when they are not needed. Relying on garbage collection to eventually reclaim these resources may not be timely enough.