com.ail.core.logging
Interface Logging

All Known Implementing Classes:

Core

public interface Logging

This interface defines the contract between the Core class and the logging sub-system. The Core is expected to expose the methods defined here, and this package will expose the required entry points.

Four error levels are defined:

1. debug - Messages that are intended to help developers debug a system that is not performing as expected.
2. info - Messages that are aimed at monitoring systems. Typically these are "I am X, and I am doing Y" messages.
3. warning - These messages indicate that something went wrong, but processing could continue.
4. error - The same as warning, but requires investigation.
5. fatal - The same as error, but processing could not continee.

Clients of the logger can assume that their messages will have certain information addded to them; date-time, security context, and code location.

Version:

$Revision: 1.4 $

Method Summary

void	logBootError(java.lang.String message) Output a message to the Error boot logging channel.
void	logBootError(java.lang.String message, java.lang.Throwable cause) Output a message to the Error boot logging channel.
void	logBootFatal(java.lang.String message) Output a message to the Fatal boot logging channel.
void	logBootFatal(java.lang.String message, java.lang.Throwable cause) Output a message to the Fatal boot logging channel.
void	logBootInfo(java.lang.String message) Output a message to the Info boot logging channel.
void	logBootInfo(java.lang.String message, java.lang.Throwable cause) Output a message to the Info boot logging channel.
void	logBootWarning(java.lang.String message) Output a message to the Warning Boot logging channel.
void	logBootWarning(java.lang.String message, java.lang.Throwable cause) Output a message to the Warning Boot logging channel.
void	logDebug(java.lang.String message) Output a message to the Debug logging channel.
void	logDebug(java.lang.String message, java.lang.Throwable cause) Output a message to the Debug logging channel with exception details.
void	logError(java.lang.String message) Output a message to the Error logging channel.
void	logError(java.lang.String message, java.lang.Throwable cause) Output a message to the Error logging channel with an excpetion.
void	logFatal(java.lang.String message) Output a message to the Fatal logging channel.
void	logFatal(java.lang.String message, java.lang.Throwable cause) Output a message to the Fatal logging channel with an exception.
void	logInfo(java.lang.String message) Output a message to the Info logging channel.
void	logInfo(java.lang.String message, java.lang.Throwable cause) Output a message to the Info logging channel with exception details.
void	logWarning(java.lang.String message) Output a message to the Warning logging channel.
void	logWarning(java.lang.String message, java.lang.Throwable cause) Output a message to the Warning logging channel with exception details.

Method Detail

logDebug

void logDebug(java.lang.String message)

Output a message to the Debug logging channel. Messages written to this channel are of interest to developers, and to anyone trying to debug a system problem. The channel would generally only be turned on when a problem is being investigated.

Parameters:

message - The text of the message to be output.

logDebug

void logDebug(java.lang.String message,
              java.lang.Throwable cause)

Output a message to the Debug logging channel with exception details. Messages written to this channel are of interest to developers, and to anyone trying to debug a system problem. The channel would generally only be turned on when a problem is being investigated.

Parameters:

message - The text of the message to be output.

cause - The cause of the debug message.

logInfo

void logInfo(java.lang.String message)

Output a message to the Info logging channel. This channel is designed to take messages that are of interest during normal operations. For example, "System ready", "Configuration reloaded".

Parameters:

message - The text of the message to be output.

logInfo

void logInfo(java.lang.String message,
             java.lang.Throwable cause)

Output a message to the Info logging channel with exception details. This channel is designed to take messages that are of interest during normal operations. For example, "System ready", "Configuration reloaded".

Parameters:

message - The text of the message to be output.

cause - The cause of the info message.

logWarning

void logWarning(java.lang.String message)

Output a message to the Warning logging channel. Messages written to this channel indicate that something unexpected occured, but that it was dealt with and is not thought (by the developer) to be if great importance.

Parameters:

message - The text of the message to be output.

logWarning

void logWarning(java.lang.String message,
                java.lang.Throwable cause)

Output a message to the Warning logging channel with exception details. Messages written to this channel indicate that something unexpected occured, but that it was dealt with and is not thought (by the developer) to be if great importance.

Parameters:

message - The text of the message to be output.

cause - The cause of the warning message.

logError

void logError(java.lang.String message)

Output a message to the Error logging channel. The error channel is reserved for messages that describe serious system problems. The problem didn't stop processing, but is significant enough to require investigation.

Parameters:

message - The text of the message to be output.

logError

void logError(java.lang.String message,
              java.lang.Throwable cause)

Output a message to the Error logging channel with an excpetion. The error channel is reserved for messages that describe serious system problems. The problem didn't stop processing, but is significant enough to require investigation.

Parameters:

message - The text of the message to be output.

cause - The cause of the error.

logFatal

void logFatal(java.lang.String message)

Output a message to the Fatal logging channel. An error is fatal if it stops the operation being processed. For example, if the systems configuration information is defined in an inconsistent way a fatal error is generated.

Parameters:

message - The text of the message to be output.

logFatal

void logFatal(java.lang.String message,
              java.lang.Throwable cause)

Output a message to the Fatal logging channel with an exception. An error is fatal if it stops the operation being processed. For example, if the systems configuration information is defined in an inconsistent way a fatal error is generated.

Parameters:

message - The text of the message to be output.

cause - The cause of the fatal error.

logBootInfo

void logBootInfo(java.lang.String message)

Output a message to the Info boot logging channel. This should only be used when the normal logging services are not available - e.g. during startup when the normal service have yet to be loaded. An 'info' message indicates normal operation; it might be used to report that a message has been sent sucessfully for example.

Parameters:

message - The text of the message to be output.

logBootInfo

void logBootInfo(java.lang.String message,
                 java.lang.Throwable cause)

Output a message to the Info boot logging channel. This should only be used when the normal logging services are not available - e.g. during startup when the normal service have yet to be loaded. An 'info' message indicates normal operation; it might be used to report that a message has been sent sucessfully for example.

Parameters:

message - The text of the message to be output.

cause - Related cause.

logBootError

void logBootError(java.lang.String message)

Output a message to the Error boot logging channel. This should only be used when the normal logging services are not available - e.g. during startup when the normal service have yet to be loaded. Error messages that describe serious system problems. The problem didn't prevent processing, but is significant enough to require investigation.

Parameters:

message - The text of the message to be output.

logBootError

void logBootError(java.lang.String message,
                  java.lang.Throwable cause)

Output a message to the Error boot logging channel. This should only be used when the normal logging services are not available - e.g. during startup when the normal service have yet to be loaded. Error messages that describe serious system problems. The problem didn't prevent processing, but is significant enough to require investigation.

Parameters:

message - The text of the message to be output.

cause - The exception that caused the error.

logBootWarning

void logBootWarning(java.lang.String message)

Output a message to the Warning Boot logging channel. This should only be used when the normal logging services are not available - e.g. during startup when the normal service have yet to be loaded. Warning messages indicate that something unexpected occured, but that it was dealt with and is not thought (by the developer) to be if great importance.

Parameters:

message - The text of the message to be output.

logBootWarning

void logBootWarning(java.lang.String message,
                    java.lang.Throwable cause)

Output a message to the Warning Boot logging channel. This should only be used when the normal logging services are not available - e.g. during startup when the normal service have yet to be loaded. Warning messages indicate that something unexpected occured, but that it was dealt with and is not thought (by the developer) to be if great importance.

Parameters:

message - The text of the message to be output.

cause - The exception that caused the warning.

logBootFatal

void logBootFatal(java.lang.String message)

Output a message to the Fatal boot logging channel. This should only be used when the normal logging services are not available - e.g. during startup when the normal service have yet to be loaded. An error is fatal if it stops the operation being processed. For example, if the systems configuration information is defined in an inconsistent way a fatal error is generated.

Parameters:

message - The text of the message to be output.

logBootFatal

void logBootFatal(java.lang.String message,
                  java.lang.Throwable cause)

Output a message to the Fatal boot logging channel. This should only be used when the normal logging services are not available - e.g. during startup when the normal service have yet to be loaded. An error is fatal if it stops the operation being processed. For example, if the systems configuration information is defined in an inconsistent way a fatal error is generated.

Parameters:

message - The text of the message to be output.

cause - The exception that caused the fatal error.