COM.activesw.api.client
Class BrokerLockedClientQueueBrowser

java.lang.Object
  COM.activesw.api.client.BrokerClientQueueBrowser
      COM.activesw.api.client.BrokerLockedClientQueueBrowser

public class BrokerLockedClientQueueBrowser
extends BrokerClientQueueBrowser

This class provides queue browsing capabilities to view and modify events of a client queue.

Method Summary

int	deleteEvents(long[] seqns) Delete events in the queue.
void	insertEventsAtHead(BrokerEvent[] events) Insert events in into the queue.
void	insertEventsAtTail(BrokerEvent[] events) Insert events in into the queue.
void	modifyEvents(long[] seqns, BrokerEvent[] events) Modify events in the queue.

Methods inherited from class COM.activesw.api.client.BrokerClientQueueBrowser

browseEvents, closeQueueBrowser, getBrowserInfo, getFilters, resetFilters, setFilter, setFilters, setPosition

Methods inherited from class java.lang.Object

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

Method Detail

modifyEvents

public void modifyEvents(long[] seqns,
                         BrokerEvent[] events)
                  throws BrokerException

Modify events in the queue. The events are identified by the specified receipt sequence numbers for an in-place update in the queue.

Parameters:

seqns - An array of sequence numbers that identify the events to be modified in the queue.

events - An array of BrokerEvent that will be updated in place of the events in the queue.

Throws:

BrokerInvalidClientException - If the client has been destroyed or disconnected.

BrokerClientQueueBrowserException - If the event cannot be modified

BrokerException

deleteEvents

public int deleteEvents(long[] seqns)
                 throws BrokerException

Delete events in the queue. The events are identified by their receipt sequence numbers.

Parameters:

seqns - An array of sequence numbers that identify the events in the queue.

Returns:

The number of events deleted from the queue.

Throws:

BrokerInvalidClientException - If the client has been destroyed or disconnected.

BrokerClientQueueBrowserException - If the event cannot be deleted

BrokerException

insertEventsAtHead

public void insertEventsAtHead(BrokerEvent[] events)
                        throws BrokerException

Insert events in into the queue. The specified events will be inserted at the head of the queue.

Parameters:

events - An array of events to be inserted.

Throws:

BrokerInvalidClientException - If the client has been destroyed or disconnected.

BrokerClientQueueBrowserException - If the event cannot be inserted

BrokerException

insertEventsAtTail

public void insertEventsAtTail(BrokerEvent[] events)
                        throws BrokerException

Insert events in into the queue. The specified events will be inserted at the end of the queue.

Parameters:

events - An array of events to be inserted.

Throws:

BrokerInvalidClientException - If the client has been destroyed or disconnected.

BrokerClientQueueBrowserException - If the event cannot be inserted

BrokerException