org.apache.tomcat.util.log

Class LogHandler

java.lang.Object

org.apache.tomcat.util.log.LogHandler

Direct Known Subclasses:

CommonLogHandler

public class LogHandler
extends Object

Log destination ( or channel ). This is the base class that will be extended by log handlers - tomcat uses util.qlog.QueueLogger, in future we'll use log4j or java.util.logger adapters. The base class writes to a (default) writer, and it can be used for very simple logging.

Author:

Anil Vijendran (akv@eng.sun.com), Alex Chaffee (alex@jguru.com), Ignacio J. Ortega (nacho@siapi.es), Costin Manolache

Field Summary

Fields

Modifier and Type	Field and Description
protected static PrintWriter	defaultSink
protected int	level
protected PrintWriter	sink

Constructor Summary

Constructors

Constructor and Description
LogHandler()

Method Summary

Modifier and Type	Method and Description
void	close() Close the log.
void	flush() Flush the log.
int	getLevel() Get the current verbosity level.
void	log(String prefix, String msg, Throwable t, int verbosityLevel) Prints log message and stack trace.
static void	setDefaultSink(Writer w) Set the default output stream that is used by all logging channels.
void	setLevel(int level) Set the verbosity level for this logger.

Methods inherited from class java.lang.Object

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

Field Detail

sink

protected PrintWriter sink

level

protected int level

defaultSink

protected static PrintWriter defaultSink

Constructor Detail

LogHandler

public LogHandler()

Method Detail

log

public void log(String prefix,
                String msg,
                Throwable t,
                int verbosityLevel)

Prints log message and stack trace. This method should be overriden by real logger implementations

Parameters:

prefix - optional prefix.

message - the message to log.

t - the exception that was thrown.

verbosityLevel - what type of message is this? (WARNING/DEBUG/INFO etc)

flush

public void flush()

Flush the log.

close

public void close()

Close the log.

setLevel

public void setLevel(int level)

Set the verbosity level for this logger. This controls how the logs will be filtered.

Parameters:

level - one of the verbosity level codes.

getLevel

public int getLevel()

Get the current verbosity level.

setDefaultSink

public static void setDefaultSink(Writer w)

Set the default output stream that is used by all logging channels.

Parameters:

w - the default output stream.