org.transitime.monitoring

Class MonitorBase

java.lang.Object

org.transitime.monitoring.MonitorBase

Direct Known Subclasses:

AvlFeedMonitor, DatabaseMonitor, DatabaseQueueMonitor, PredictabilityMonitor, SystemCpuMonitor, SystemDiskSpaceMonitor, SystemMemoryMonitor

public abstract class MonitorBase
extends java.lang.Object

Base class for doing monitoring. If event is first triggered then an ERROR email is sent out. If not triggered anymore then an OK email is sent.

Author:

SkiBu Smith

Constructor Summary

Constructors

Constructor and Description
MonitorBase(EmailSender emailSender, java.lang.String agencyId) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	checkAndNotify() Checks the monitor object to see if state has changed currently triggered.
java.lang.String	getMessage() Returns any message from the last time monitoring was checked.
static java.lang.String	recipientsGlobal() Returns comma separated list of who should be notified via e-mail when trigger state changes for the monitor.

Methods inherited from class java.lang.Object

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

Constructor Detail

MonitorBase

public MonitorBase(EmailSender emailSender,
                   java.lang.String agencyId)

Constructor.

Parameters:

emailSender - For sending out e-mails when monitor triggered or untriggered

agencyId - Identifies agency

Method Detail

checkAndNotify

public boolean checkAndNotify()

Checks the monitor object to see if state has changed currently triggered. If state changes then sends out notification e-mail.

Returns:

True if monitor currently triggered

getMessage

public java.lang.String getMessage()

Returns any message from the last time monitoring was checked. If secondary message is set (not null) then it is added to the message.

Returns:

Message describing situation. Should be set whether or not monitor is currently triggered so can also provide an OK message.

recipientsGlobal

public static java.lang.String recipientsGlobal()

Returns comma separated list of who should be notified via e-mail when trigger state changes for the monitor. Specified by the Java property transitime.monitoring.emailRecipients . A static class so cannot be overwritten.

Returns:

E-mail addresses of who to notify