com.extrememessaging.ResponseMaster.monitor

Class CMonitorBase

java.lang.Object

com.extrememessaging.ResponseMaster.monitor.CMonitorBase

All Implemented Interfaces:

IConfigurableItem, IMonitor

Direct Known Subclasses:

CLogger, DBLogger, EmailMonitor, MonitorLog4j

public class CMonitorBase
extends java.lang.Object
implements IMonitor

Derive from this class if you want to implement a monitor class that implements only a small subset of the functions

Constructor Summary

Constructors

Constructor and Description
CMonitorBase()

Method Summary

Modifier and Type	Method and Description
void	CategoryDefinitionsLoaded() The category definition file finished loading New in build 595.
void	Initialize(java.lang.String parameter) Initialize using the parameter from the config file.
void	LogError(java.lang.String sMessage) Log an error
void	LogError(java.lang.String sMessage, java.lang.Throwable e) Log an error from a Throwable Changed to Throwable (from Exception) and overload with Error was removed in build 606
static int	LoggingLevelFromString(java.lang.String value)
static java.lang.String	LoggingLevelNameFromValue(int value)
void	LogSystem(java.lang.String sMessage) Log a system message
void	LogTrace(java.lang.String sMessage) Log a tracing message If the logging level is Errors or Warnings, this doesn't do anything
void	LogTrace(java.lang.String sMessage, java.lang.Throwable e) Log a tracing message from a Throwable If the logging level is Errors or Warnings, this doesn't do anything Changed to Throwable (from Exception) in build 606
void	LogWarning(java.lang.String sMessage) Log a warning If the logging level is Errors, this doesn't do anything
void	LogWarning(java.lang.String sMessage, java.lang.Throwable e) Log a warning from a Throwable If the logging level is Errors, this doesn't do anything Changed to Throwable (from Exception) in build 606
void	MailboxEmpty(java.lang.String sMailboxName) This is fired every time we check the mailbox for messages, and we find that it is empty.
void	MailboxInitializationBegun(java.lang.String sMailboxName) The mailbox initialization process started for a particular mailbox New in build 627
void	MailboxInitializationFinished(java.lang.String sMailboxName) The mailbox initialization process completed for a particular mailbox New in build 627
void	MailboxShutdownBegun(java.lang.String sMailboxName) The mailbox shutdown process began for a particular mailbox New in build 627
void	MailboxShutdownFinished(java.lang.String sMailboxName) The mailbox shutdown process finished for a particular mailbox New in build 627
void	MessageCategorized(int CategoryID) Deprecated. will be removed sometime in 2026; use the version that accepts mailboxName as well
void	MessageCategorized(java.lang.String sMailboxName, int CategoryID) A message was categorized into a particular category.
void	MessageCount(java.lang.String sMailboxName, int nMessageCount) We just refreshed the mailbox and this is the message count New in 811
void	MessageFetched(java.lang.String sMailboxName, int nMessageNumber, long nFetchTimeNs) We just fetched a message from the mail server.
void	MessageProcessed(CMessage oMessage) Deprecated. will be removed sometime in 2026; use the version that accepts mailboxName as well
void	MessageProcessed(java.lang.String sMailboxName, CMessage oMessage) Deprecated. will be removed sometime in 2026; use the version that accepts nProcessingTimeNs as well
void	MessageProcessed(java.lang.String sMailboxName, CMessage oMessage, long nProcessingTimeNs) A message was processed Changed in build 595 MailboxName added in 811.
void	MessageSkipped() Deprecated. will be removed sometime in 2026; use the version that accepts mailboxName as well
void	MessageSkipped(java.lang.String sMailboxName) A message was deleted without processing because the headers could not be loaded.
void	Shutdown() Cleanup any resources you allocated during construction or operation.
void	SkippedRemovedMessage(java.lang.String sMailboxName) We tried to process a message, but it was removed from the mailbox or marked as deleted.
void	ThreadKilled(int nThreadNumber, java.util.Date dtLastUpdate) Deprecated. will be removed sometime in 2026; use the version that accepts mailboxName as well
void	ThreadKilled(java.lang.String sMailboxName, int nThreadNumber, java.util.Date dtLastUpdate) A thread was killed because it was inactive for too long New in build 595 MailboxName added in 811.

Methods inherited from class java.lang.Object

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

Constructor Detail

CMonitorBase

public CMonitorBase()

Method Detail

Initialize

public void Initialize(java.lang.String parameter)
                throws ResponseMasterException

Description copied from interface: IConfigurableItem

Initialize using the parameter from the config file.

Specified by:

Initialize in interface IConfigurableItem

Parameters:

parameter - The parameter from the config file, Frequently, the parameter will be a file name.

Throws:

ResponseMasterException - for invalid parameters (and potentially other issues).

Shutdown

public void Shutdown()

Description copied from interface: IConfigurableItem

Cleanup any resources you allocated during construction or operation. After this is called, nothing else will be called, unless Initialize is called again. Note: Shutdown may be called more than once on the same object New in build 595.

Specified by:

Shutdown in interface IConfigurableItem

LogError

public void LogError(java.lang.String sMessage)

Description copied from interface: IMonitor

Log an error

Specified by:

LogError in interface IMonitor

Parameters:

sMessage - The message to log

LogError

public void LogError(java.lang.String sMessage,
                     java.lang.Throwable e)

Description copied from interface: IMonitor

Log an error from a Throwable Changed to Throwable (from Exception) and overload with Error was removed in build 606

Specified by:

LogError in interface IMonitor

Parameters:

sMessage - The message to log

e - The Throwable to log

LogWarning

public void LogWarning(java.lang.String sMessage)

Description copied from interface: IMonitor

Log a warning If the logging level is Errors, this doesn't do anything

Specified by:

LogWarning in interface IMonitor

Parameters:

sMessage - The message to log

LogWarning

public void LogWarning(java.lang.String sMessage,
                       java.lang.Throwable e)

Description copied from interface: IMonitor

Log a warning from a Throwable If the logging level is Errors, this doesn't do anything Changed to Throwable (from Exception) in build 606

Specified by:

LogWarning in interface IMonitor

Parameters:

sMessage - The message to log

e - The Throwable to log

LogTrace

public void LogTrace(java.lang.String sMessage)

Description copied from interface: IMonitor

Log a tracing message If the logging level is Errors or Warnings, this doesn't do anything

Specified by:

LogTrace in interface IMonitor

Parameters:

sMessage - The message to log

LogTrace

public void LogTrace(java.lang.String sMessage,
                     java.lang.Throwable e)

Description copied from interface: IMonitor

Log a tracing message from a Throwable If the logging level is Errors or Warnings, this doesn't do anything Changed to Throwable (from Exception) in build 606

Specified by:

LogTrace in interface IMonitor

Parameters:

sMessage - The message to log

e - The Throwable to log

LogSystem

public void LogSystem(java.lang.String sMessage)

Description copied from interface: IMonitor

Log a system message

Specified by:

LogSystem in interface IMonitor

Parameters:

sMessage - The message to log

MessageProcessed

public void MessageProcessed(java.lang.String sMailboxName,
                             CMessage oMessage,
                             long nProcessingTimeNs)

Description copied from interface: IMonitor

A message was processed Changed in build 595 MailboxName added in 811. TotalTime added in 832.

Specified by:

MessageProcessed in interface IMonitor

Parameters:

sMailboxName - The name of the mailbox that the message was from

oMessage - The message that was processed.

nProcessingTimeNs - The total time taken to process the message in nanoseconds (includes fetch time)

MessageProcessed

public void MessageProcessed(java.lang.String sMailboxName,
                             CMessage oMessage)

Deprecated. will be removed sometime in 2026; use the version that accepts nProcessingTimeNs as well

Parameters:

sMailboxName - The mailbox that the message was from

oMessage - The message that was processed

MessageProcessed

public void MessageProcessed(CMessage oMessage)

Deprecated. will be removed sometime in 2026; use the version that accepts mailboxName as well

Parameters:

oMessage - The message that was processed

MessageFetched

public void MessageFetched(java.lang.String sMailboxName,
                           int nMessageNumber,
                           long nFetchTimeNs)

Description copied from interface: IMonitor

We just fetched a message from the mail server. Note: For different protocols, very different amounts of work are performed in this step. New in build 832

Specified by:

MessageFetched in interface IMonitor

Parameters:

sMailboxName - The name of the mailbox the message was fetched from.

nMessageNumber - The number of the message (as in "Getting message #12345..."), primarily used for reporting.

nFetchTimeNs - The time taken to fetch the message in nanoseconds.

MessageCategorized

public void MessageCategorized(java.lang.String sMailboxName,
                               int CategoryID)

Description copied from interface: IMonitor

A message was categorized into a particular category. New in build 595. MailboxName added in 811.

Specified by:

MessageCategorized in interface IMonitor

Parameters:

sMailboxName - The name of the mailbox that the message was from

CategoryID - The category that the message was placed into

MessageCategorized

public void MessageCategorized(int CategoryID)

Deprecated. will be removed sometime in 2026; use the version that accepts mailboxName as well

Parameters:

CategoryID - The category that the message was placed into.

CategoryDefinitionsLoaded

public void CategoryDefinitionsLoaded()

Description copied from interface: IMonitor

The category definition file finished loading New in build 595.

Specified by:

CategoryDefinitionsLoaded in interface IMonitor

ThreadKilled

public void ThreadKilled(java.lang.String sMailboxName,
                         int nThreadNumber,
                         java.util.Date dtLastUpdate)

Description copied from interface: IMonitor

A thread was killed because it was inactive for too long New in build 595 MailboxName added in 811.

Specified by:

ThreadKilled in interface IMonitor

Parameters:

sMailboxName - The name of the mailbox that the thread was processing

nThreadNumber - The number of the thread that was killed

dtLastUpdate - The last time the thread did something.

ThreadKilled

public void ThreadKilled(int nThreadNumber,
                         java.util.Date dtLastUpdate)

Deprecated. will be removed sometime in 2026; use the version that accepts mailboxName as well

Parameters:

nThreadNumber - The number of the thread that was killed

dtLastUpdate - The last time the thread did something.

MessageSkipped

public void MessageSkipped(java.lang.String sMailboxName)

Description copied from interface: IMonitor

A message was deleted without processing because the headers could not be loaded. New in build 595 MailboxName added in 811.

Specified by:

MessageSkipped in interface IMonitor

Parameters:

sMailboxName - The name of the mailbox that the message was from

MessageSkipped

public void MessageSkipped()

Deprecated. will be removed sometime in 2026; use the version that accepts mailboxName as well

MailboxInitializationBegun

public void MailboxInitializationBegun(java.lang.String sMailboxName)

Description copied from interface: IMonitor

The mailbox initialization process started for a particular mailbox New in build 627

Specified by:

MailboxInitializationBegun in interface IMonitor

Parameters:

sMailboxName - The name of the mailbox

MailboxInitializationFinished

public void MailboxInitializationFinished(java.lang.String sMailboxName)

Description copied from interface: IMonitor

The mailbox initialization process completed for a particular mailbox New in build 627

Specified by:

MailboxInitializationFinished in interface IMonitor

Parameters:

sMailboxName - The name of the mailbox

MailboxShutdownBegun

public void MailboxShutdownBegun(java.lang.String sMailboxName)

Description copied from interface: IMonitor

The mailbox shutdown process began for a particular mailbox New in build 627

Specified by:

MailboxShutdownBegun in interface IMonitor

Parameters:

sMailboxName - The name of the mailbox

MailboxShutdownFinished

public void MailboxShutdownFinished(java.lang.String sMailboxName)

Description copied from interface: IMonitor

The mailbox shutdown process finished for a particular mailbox New in build 627

Specified by:

MailboxShutdownFinished in interface IMonitor

Parameters:

sMailboxName - The name of the mailbox

MailboxEmpty

public void MailboxEmpty(java.lang.String sMailboxName)

Description copied from interface: IMonitor

This is fired every time we check the mailbox for messages, and we find that it is empty. Note: It can fire multiple times without the mailbox getting messages in between. New in build 627

Specified by:

MailboxEmpty in interface IMonitor

Parameters:

sMailboxName - The name of the mailbox

MessageCount

public void MessageCount(java.lang.String sMailboxName,
                         int nMessageCount)

Description copied from interface: IMonitor

We just refreshed the mailbox and this is the message count New in 811

Specified by:

MessageCount in interface IMonitor

Parameters:

sMailboxName - The name of the mailbox

nMessageCount - The number of messages in the mailbox

SkippedRemovedMessage

public void SkippedRemovedMessage(java.lang.String sMailboxName)

Description copied from interface: IMonitor

We tried to process a message, but it was removed from the mailbox or marked as deleted. New in build 833

Specified by:

SkippedRemovedMessage in interface IMonitor

Parameters:

sMailboxName - The name of the mailbox the message was from.

LoggingLevelNameFromValue

public static java.lang.String LoggingLevelNameFromValue(int value)

LoggingLevelFromString

public static int LoggingLevelFromString(java.lang.String value)