com.ibm.retail.AEF.mgmt
Interface EventQueueMBean


public interface EventQueueMBean

Specifies the management interface for the AEFEventQueue object.

The AEFEventQueue is a dispatch queue for AEF POSDataProvider events. When property changes occur, an event is put on the queue representing that property change. This event is processed by notifying all registered listeners for that particular property.

Certain statistical information is kept by the AEFEventQueue such as maximum queue length, average/max wait time for elements on the queue, etc. The purpose of this MBean is to expose this information.

The ObjectName of this MBean includes the following attributes, in addition to the SIF attributes of StoreID and DeviceID:

This management interface includes the following attributes. These attributes are described in more detail in the accessor methods. A marker is used internally by the AEFEventQueue to synchronize requests for data with pending requests that may cause changes in the data being requested. The following operations are included in this management interface. These are described in more detail in the corresponding method documentation. No notifications are generated by any classes that implement this management interface.


Method Summary
 java.lang.Object[] getAllPerformanceStatistics()
          Retrieve the current performance statistics associated with this EventQueue.
 double getAverageMarkerWait()
          Retrieve the average amount of time that a marker has had to wait before being processed by this EventQueue, since the last reset.
 double getAverageProcessTime()
          Retrieve the average amount of time needed to process a request, since the last reset.
 double getAverageQueueWait()
          Retrieve the average amount of time that a request has had to wait before being processed by this EventQueue, since the last reset.
 int getCurrentQueueLength()
          Retrieve the current number of requests waiting to be processed by this EventQueue.
 long getMaximumMarkerWait()
          Retrieve the maximum amount of time that a marker has had to wait before being processed by this EventQueue, since the last reset.
 long getMaximumProcessTime()
          Retrieve the maximum amount of time needed to process a request, since the last reset.
 int getMaximumQueueLength()
          Retrieve the maximum number of requests that have ever waiting to be processed by this EventQueue, since the last reset.
 long getMaximumQueueWait()
          Retrieve the maximum amount of time that a request has had to wait before being processed by this EventQueue, since the last reset.
 long getTotalMarkersProcessed()
          Retrieve the total number of markers processed by this EventQueue, since the last reset.
 long getTotalProcessed()
          Retrieve the total number of requests processed by this EventQueue, since the last reset.
 void logStatistics()
          Record all of the performance statistics for this EventQueue to the AEF log.
 void resetStatistics()
          Reset all of the performance statistics for this EventQueue to zero.
 

Method Detail

getAllPerformanceStatistics

public java.lang.Object[] getAllPerformanceStatistics()
Retrieve the current performance statistics associated with this EventQueue. This data is returned as an array of objects as follows. The meaning of the various statistics are described in more detail in the getter method for the specific attribute.

Returns:
performance statistics as described above.

getTotalProcessed

public long getTotalProcessed()
Retrieve the total number of requests processed by this EventQueue, since the last reset. This number includes markers.

Returns:
total number of requests processed since the last reset.

getCurrentQueueLength

public int getCurrentQueueLength()
Retrieve the current number of requests waiting to be processed by this EventQueue. This number includes markers.

Returns:
number of requests waiting to be processed.

getMaximumQueueLength

public int getMaximumQueueLength()
Retrieve the maximum number of requests that have ever waiting to be processed by this EventQueue, since the last reset. This number includes markers.

Returns:
maximum number of requests that have ever been waiting to be processed.

getMaximumQueueWait

public long getMaximumQueueWait()
Retrieve the maximum amount of time that a request has had to wait before being processed by this EventQueue, since the last reset.

Returns:
maximum request wait time in milliseconds.

getMaximumProcessTime

public long getMaximumProcessTime()
Retrieve the maximum amount of time needed to process a request, since the last reset.

Returns:
maximum amount of time needed to process a request in milliseconds.

getAverageQueueWait

public double getAverageQueueWait()
Retrieve the average amount of time that a request has had to wait before being processed by this EventQueue, since the last reset.

Returns:
average request wait time in milliseconds.

getAverageProcessTime

public double getAverageProcessTime()
Retrieve the average amount of time needed to process a request, since the last reset.

Returns:
average amount of time needed to process a request in milliseconds.

getTotalMarkersProcessed

public long getTotalMarkersProcessed()
Retrieve the total number of markers processed by this EventQueue, since the last reset.

Returns:
total number of markers processed since the last reset.

getAverageMarkerWait

public double getAverageMarkerWait()
Retrieve the average amount of time that a marker has had to wait before being processed by this EventQueue, since the last reset.

Returns:
average marker wait time in milliseconds.

getMaximumMarkerWait

public long getMaximumMarkerWait()
Retrieve the maximum amount of time that a marker has had to wait before being processed by this EventQueue, since the last reset.

Returns:
maximum marker wait time in milliseconds.

resetStatistics

public void resetStatistics()
Reset all of the performance statistics for this EventQueue to zero.


logStatistics

public void logStatistics()
Record all of the performance statistics for this EventQueue to the AEF log.



Copyright © 2004 IBM. All Rights Reserved.
Generated: July 19 2004