com.mmoui.manager.services
Interface ModuleLogger

All Superinterfaces:

java.lang.Thread.UncaughtExceptionHandler

public interface ModuleLogger
extends java.lang.Thread.UncaughtExceptionHandler

Provides a service through which loaded modules can log information to the global log file. Use of this service is not required for modules, however it provides a standardized mechanism through which modules can indicate status and relate issues to global events.

All module events are logged to the application's local storage area (which is OS-dependent) and write lines like the following:

 CODE> DATE TIME - MESSAGE
                      METHOD(FILE:LINE)
 

Where the variables are defined as:

• CODE - A three-letter code indicating the type of message this line indicates. For modules, this may be any of the following:
  • MFF - Fatal Error
  • MEE - Error
  • MWW - Warning
  • MNN - Notice
  • MDD - Debug Information
• DATE - The system date when this event occurred
• TIME - The system time when this occurred, in 24-hour format
• MESSAGE - The message associated with this event
• METHOD - The method that requested the log information to be recorded (the method that was at the top of the call stack at the time of the logged information)
• FILE - The file in which METHOD resides
• LINE - The line at which METHOD made the call to the logger

The log levels are intended to be used as follows, but this behavior is not enforced. Use of this pattern helps ensure users receive what they expect when setting the minimum log level through the managing application.

• Fatal Error - Errors which are unrecoverable and will terminate the module's operation
• Error - Conditions which cause a process to stop and cause a loss of functionality.
• Warning - Recoverable conditions which may cause undesired behavior
• Notice - Normal conditions which may be useful to report for status information
• Debug - Debugging information which may be useful to resolve problems but is generally not necessary for concise status information

Version:

$Id: ModuleLogger.java 127 2009-02-17 11:10:49Z mpdelbuono $

Author:

Matthew P. Del Buono

Method Summary

void	debug(java.lang.String message) Records a debug message to the logging system
void	error(java.lang.String message) Records an error message to the logging system
void	fatal(java.lang.String message) Records a fatal error message to the logging system
void	notice(java.lang.String message) Records a notice to the logging system
void	warning(java.lang.String message) Records a warning message to the logging system

Methods inherited from interface java.lang.Thread.UncaughtExceptionHandler

uncaughtException

Method Detail

fatal

void fatal(java.lang.String message)

Records a fatal error message to the logging system

Parameters:

message - The message to record

See Also:

ModuleLogger

error

void error(java.lang.String message)

Records an error message to the logging system

Parameters:

message - The message to record

See Also:

ModuleLogger

warning

void warning(java.lang.String message)

Records a warning message to the logging system

Parameters:

message - The message to record

See Also:

ModuleLogger

notice

void notice(java.lang.String message)

Records a notice to the logging system

Parameters:

message - The message to record

See Also:

ModuleLogger

debug

void debug(java.lang.String message)

Records a debug message to the logging system

Parameters:

message - The message to record

See Also:

ModuleLogger