org.apache.turbine.services.logging
Interface Logger

All Known Implementing Classes:
BaseLogger

public interface Logger

Classes that implement the Logger interface allows loging. There is set of standart printing methods (info, debug ...). The implementation has to read xml-node describing properities, skiping options that are not recognizeable.

Uh, we need better javadoc here (Rafal)

Version:
$Id: Logger.java,v 1.1.1.1 2001/08/16 05:09:04 jvanzyl Exp $
Author:
Tomasz Zielinski, Jon S. Stevens

Field Summary
static java.lang.String BACKUP_KEY
          Destination parameter - number of backup files
static java.lang.String CONSOLE_KEY
          Destination type - console
static java.lang.String DB_KEY
          Destination type - db
static java.lang.String DB_LOGGER_KEY
          Destination parameter - db sql
static java.lang.String DB_POOL_KEY
           
static int DEBUG
          Log level
static java.lang.String EMAIL_KEY
          Destination type - email
static java.lang.String EMAILBUFFERSIZE_KEY
          Destination parameter - email buffer size
static java.lang.String EMAILFROM_KEY
          Destination parameter - email from
static java.lang.String EMAILSUBJECT_KEY
          Destination parameter - email subject
static java.lang.String EMAILTO_KEY
          Destination parameter - email to
static int ERROR
          Log level
static java.lang.String FACILITY_KEY
          Destination parameter - syslogd facility
static java.lang.String FILE_KEY
          Destination type - file
static java.lang.String FORMAT_KEY
          Destination parameter - format
static java.lang.String HOST_KEY
          Destination parameter - remote url
static int INFO
          Log level
static java.lang.String LEVELDEBUG
          String denoting log level
static java.lang.String LEVELERROR
          String denoting log level
static java.lang.String LEVELINFO
          String denoting log level
static java.lang.String LEVELWARN
          String denoting log level
static java.lang.String PATH_KEY
          Destination parameter - file path
static java.lang.String PORT_KEY
          Destination parameter - remote port
static java.lang.String REMOTE_KEY
          Destination type - remote server
static java.lang.String SIZE_KEY
          Destination parameter - rollover file size
static java.lang.String SYSLOGD_KEY
          Destination type - syslogdemon
static int WARN
          Log level
 
Method Summary
 boolean checkLogger()
          This method should be implemented by user.
 void debug(java.lang.String message)
          This is a log metod with logLevel == DEBUG
 void debug(java.lang.String message, RunData data)
          This is a log metod with logLevel == DEBUG
 void debug(java.lang.String message, RunData data, java.lang.Throwable t)
          This is a log metod with logLevel == DEBUG
 void debug(java.lang.String message, java.lang.Throwable t)
          This is a log metod with logLevel == DEBUG
 void error(java.lang.String message)
          This is a log metod with logLevel == ERROR
 void error(java.lang.String message, RunData data)
          This is a log metod with logLevel == ERROR
 void error(java.lang.String message, RunData data, java.lang.Throwable e)
          This is a log metod with logLevel == ERROR
 void error(java.lang.String message, java.lang.Throwable e)
          This is a log metod with logLevel == ERROR
 void error(java.lang.Throwable e)
          This is a log metod with logLevel == ERROR
 java.lang.String getName()
          name of the logger
 void info(java.lang.String message)
          This is a log metod with logLevel == INFO
 void info(java.lang.String message, RunData data)
          This is a log metod with logLevel == INFO
 void info(java.lang.String message, RunData data, java.lang.Throwable t)
          This is a log metod with logLevel == INFO
 void info(java.lang.String message, java.lang.Throwable t)
          This is a log metod with logLevel == INFO
 void init(LoggingConfig loggingConfig)
          This method sets parameters for the logger implementation.
 boolean isDebugEnabled()
          Checks if DEBUG statements are enabled.
 boolean isErrorEnabled()
          Checks if ERROR statements are enabled.
 boolean isInfoEnabled()
          Checks if INFO statements are enabled.
 boolean isWarnEnabled()
          Checks if WARN statements are enabled.
 void setFormat(java.lang.String format)
          Sets format style for extracting data from RunData
 void setLogLevel(int level)
          Sets log level for the logger
 void setName(java.lang.String logName)
          Setings the name
 void shutdown()
          Close all destinations
 void warn(java.lang.String message)
          This is a log metod with logLevel == WARN
 void warn(java.lang.String message, RunData data)
          This is a log metod with logLevel == WARN
 void warn(java.lang.String message, RunData data, java.lang.Throwable t)
          This is a log metod with logLevel == WARN
 void warn(java.lang.String message, java.lang.Throwable t)
          This is a log metod with logLevel == WARN
 

Field Detail

DEBUG

public static final int DEBUG
Log level

INFO

public static final int INFO
Log level

WARN

public static final int WARN
Log level

ERROR

public static final int ERROR
Log level

LEVELDEBUG

public static final java.lang.String LEVELDEBUG
String denoting log level

LEVELINFO

public static final java.lang.String LEVELINFO
String denoting log level

LEVELWARN

public static final java.lang.String LEVELWARN
String denoting log level

LEVELERROR

public static final java.lang.String LEVELERROR
String denoting log level

FILE_KEY

public static final java.lang.String FILE_KEY
Destination type - file

SYSLOGD_KEY

public static final java.lang.String SYSLOGD_KEY
Destination type - syslogdemon

REMOTE_KEY

public static final java.lang.String REMOTE_KEY
Destination type - remote server

CONSOLE_KEY

public static final java.lang.String CONSOLE_KEY
Destination type - console

EMAIL_KEY

public static final java.lang.String EMAIL_KEY
Destination type - email

DB_KEY

public static final java.lang.String DB_KEY
Destination type - db

FORMAT_KEY

public static final java.lang.String FORMAT_KEY
Destination parameter - format

PATH_KEY

public static final java.lang.String PATH_KEY
Destination parameter - file path

HOST_KEY

public static final java.lang.String HOST_KEY
Destination parameter - remote url

PORT_KEY

public static final java.lang.String PORT_KEY
Destination parameter - remote port

FACILITY_KEY

public static final java.lang.String FACILITY_KEY
Destination parameter - syslogd facility

SIZE_KEY

public static final java.lang.String SIZE_KEY
Destination parameter - rollover file size

BACKUP_KEY

public static final java.lang.String BACKUP_KEY
Destination parameter - number of backup files

EMAILFROM_KEY

public static final java.lang.String EMAILFROM_KEY
Destination parameter - email from

EMAILTO_KEY

public static final java.lang.String EMAILTO_KEY
Destination parameter - email to

EMAILSUBJECT_KEY

public static final java.lang.String EMAILSUBJECT_KEY
Destination parameter - email subject

EMAILBUFFERSIZE_KEY

public static final java.lang.String EMAILBUFFERSIZE_KEY
Destination parameter - email buffer size

DB_LOGGER_KEY

public static final java.lang.String DB_LOGGER_KEY
Destination parameter - db sql

DB_POOL_KEY

public static final java.lang.String DB_POOL_KEY
Method Detail

getName

public java.lang.String getName()
name of the logger

setName

public void setName(java.lang.String logName)
Setings the name

init

public void init(LoggingConfig loggingConfig)
This method sets parameters for the logger implementation. If the implementation cannot handle some type of destination should ignore that output.
Parameters:
LoggingConfig - configuration object for logging

shutdown

public void shutdown()
Close all destinations

setLogLevel

public void setLogLevel(int level)
Sets log level for the logger

isDebugEnabled

public boolean isDebugEnabled()
Checks if DEBUG statements are enabled.

isInfoEnabled

public boolean isInfoEnabled()
Checks if INFO statements are enabled.

isWarnEnabled

public boolean isWarnEnabled()
Checks if WARN statements are enabled.

isErrorEnabled

public boolean isErrorEnabled()
Checks if ERROR statements are enabled.

checkLogger

public boolean checkLogger()
This method should be implemented by user. It performs action that are need for deterimne whether logger was well configured or has any output

setFormat

public void setFormat(java.lang.String format)
Sets format style for extracting data from RunData

debug

public void debug(java.lang.String message)
This is a log metod with logLevel == DEBUG

debug

public void debug(java.lang.String message,
                  java.lang.Throwable t)
This is a log metod with logLevel == DEBUG

debug

public void debug(java.lang.String message,
                  RunData data)
This is a log metod with logLevel == DEBUG

debug

public void debug(java.lang.String message,
                  RunData data,
                  java.lang.Throwable t)
This is a log metod with logLevel == DEBUG

info

public void info(java.lang.String message)
This is a log metod with logLevel == INFO

info

public void info(java.lang.String message,
                 java.lang.Throwable t)
This is a log metod with logLevel == INFO

info

public void info(java.lang.String message,
                 RunData data)
This is a log metod with logLevel == INFO

info

public void info(java.lang.String message,
                 RunData data,
                 java.lang.Throwable t)
This is a log metod with logLevel == INFO

warn

public void warn(java.lang.String message)
This is a log metod with logLevel == WARN

warn

public void warn(java.lang.String message,
                 java.lang.Throwable t)
This is a log metod with logLevel == WARN

warn

public void warn(java.lang.String message,
                 RunData data)
This is a log metod with logLevel == WARN

warn

public void warn(java.lang.String message,
                 RunData data,
                 java.lang.Throwable t)
This is a log metod with logLevel == WARN

error

public void error(java.lang.String message)
This is a log metod with logLevel == ERROR

error

public void error(java.lang.String message,
                  java.lang.Throwable e)
This is a log metod with logLevel == ERROR

error

public void error(java.lang.Throwable e)
This is a log metod with logLevel == ERROR

error

public void error(java.lang.String message,
                  RunData data)
This is a log metod with logLevel == ERROR

error

public void error(java.lang.String message,
                  RunData data,
                  java.lang.Throwable e)
This is a log metod with logLevel == ERROR


Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.