Package COM.activesw.api.client

Interface BrokerQueueBrowser

All Known Subinterfaces:

BrokerLockedQueueBrowser

All Known Implementing Classes:

BrokerClientQueueBrowser, BrokerForwardQueueBrowser, BrokerLockedClientQueueBrowser, BrokerLockedForwardQueueBrowser, BrokerLockedQueueBrowserUtil, BrokerQueueBrowserImpl

public interface BrokerQueueBrowser

Method Summary

Modifier and Type	Method	Description
BrokerEvent[]	browseEvents(int max_events, int msecs)	Browse one or more events from the queue.
void	closeQueueBrowser()	Close the current queue browser object.
BrokerQueueBrowserInfo	getBrowserInfo()	Get information on the current queue browser.
BrokerFilterDescriptor[]	getFilters()	Get the current filters set on the queue browser.
void	resetFilters()	Remove all existing filters on the queue browser.
void	setFilter(BrokerFilterDescriptor filter)	Set filter for queue browser's browse operation.
void	setFilters(BrokerFilterDescriptor[] filters)	Set filters for queue browser's browse operation.
void	setPosition(int position)	Set the browse cursor to the specified position on the queue.

Method Detail

getBrowserInfo

BrokerQueueBrowserInfo getBrowserInfo()
                               throws BrokerException

Get information on the current queue browser.

Returns:

BrokerQueueBrowserInfo object

Throws:

BrokerException

setPosition

void setPosition(int position)
          throws BrokerException

Set the browse cursor to the specified position on the queue.

Parameters:

position - The queue position to set

Throws:

BrokerInvalidClientException - If the client has been destroyed or disconnected.

BrokerQueueBrowserException - If the position is out of bounds or the queue is exhausted.

BrokerException

setFilter

void setFilter(BrokerFilterDescriptor filter)
        throws BrokerException

Set filter for queue browser's browse operation.

Throws:

BrokerNullParameterException - If description is null.

BrokerUnknownEventTypeException - If no events exist in the specified scope on the broker.

BrokerInvalidFilterException - If the specified filter expression is invalid.

BrokerException

setFilters

void setFilters(BrokerFilterDescriptor[] filters)
         throws BrokerException

Set filters for queue browser's browse operation.

Throws:

BrokerNullParameterException - If description is null.

BrokerUnknownEventTypeException - If no events exist in the specified scope on the broker.

BrokerInvalidFilterException - If the specified filter expression is invalid.

BrokerException

resetFilters

void resetFilters()
           throws BrokerException

Remove all existing filters on the queue browser.

Throws:

BrokerException

getFilters

BrokerFilterDescriptor[] getFilters()
                             throws BrokerException

Get the current filters set on the queue browser.

Returns:

Array of BrokerFilterDescriptor

Throws:

BrokerException

browseEvents

BrokerEvent[] browseEvents(int max_events,
                           int msecs)
                    throws BrokerException

Browse one or more events from the queue. Returns immediately with either events, or an error if the end of of the queue is reached. The number of events being returned is not guaranteed to be 'max_events' even if there are more than than many events in the client's queue. Any number of events up to the value of 'max_events' may be returned. In addition to the listed exceptions, any communications exception can be thrown.

Throws:

BrokerInvalidClientException - If the client has been destroyed or disconnected.

BrokerTimeoutException - If the timeout is reached before any events arrive.

BrokerException

closeQueueBrowser

void closeQueueBrowser()
                throws BrokerException

Close the current queue browser object.

Throws:

BrokerException