COM.activesw.api.client
Class BrokerClientQueueLock

java.lang.Object
  COM.activesw.api.client.BrokerClientQueueLock

public class BrokerClientQueueLock
extends java.lang.Object

This class gives you access to all the functions with which you can manipulate the queue.

Constructor Summary

BrokerClientQueueLock(BrokerAdminClient client, java.lang.String target_client_id)
Dropped.

Method Summary

int	deleteEvents(int from_index, int max_events) Dropped.
int	deleteEvents(long[] seqns) Dropped.
BrokerFilter[]	getFilter() Dropped.
BrokerDate	getLockAcquiredTime() Dropped.
java.lang.String	getLockedClientId() Dropped.
java.lang.String	getLockingClientId() Dropped.
int	getLockingSessionId() Dropped.
void	insertEvents(int at_index, BrokerEvent[] events) Dropped.
boolean	isAcquired() Dropped.
BrokerEvent[]	peekAllEvents(int from_index, int max_events, int max_sec) Dropped.
BrokerEvent[]	peekEvents(int from_index, int max_events, int max_sec) Dropped.
boolean	releaseLock() Dropped.
void	setFilter(java.lang.String event_type_name, java.lang.String filter_expr) Dropped.
void	setFilters(BrokerFilter[] filters) Dropped.

Methods inherited from class java.lang.Object

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

Constructor Detail

BrokerClientQueueLock

public BrokerClientQueueLock(BrokerAdminClient client,
                             java.lang.String target_client_id)
                      throws BrokerException

Dropped. Support for the queue manipulation feature is dropped and replaced by the queue browser feature in API version 6.5 Creates a client queue object that can be used by a client to perform operations on the specified queue.

Parameters:

client - the admin client that will do work

target_id - id of the client whose queue needs to be locked

Throws:

BrokerNotImplementedException

BrokerException

Method Detail

releaseLock

public boolean releaseLock()
                    throws BrokerException

Dropped. Support for the queue manipulation feature is dropped and replaced by the queue browser feature in API version 6.5 Releases the lock on the queue. The lock has to have been set to do this operation. Once the lock is released none of the queue operations will be possible on the queue. A new lock has to be acquired to do the functions. Returns true if successful and sets the acquired flag to false.

Throws:

BrokerNotImplementedException

BrokerException

peekEvents

public BrokerEvent[] peekEvents(int from_index,
                                int max_events,
                                int max_sec)
                         throws BrokerException

Dropped. Support for the queue manipulation feature is dropped and replaced by the queue browser feature in API version 6.5 Get max_list of events from the queue starting from the from_index The lock has to be acquired to do this operation. The from_index will be the index of the deliverable event in the queue and not from the beginning. Returns the list of BrokerEvents[] starting from the from_index.

Parameters:

from_index - list of events starting from this index

max_event - user requests this many events

Throws:

BrokerNotImplementedException

BrokerException

peekAllEvents

public BrokerEvent[] peekAllEvents(int from_index,
                                   int max_events,
                                   int max_sec)
                            throws BrokerException

Dropped. Support for the queue manipulation feature is dropped and replaced by the queue browser feature in API version 6.5 Get max_list of events from the queue starting from the from_index. Consider all events (including unacked) for the peek result. The lock has to be acquired to do this operation. The from_index will be the index of the deliverable event in the queue and not from the beginning. Returns the list of BrokerEvents[] starting from the from_index.

Parameters:

from_index - list of events starting from this index

max_event - user requests this many events

Throws:

BrokerNotImplementedException

BrokerException

deleteEvents

public int deleteEvents(int from_index,
                        int max_events)
                 throws BrokerException

Dropped. Support for the queue manipulation feature is dropped and replaced by the queue browser feature in API version 6.5 Delete num_events starting from the from_index from the deliverable events in the queue. The lock has to have been acquired to do this operation. Returns the number actually deleted. All of the requested might not be deleted.

Parameters:

from_index - The deliverable event's index in the queue .

max_events - The maximum number of events to be deleted.

Throws:

BrokerNotImplementedException

BrokerException

deleteEvents

public int deleteEvents(long[] seqns)
                 throws BrokerException

Dropped. Support for the queue manipulation feature is dropped and replaced by the queue browser feature in API version 6.5 Delete events with the specified receipt sequence numbers from the queue. The lock has to have been acquired to do this operation. Returns the number actually deleted.

Parameters:

from_index - The deliverable event's index in the queue .

max_events - The maximum number of events to be deleted.

Throws:

BrokerNotImplementedException

BrokerException

insertEvents

public void insertEvents(int at_index,
                         BrokerEvent[] events)
                  throws BrokerException

Dropped. Support for the queue manipulation feature is dropped and replaced by the queue browser feature in API version 6.5 The list of "events" given will be inserted in the queue starting from the "at_index" as deliverable events. The lock has to acquired to do this operation.

Parameters:

at_index - The position at which the given events need to be inserted in the deliverable events list in the queue

events - The events list that need to be inserted.

Throws:

BrokerNotImplementedException

BrokerException

setFilter

public void setFilter(java.lang.String event_type_name,
                      java.lang.String filter_expr)
               throws BrokerException

Dropped. Support for the queue manipulation feature is dropped and replaced by the queue browser feature in API version 6.5 sets the given filter, "filter_expr", on the deliverable event, "event_type_name" in the queue. The lock has to have been acquired to do this operation. Once the filter is set all the queue operations will be done based on the filter string. If a filter is already set the new filter will be added to the existing conditions. It is OK for event type name and filter_expr to be null. If event type name and filter_expr is null, the filter is reset.

Parameters:

event_type_name - The event on which the filter has to be set

filter_expr - The filter string

Throws:

BrokerNotImplementedException

BrokerException

setFilters

public void setFilters(BrokerFilter[] filters)
                throws BrokerException

Dropped. Support for the queue manipulation feature is dropped and replaced by the queue browser feature in API version 6.5 Set up filters for client queue operations. Once the filters are set on the locked client queue, only the the results that matches the filters will be affected in future queue operations. If the client queue already has filter setup, the new filters will be added to the list. Each filter should be on a different event. If you have filters on the same event, the last filter will be considered and the previous filters are discarded.

Parameters:

filters - array of BrokerFilters that need to be set on events in the queue that has been locked.

Throws:

BrokerNotImplementedException

BrokerException

getFilter

public BrokerFilter[] getFilter()
                         throws BrokerException

Dropped. Support for the queue manipulation feature is dropped and replaced by the queue browser feature in API version 6.5 Gets filters set on the client queue . Once the filters are set on the locked client queue, only the results that matches the filters are affected by the queue manipulations. returns array of BrokerFilters that are set on events in queue

Parameters:

lock_id - id of the locked queue

Throws:

BrokerNotImplementedException

BrokerException

getLockingClientId

public java.lang.String getLockingClientId()

Dropped. Support for the queue manipulation feature is dropped and replaced by the queue browser feature in API version 6.5 Returns the identifier of the admin client holding the lock.

getLockedClientId

public java.lang.String getLockedClientId()

Dropped. Support for the queue manipulation feature is dropped and replaced by the queue browser feature in API version 6.5 Returns the identifier of the client locked for queue manipulation.

getLockingSessionId

public int getLockingSessionId()

Dropped. Support for the queue manipulation feature is dropped and replaced by the queue browser feature in API version 6.5 Returns the session identifier of the admin client holding the lock

getLockAcquiredTime

public BrokerDate getLockAcquiredTime()

Dropped. Support for the queue manipulation feature is dropped and replaced by the queue browser feature in API version 6.5 Returns the time-stamp when the lock was acquired

isAcquired

public boolean isAcquired()

Dropped. Support for the queue manipulation feature is dropped and replaced by the queue browser feature in API version 6.5 Returns status of the queue - locked or not