QueueBrowser (SwiftMQ Client (Jakarta) 12.5.4 API)

java.lang.Object
- com.swiftmq.swiftlet.queue.event.QueueManagerAdapter
- - com.swiftmq.swiftlet.queue.QueueHandler
  - - com.swiftmq.swiftlet.queue.QueueBrowser

All Implemented Interfaces:

QueueManagerListener, java.util.EventListener
```
public class QueueBrowser
extends QueueHandler
```
A QueueBrowser is created by the QueueManager. It provides a method for browsing queue messages outside a transaction.

Author:

IIT GmbH, Bremen/Germany, Copyright (c) 2000-2002, All Rights Reserved

See Also:

QueueManager.createQueueBrowser(java.lang.String, com.swiftmq.swiftlet.auth.ActiveLogin, com.swiftmq.swiftlet.queue.Selector)

Constructor Summary

Constructors
Constructor Description

QueueBrowser(ActiveQueue activeQueue, Selector selector, EntityList browserEntityList)
Creates a new QueueBrowser

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`	Close the queue browser
`MessageEntry`	`getNextMessage()`	Get the next available message from the queue.
`void`	`resetBrowser()`	Reset the browser.
`void`	`setLastMessageIndex(MessageIndex lastMessageIndex)`

Methods inherited from class com.swiftmq.swiftlet.queue.QueueHandler
getNumberQueueMessages, getQueueName, isClosed, queueStopInitiated, verifyQueueHandlerState

Methods inherited from class com.swiftmq.swiftlet.queue.event.QueueManagerAdapter
queueStarted, queueStartInitiated, queueStopped

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - QueueBrowser
```
public QueueBrowser(ActiveQueue activeQueue,
                    Selector selector,
                    EntityList browserEntityList)
```
    Creates a new QueueBrowser
    
    Parameters:
    
    activeQueue - the active queue
    
    selector - an optional selector
    
    browserEntityList - the browser usage entity list
- Method Detail
  - setLastMessageIndex
```
public void setLastMessageIndex(MessageIndex lastMessageIndex)
```
  - resetBrowser
```
public void resetBrowser()
```
    Reset the browser. It will start at the beginning next time a message is fetched.
  - getNextMessage
```
public MessageEntry getNextMessage()
                            throws QueueException,
                                   QueueHandlerClosedException
```
    Get the next available message from the queue.
    
    Returns:
    
    message or null
    
    Throws:
    
    QueueException - thrown by the queue
    
    QueueHandlerClosedException - if the handler is closed
  - close
```
public void close()
           throws QueueException,
                  QueueHandlerClosedException
```
    Close the queue browser
    
    Overrides:
    
    close in class QueueHandler
    
    Throws:
    
    QueueException - thrown by the queue
    
    QueueHandlerClosedException - if the browser is already closed