Package COM.activesw.api.client

Class BrokerLockedClientQueueBrowser

java.lang.Object
COM.activesw.api.client.BrokerQueueBrowserImpl
COM.activesw.api.client.BrokerClientQueueBrowser
COM.activesw.api.client.BrokerLockedClientQueueBrowser
All Implemented Interfaces:
BrokerLockedQueueBrowser, BrokerQueueBrowser
public class BrokerLockedClientQueueBrowser extends BrokerClientQueueBrowser implements BrokerLockedQueueBrowser
This class provides queue browsing capabilities to view and modify events of a client queue.

  • Method Details

    • 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.
      Specified by:
      modifyEvents in interface BrokerLockedQueueBrowser
      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.
      BrokerQueueBrowserException - If the event cannot be modified
      BrokerInvalidClientException - If the client has been destroyed or disconnected.
      BrokerQueueBrowserException - 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.
      Specified by:
      deleteEvents in interface BrokerLockedQueueBrowser
      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.
      BrokerQueueBrowserException - If the event cannot be deleted
      BrokerInvalidClientException - If the client has been destroyed or disconnected.
      BrokerQueueBrowserException - 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.
      Specified by:
      insertEventsAtHead in interface BrokerLockedQueueBrowser
      Parameters:
      events - An array of events to be inserted.
      Throws:
      BrokerInvalidClientException - If the client has been destroyed or disconnected.
      BrokerQueueBrowserException - If the event cannot be inserted
      BrokerInvalidClientException - If the client has been destroyed or disconnected.
      BrokerQueueBrowserException - 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.
      Specified by:
      insertEventsAtTail in interface BrokerLockedQueueBrowser
      Parameters:
      events - An array of events to be inserted.
      Throws:
      BrokerInvalidClientException - If the client has been destroyed or disconnected.
      BrokerQueueBrowserException - If the event cannot be inserted
      BrokerInvalidClientException - If the client has been destroyed or disconnected.
      BrokerQueueBrowserException - If the event cannot be inserted
      BrokerException