no.feide.moria.log
Class MessageLogger

java.lang.Object
  no.feide.moria.log.MessageLogger

All Implemented Interfaces:

java.io.Serializable

public final class MessageLogger
extends java.lang.Object
implements java.io.Serializable

Logs generic messages from the system, may include ticket id and/or throwable. Supports four loglevels: Debug, Info, Warn, Critical.

Version:

$Revision: 1.12 $

Author:

Bjørn Ola Smievoll <b.o@smievoll.no>

See Also:

Serialized Form

Field Summary

private java.lang.Class	callingClass Class using this logger instance.
private org.apache.log4j.Logger	logger Log to this logger.
private int	logLevel The current log level.
private static long	serialVersionUID Serial version UID.

Constructor Summary

MessageLogger(java.lang.Class callingClass)
Default constructor.

Method Summary

private java.lang.String	generateLogMessage(java.lang.String message, java.lang.String ticketId, java.lang.Throwable throwable) Generates the final log entry to give to the underlying log api.
private org.apache.log4j.Logger	getLogger() Returns the logger, instantiates it if not already done.
boolean	isEnabledFor(org.apache.log4j.Priority level) Checks whether the actual log level would generate log output for a given log level.
void	logCritical(java.lang.String message) Logs a message with level critical.
void	logCritical(java.lang.String message, java.lang.String ticketId) Logs a message with level critical including ticket id.
void	logCritical(java.lang.String message, java.lang.String ticketId, java.lang.Throwable throwable) Logs a message with level critical including ticket id.
void	logCritical(java.lang.String message, java.lang.Throwable throwable) Logs a message with level critical.
void	logDebug(java.lang.String message) Logs a message with level debug.
void	logDebug(java.lang.String message, java.lang.String ticketId) Logs a message with level debug including ticket id.
void	logDebug(java.lang.String message, java.lang.String ticketId, java.lang.Throwable throwable) Logs a message with level debug including ticket id.
void	logDebug(java.lang.String message, java.lang.Throwable throwable) Logs a message with level debug.
void	logInfo(java.lang.String message) Logs a message with level info.
void	logInfo(java.lang.String message, java.lang.String ticketId) Logs a message with level info including ticket id.
void	logInfo(java.lang.String message, java.lang.String ticketId, java.lang.Throwable throwable) Logs a message with level info including ticket id.
void	logInfo(java.lang.String message, java.lang.Throwable throwable) Logs a message with level info.
void	logWarn(java.lang.String message) Logs a message with level warn.
void	logWarn(java.lang.String message, java.lang.String ticketId) Logs a message with level warn including ticket id.
void	logWarn(java.lang.String message, java.lang.String ticketId, java.lang.Throwable throwable) Logs a message with level warn including ticket id.
void	logWarn(java.lang.String message, java.lang.Throwable throwable) Logs a message with level warn.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial version UID.

See Also:

Constant Field Values

logger

private transient org.apache.log4j.Logger logger

Log to this logger. Transient so the class can be serialized.

callingClass

private java.lang.Class callingClass

Class using this logger instance.

logLevel

private int logLevel

The current log level. Intitalized to 'ALL'

Constructor Detail

MessageLogger

public MessageLogger(java.lang.Class callingClass)

Default constructor.

Parameters:

callingClass - The class that will use this logger instance.

Method Detail

logCritical

public void logCritical(java.lang.String message)

Logs a message with level critical.

Parameters:

message - The message to log.

logCritical

public void logCritical(java.lang.String message,
                        java.lang.Throwable throwable)

Logs a message with level critical.

Parameters:

message - The message to log.

throwable - An throwable associated with this log entry. Message and stacktrace will be logged.

logCritical

public void logCritical(java.lang.String message,
                        java.lang.String ticketId)

Logs a message with level critical including ticket id.

Parameters:

message - The message to log.

ticketId - The ticket id associated with this log message.

logCritical

public void logCritical(java.lang.String message,
                        java.lang.String ticketId,
                        java.lang.Throwable throwable)

Logs a message with level critical including ticket id.

Parameters:

message - The message to log.

ticketId - The ticket id associated with this log message.

throwable - An throwable associated with this log entry. Message and stacktrace will be logged.

logWarn

public void logWarn(java.lang.String message)

Logs a message with level warn.

Parameters:

message - The message to log.

logWarn

public void logWarn(java.lang.String message,
                    java.lang.Throwable throwable)

Logs a message with level warn.

Parameters:

message - The message to log.

throwable - An throwable associated with this log entry. Message and stacktrace will be logged.

logWarn

public void logWarn(java.lang.String message,
                    java.lang.String ticketId)

Logs a message with level warn including ticket id.

Parameters:

message - The message to log.

ticketId - The ticket id associated with this log message.

logWarn

public void logWarn(java.lang.String message,
                    java.lang.String ticketId,
                    java.lang.Throwable throwable)

Logs a message with level warn including ticket id.

Parameters:

message - The message to log.

ticketId - The ticket id associated with this log message.

throwable - An throwable associated with this log entry. Message and stacktrace will be logged.

logInfo

public void logInfo(java.lang.String message)

Logs a message with level info.

Parameters:

message - The message to log.

logInfo

public void logInfo(java.lang.String message,
                    java.lang.Throwable throwable)

Logs a message with level info.

Parameters:

message - The message to log.

throwable - An throwable associated with this log entry. Message and stacktrace will be logged.

logInfo

public void logInfo(java.lang.String message,
                    java.lang.String ticketId)

Logs a message with level info including ticket id.

Parameters:

message - The message to log.

ticketId - The ticket id associated with this log message.

logInfo

public void logInfo(java.lang.String message,
                    java.lang.String ticketId,
                    java.lang.Throwable throwable)

Logs a message with level info including ticket id.

Parameters:

message - The message to log.

ticketId - The ticket id associated with this log message.

throwable - An throwable associated with this log entry. Message and stacktrace will be logged.

logDebug

public void logDebug(java.lang.String message)

Logs a message with level debug.

Parameters:

message - The message to log.

logDebug

public void logDebug(java.lang.String message,
                     java.lang.Throwable throwable)

Logs a message with level debug.

Parameters:

message - The message to log.

throwable - An throwable associated with this log entry. Message and stacktrace will be logged.

logDebug

public void logDebug(java.lang.String message,
                     java.lang.String ticketId)

Logs a message with level debug including ticket id.

Parameters:

message - The message to log.

ticketId - The ticket id associated with this log message.

logDebug

public void logDebug(java.lang.String message,
                     java.lang.String ticketId,
                     java.lang.Throwable throwable)

Logs a message with level debug including ticket id.

Parameters:

message - The message to log.

ticketId - The ticket id associated with this log message.

throwable - An throwable associated with this log entry. Message and stacktrace will be logged.

generateLogMessage

private java.lang.String generateLogMessage(java.lang.String message,
                                            java.lang.String ticketId,
                                            java.lang.Throwable throwable)

Generates the final log entry to give to the underlying log api.

Parameters:

message - The message to log.

ticketId - A ticket id. May be null.

throwable - Throwable to get stacktrace from. May be null.

Returns:

The final log string.

getLogger

private org.apache.log4j.Logger getLogger()

Returns the logger, instantiates it if not already done. Private, so that nothing is able to override the formatting that is done by generateLogMessage.

Returns:

The logger instance of this class.

isEnabledFor

public boolean isEnabledFor(org.apache.log4j.Priority level)

Checks whether the actual log level would generate log output for a given log level.

Parameters:

level - The desired level to check against.

Returns:

true if log output for the given level would result, otherwise false.