org.qbroker.wmq

Class QueueMonitor

java.lang.Object

org.qbroker.monitor.Monitor

org.qbroker.wmq.QueueMonitor

All Implemented Interfaces:

MonitorAction, MonitorReport

public class QueueMonitor
extends Monitor

QueueMonitor monitors an MQSeries queue object for queue depth and status

If ResetQStats is set true and StatsLog is set, it will reset Queue stats on the queue and log the enq/deq counts and hiDepth. The reset will have qmgr reset counters on the queue. So there should be only one monitor to reset the stats on the same queue. Otherwise, the stats returned by the call will not be correct.

It supports SecurityExit in case it is required on the server side. You can specify the username and password if SecurityExit is defined.

Author:

yannanlu@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
static int[]	qAttrs

Fields inherited from class org.qbroker.monitor.Monitor

actionCount, actionGroup, aPatternGroup, cachedSkip, category, dependencyGroup, description, disabledWithReport, disableMode, exceptionCount, exceptionTolerance, FILE_SEPARATOR, formatText, keyList, maxPage, maxRetry, name, normalStep, pm, previousStatus, repeatPeriod, report, reportMode, reportName, resolution, serialNumber, site, skip, statsLogger, statusOffset, statusText, step, template, timeFormat, timeTemplate, tolerance, type, xPatternGroup

Fields inherited from interface org.qbroker.monitor.MonitorReport

DISABLED, EXCEPTION, NOSKIP, REPORT_CACHED, REPORT_CLUSTER, REPORT_FINAL, REPORT_FLOW, REPORT_LOCAL, REPORT_NODE, REPORT_NONE, REPORT_SHARED, SKIPPED

Constructor Summary

Constructors

Constructor and Description
QueueMonitor(java.util.Map props)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	checkpoint() returns the checkpoint Map for the action
void	destroy() closes and releases all opened resources
java.util.Map<java.lang.String,java.lang.Object>	generateReport(long currentTime) generates a report on a monitored entity and returns it as a Map.
static void	main(java.lang.String[] args)
Event	performAction(int status, long currentTime, java.util.Map<java.lang.String,java.lang.Object> latest) examines the report on the monitored entity and reacts to it as an action
void	restoreFromCheckpoint(java.util.Map<java.lang.String,java.lang.Object> chkpt) restores the state of the action from the checkpoint Map

Methods inherited from class org.qbroker.monitor.Monitor

finalize, getName, getReportKeys, getReportMode, getReportName, getSkippingStatus, initTimeTemplate, updateContent

Methods inherited from class java.lang.Object

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

Field Detail

qAttrs

public static int[] qAttrs

Constructor Detail

QueueMonitor

public QueueMonitor(java.util.Map props)

Method Detail

generateReport

public java.util.Map<java.lang.String,java.lang.Object> generateReport(long currentTime)
                                                                throws java.io.IOException

Description copied from interface: MonitorReport

generates a report on a monitored entity and returns it as a Map. The report Map will be passed to the associated MonitorAction as an opaque object. The action object is supposed to know how to retrieve the information from the report Map.

Specified by:

generateReport in interface MonitorReport

Specified by:

generateReport in class Monitor

Throws:

java.io.IOException

performAction

public Event performAction(int status,
                           long currentTime,
                           java.util.Map<java.lang.String,java.lang.Object> latest)

Description copied from interface: MonitorAction

examines the report on the monitored entity and reacts to it as an action

Specified by:

performAction in interface MonitorAction

Specified by:

performAction in class Monitor

checkpoint

public java.util.Map<java.lang.String,java.lang.Object> checkpoint()

Description copied from interface: MonitorAction

returns the checkpoint Map for the action

Specified by:

checkpoint in interface MonitorAction

Overrides:

checkpoint in class Monitor

restoreFromCheckpoint

public void restoreFromCheckpoint(java.util.Map<java.lang.String,java.lang.Object> chkpt)

Description copied from interface: MonitorAction

restores the state of the action from the checkpoint Map

Specified by:

restoreFromCheckpoint in interface MonitorAction

Overrides:

restoreFromCheckpoint in class Monitor

destroy

public void destroy()

Description copied from interface: MonitorReport

closes and releases all opened resources

Specified by:

destroy in interface MonitorReport

Overrides:

destroy in class Monitor

main

public static void main(java.lang.String[] args)