CamsTraceLogger (Cams API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.cafesoft.cams.log
Class CamsTraceLogger

java.lang.Object
  |
  +--com.cafesoft.cams.log.CamsTraceLogger

All Implemented Interfaces:: Logger

public class CamsTraceLogger
extends Object
implements Logger

A specialized Logger object that will send debug messages that are of the level INFO and DEBUG to a specified file. However, the Logger object will also send messages of the levels WARNING, ERROR, and FATAL to both the same specified file and to the System.err stream. Configuration properties supported by this Logger include:

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, (1MB) 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.enableConsole - (OPTIONAL) if value of "logger.enableConsole" is "true", all log messages sent to the log file will also appear on the console. If set to "false" only FATAL, ERROR, and WARNING messages will appear on the console. The default value is "false".
logger.enableDebugFilter - (OPTIONAL) if value of "logger.enableDebugFilter" is "true", only INFO, WARN, ERROR, and FATAL will be logged. Messages that are the level of DEBUG will not be sent to the specified file. The default value is "false".
logger.verbose - (OPTIONAL) if the value of "logger.verbose" is true all DEBUG, INFO, WARN, ERROR, FATAL messages logged will contain the following format:
```
 [INFO ] Sample log message
     Class Name: com.cafesoft.cams.log.CamsTraceLogger
     Method Name: info()
     Line Number: 121
     Timestamp: 25 Jul 2002 11:02:36,339
 
```
If the "logger.verbose" flag is false ONLY messages with the WARNING, ERROR, and FATAL message level will use the verbose format, while DEBUG and INFO level messages will use the following format:
```
 [INFO ] Sample Log Message
 
```
logger.debug - (OPTIONAL) if value of "logger.debug" is true debug messages created by the StandardLog4JLogger itself will be sent to the configured PrintStream.

Since:: 7/15/02

Field Summary

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

DEBUG, ERROR, FATAL, INFO, WARNING

Constructor Summary

CamsTraceLogger()


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 filter)
          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

Constructor Detail