Package COM.activesw.api.client

Class BrokerQueueBrowserImpl

java.lang.Object

COM.activesw.api.client.BrokerQueueBrowserImpl

All Implemented Interfaces:

BrokerQueueBrowser

Direct Known Subclasses:

BrokerClientQueueBrowser, BrokerForwardQueueBrowser, BrokerLockedQueueBrowserUtil

public abstract class BrokerQueueBrowserImpl
extends java.lang.Object
implements BrokerQueueBrowser

This class provides queue browsing capabilities to view events from client queue.

Field Summary

Fields

Modifier and Type	Field	Description
protected BrokerClient	client
protected BrokerQueueBrowserInfo	info

Constructor Summary

Constructors

Constructor	Description
BrokerQueueBrowserImpl()

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.
protected abstract BrokerException	createException(BrokerQueueBrowserException ex)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

info

protected BrokerQueueBrowserInfo info

client

protected BrokerClient client

Constructor Detail

BrokerQueueBrowserImpl

public BrokerQueueBrowserImpl()

Method Detail

getBrowserInfo

public BrokerQueueBrowserInfo getBrowserInfo()
                                      throws BrokerException

Description copied from interface: BrokerQueueBrowser

Get information on the current queue browser.

Specified by:

getBrowserInfo in interface BrokerQueueBrowser

Returns:

BrokerQueueBrowserInfo object

Throws:

BrokerException

setPosition

public void setPosition(int position)
                 throws BrokerException

Description copied from interface: BrokerQueueBrowser

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

Specified by:

setPosition in interface BrokerQueueBrowser

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

public void setFilter(BrokerFilterDescriptor filter)
               throws BrokerException

Description copied from interface: BrokerQueueBrowser

Set filter for queue browser's browse operation.

Specified by:

setFilter in interface BrokerQueueBrowser

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

public void setFilters(BrokerFilterDescriptor[] filters)
                throws BrokerException

Description copied from interface: BrokerQueueBrowser

Set filters for queue browser's browse operation.

Specified by:

setFilters in interface BrokerQueueBrowser

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

public void resetFilters()
                  throws BrokerException

Description copied from interface: BrokerQueueBrowser

Remove all existing filters on the queue browser.

Specified by:

resetFilters in interface BrokerQueueBrowser

Throws:

BrokerException

getFilters

public BrokerFilterDescriptor[] getFilters()
                                    throws BrokerException

Description copied from interface: BrokerQueueBrowser

Get the current filters set on the queue browser.

Specified by:

getFilters in interface BrokerQueueBrowser

Returns:

Array of BrokerFilterDescriptor

Throws:

BrokerException

browseEvents

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

Description copied from interface: BrokerQueueBrowser

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.

Specified by:

browseEvents in interface BrokerQueueBrowser

Throws:

BrokerInvalidClientException - If the client has been destroyed or disconnected.

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

BrokerException

closeQueueBrowser

public void closeQueueBrowser()
                       throws BrokerException

Description copied from interface: BrokerQueueBrowser

Close the current queue browser object.

Specified by:

closeQueueBrowser in interface BrokerQueueBrowser

Throws:

BrokerException

createException

protected abstract BrokerException createException(BrokerQueueBrowserException ex)