com.cafesoft.core.log
Class Log4JFileLogger

java.lang.Object
  |
  +--com.cafesoft.core.log.Log4JFileLogger

All Implemented Interfaces:

Logger

public class Log4JFileLogger

extends Object

implements Logger

Log4JFileLogger writes log messages to a File by delegating logging to Apache's Log4J API. Configuration properties supported by this Logger include:

• logger.name - (REQUIRED) the Log4J "Logger" name, which can be used to partition logging based on a hierarchical namespace.
• logger.additivity - (OPTIONAL) if "true" then parent Log4J loggers will also get messages sent to this logger. If "false" (or not specified), messages are handled only by the Log4J Logger withing this object.
• logger.file.path - (REQUIRED) the file to which log messages are written.
• logger.file.append - (OPTIONAL) if "true" or not specified, messages are appended to an existing file. If "false" the destination file is cleared before logging starts.
• logger.file.bufferedIO - (OPTIONAL) if "true" or not specified, buffered IO is when writing to the file, which can radically improve performance. If "false" then buffered IO is not used.
• logger.file.bufferSize - (OPTIONAL) the number of bytes in the output buffer (used if buffered IO is enabled).
• logger.file.maxSize - (OPTIONAL) the maximum size of the file (in bytes) before it is rolled over. If not specified, (10MB) is used. (See org.apache.log4j.RollingFileAppender.setMaxFileSize(String value)).
• logger.file.maxBackupIndex - (OPTIONAL) the maximum rollover file index. When log files are rolled over, a numeric index is appended to the name, starting with 1 and proceeding to this vallue. If not specified, the value: 100 is used. (See org.apache.log4j.RollingFileAppender.setMaxBackupIndex(int value)).
• logger.layout.class - (OPTIONAL) the Log4J Layout class. If not specified, then "org.apache.log4j.SimpleLayout" is used.
• logger.layout.pattern - (OPTIONAL) if the value of "logger.layout.class=org.apache.log4j.PatternLayout", then this value is set for the "ConversionPattern".
• logger.level.min - (OPTIONAL) the minimum Cafesoft message level that should be logged. Message levels (in ascending order) include: DEBUG, INFO, WARN, ERROR, FATAL. If the value of this property is set to "ERROR" then only messages with level "ERROR" and "FATAL" will be logged. This property will takes effect on the default MessageFilter, which is: com.cafesoft.core.log.MessageLevelMessageFilter. If the MessageFilter is replaced, then this property has no meaning.
• logger.level.max - (OPTIONAL) the maximum Cafesoft message level that should be logged. Message levels (in ascending order) include: DEBUG, INFO, WARN, ERROR, FATAL. If the value of this property is set to "ERROR" and the corresponding "logger.level.min" is also set to "ERROR", then only "ERROR" messages will be logged. This property will takes effect on the default MessageFilter, which is: com.cafesoft.core.log.MessageLevelMessageFilter. If the MessageFilter is replaced, then this property has no meaning.

Since:

4/15/02

Field Summary

protected MessageFilter	messageFilter The MessageFilter used to discriminate messages to be logged.
protected Properties	prop Configuration Properties.

Fields inherited from interface com.cafesoft.core.log.Logger

DEBUG, ERROR, FATAL, INFO, WARNING

Constructor Summary

Log4JFileLogger()
Create a new Log4jFileLogger.

Method Summary

void	debug(Object source, String message) Log a debug message from the specified source object.
void	debug(Object source, String message, Throwable throwable) Log a debug message from the specified source object.
void	error(Object source, String message) Log a error message from the specified source object.
void	error(Object source, String message, Throwable throwable) Log a error message from the specified source object.
void	fatal(Object source, String message) Log a fatal message from the specified source object.
void	fatal(Object source, String message, Throwable throwable) Log a fatal message from the specified source object.
void	info(Object source, String message) Log an info message from the specified source object.
void	info(Object source, String message, Throwable throwable) Log an info message from the specified source object.
void	initialize(Properties prop) Initialize the Logger.
void	setMessageFilter(MessageFilter messageFilter) Set a message filter.
void	warning(Object source, String message) Log a warning message from the specified source object.
void	warning(Object source, String message, Throwable throwable) Log a warning message from the specified source object.

Methods inherited from class java.lang.Object

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

Field Detail

prop

protected Properties prop

Configuration Properties.

messageFilter

protected MessageFilter messageFilter

The MessageFilter used to discriminate messages to be logged.

Constructor Detail

Log4JFileLogger

public Log4JFileLogger()

Create a new Log4jFileLogger.

Method Detail

initialize

public void initialize(Properties prop)
                throws LoggerException

Initialize the Logger.

Specified by:

initialize in interface Logger

Parameters:

prop - initialization Properties.

Throws:

LoggerException - if an error initializing the Logger.

setMessageFilter

public void setMessageFilter(MessageFilter messageFilter)

Set a message filter.

Specified by:

setMessageFilter in interface Logger

Parameters:

messageFilter - the MessageFilter that discriminates the messages to be logged.

debug

public void debug(Object source,
                  String message)

Log a debug message from the specified source object.

Specified by:

debug in interface Logger

Parameters:

source - the source of the message.

message - the debug message to be logged.

debug

public void debug(Object source,
                  String message,
                  Throwable throwable)

Log a debug message from the specified source object.

Specified by:

debug in interface Logger

Parameters:

source - the source of the message.

message - the debug message to be logged.

throwable - an Exception or Error to be logged.

info

public void info(Object source,
                 String message)

Log an info message from the specified source object.

Specified by:

info in interface Logger

Parameters:

source - the source of the message.

message - the info message to be logged.

info

public void info(Object source,
                 String message,
                 Throwable throwable)

Log an info message from the specified source object.

Specified by:

info in interface Logger

Parameters:

source - the source of the message.

message - the info message to be logged.

throwable - an Exception or Error to be logged.

warning

public void warning(Object source,
                    String message)

Log a warning message from the specified source object.

Specified by:

warning in interface Logger

Parameters:

source - the source of the message.

message - the info message to be logged.

warning

public void warning(Object source,
                    String message,
                    Throwable throwable)

Log a warning message from the specified source object.

Specified by:

warning in interface Logger

Parameters:

source - the source of the message.

message - the warning message to be logged.

throwable - an Exception or Error to be logged.

error

public void error(Object source,
                  String message)

Log a error message from the specified source object.

Specified by:

error in interface Logger

Parameters:

source - the source of the message.

message - the info message to be logged.

error

public void error(Object source,
                  String message,
                  Throwable throwable)

Log a error message from the specified source object.

Specified by:

error in interface Logger

Parameters:

source - the source of the message.

message - the error message to be logged.

throwable - an Exception or Error to be logged.

fatal

public void fatal(Object source,
                  String message)

Log a fatal message from the specified source object.

Specified by:

fatal in interface Logger

Parameters:

source - the source of the message.

message - the info message to be logged.

fatal

public void fatal(Object source,
                  String message,
                  Throwable throwable)

Log a fatal message from the specified source object.

Specified by:

fatal in interface Logger

Parameters:

source - the source of the message.

message - the fatal message to be logged.

throwable - an Exception or Error to be logged.