org.qbroker.jms

Class JMSHealthChecker

java.lang.Object

org.qbroker.monitor.Monitor

org.qbroker.jms.JMSHealthChecker

All Implemented Interfaces:

MonitorAction, MonitorReport

public class JMSHealthChecker
extends Monitor

HealthCheck checks a JMS destination by putting or publishing a JMS message to it

It sends or publishes a predefined health-check message to the destination to test its message acceptance. The health-check message should be harmless to the applications. Otherwise, you have to disable the auto-commit so that the message will not be committed. If the destination is full or not defined, or not writeable or not available, the health-check will fail.

Author:

yannanlu@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
static int	DST_BROWSE
static int	DST_FAILED
static int	DST_GET
static int	DST_OK
static int	DST_PUB
static int	DST_PUT
static int	DST_SUB
static int	DST_UNKNOWN
static int	DST_UNSUB

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
JMSHealthChecker(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
protected void	finalize()
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.
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

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

DST_UNKNOWN

public static final int DST_UNKNOWN

See Also:

Constant Field Values

DST_FAILED

public static final int DST_FAILED

See Also:

Constant Field Values

DST_OK

public static final int DST_OK

See Also:

Constant Field Values

DST_GET

public static final int DST_GET

See Also:

Constant Field Values

DST_PUT

public static final int DST_PUT

See Also:

Constant Field Values

DST_BROWSE

public static final int DST_BROWSE

See Also:

Constant Field Values

DST_SUB

public static final int DST_SUB

See Also:

Constant Field Values

DST_PUB

public static final int DST_PUB

See Also:

Constant Field Values

DST_UNSUB

public static final int DST_UNSUB

See Also:

Constant Field Values

Constructor Detail

JMSHealthChecker

public JMSHealthChecker(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

finalize

protected void finalize()

Overrides:

finalize in class Monitor