org.apache.catalina.logger
Class LoggerBase

java.lang.Object
  extended byorg.apache.catalina.logger.LoggerBase
All Implemented Interfaces:
Lifecycle, Logger, javax.management.MBeanRegistration
Direct Known Subclasses:
FileLogger, SystemErrLogger, SystemOutLogger

public class LoggerBase
extends java.lang.Object
implements Lifecycle, Logger, javax.management.MBeanRegistration

Convenience base class for Logger implementations. The only method that must be implemented is log(String msg), plus any property setting and lifecycle methods required for configuration.

Version:
$Revision: 1.9 $ $Date: 2004/05/26 15:48:29 $
Author:
Craig R. McClanahan

Field Summary
protected  Container container
          The Container with which this Logger has been associated.
protected  javax.management.ObjectName controller
           
protected  int debug
          The debugging detail level for this component.
protected  java.lang.String domain
           
protected  java.lang.String host
           
protected static java.lang.String info
          The descriptive information about this implementation.
protected  LifecycleSupport lifecycle
          The lifecycle event support for this component.
protected  javax.management.MBeanServer mserver
           
protected  javax.management.ObjectName oname
           
protected  java.lang.String path
           
protected  java.beans.PropertyChangeSupport support
          The property change support for this component.
protected  int verbosity
          The verbosity level for above which log messages may be filtered.
 
Fields inherited from interface org.apache.catalina.Lifecycle
AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, START_EVENT, STOP_EVENT
 
Fields inherited from interface org.apache.catalina.Logger
DEBUG, ERROR, FATAL, INFORMATION, WARNING
 
Constructor Summary
LoggerBase()
           
 
Method Summary
 void addLifecycleListener(LifecycleListener listener)
          Add a lifecycle event listener to this component.
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Add a property change listener to this component.
 javax.management.ObjectName createObjectName()
           
 void destroy()
           
 LifecycleListener[] findLifecycleListeners()
          Get the lifecycle listeners associated with this lifecycle.
 Container getContainer()
          Return the Container with which this Logger has been associated.
 javax.management.ObjectName getController()
           
 int getDebug()
          Return the debugging detail level for this component.
 java.lang.String getDomain()
           
 java.lang.String getInfo()
          Return descriptive information about this Logger implementation and the corresponding version number, in the format <description>/<version>.
 javax.management.ObjectName getObjectName()
           
 int getVerbosity()
          Return the verbosity level of this logger.
 void init()
           
 void log(java.lang.Exception exception, java.lang.String msg)
          Writes the specified exception, and message, to a servlet log file.
 void log(java.lang.String msg)
          Writes the specified message to a servlet log file, usually an event log.
 void log(java.lang.String message, int verbosity)
          Writes the specified message to the servlet log file, usually an event log, if the logger is set to a verbosity level equal to or higher than the specified value for this message.
 void log(java.lang.String msg, java.lang.Throwable throwable)
          Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file.
 void log(java.lang.String message, java.lang.Throwable throwable, int verbosity)
          Writes the specified message and exception to the servlet log file, usually an event log, if the logger is set to a verbosity level equal to or higher than the specified value for this message.
 void postDeregister()
           
 void postRegister(java.lang.Boolean registrationDone)
           
 void preDeregister()
           
 javax.management.ObjectName preRegister(javax.management.MBeanServer server, javax.management.ObjectName name)
           
 void removeLifecycleListener(LifecycleListener listener)
          Remove a lifecycle event listener from this component.
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Remove a property change listener from this component.
 void setContainer(Container container)
          Set the Container with which this Logger has been associated.
 void setController(javax.management.ObjectName controller)
           
 void setDebug(int debug)
          Set the debugging detail level for this component.
 void setVerbosity(int verbosity)
          Set the verbosity level of this logger.
 void setVerbosityLevel(java.lang.String verbosity)
          Set the verbosity level of this logger.
 void start()
          Prepare for the beginning of active use of the public methods of this component.
 void stop()
          Gracefully terminate the active use of the public methods of this component.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

container

protected Container container
The Container with which this Logger has been associated.


debug

protected int debug
The debugging detail level for this component.


info

protected static final java.lang.String info
The descriptive information about this implementation.

See Also:
Constant Field Values

lifecycle

protected LifecycleSupport lifecycle
The lifecycle event support for this component.


support

protected java.beans.PropertyChangeSupport support
The property change support for this component.


verbosity

protected int verbosity
The verbosity level for above which log messages may be filtered.


domain

protected java.lang.String domain

host

protected java.lang.String host

path

protected java.lang.String path

oname

protected javax.management.ObjectName oname

controller

protected javax.management.ObjectName controller

mserver

protected javax.management.MBeanServer mserver
Constructor Detail

LoggerBase

public LoggerBase()
Method Detail

getContainer

public Container getContainer()
Return the Container with which this Logger has been associated.

Specified by:
getContainer in interface Logger

setContainer

public void setContainer(Container container)
Set the Container with which this Logger has been associated.

Specified by:
setContainer in interface Logger
Parameters:
container - The associated Container

getDebug

public int getDebug()
Return the debugging detail level for this component.


setDebug

public void setDebug(int debug)
Set the debugging detail level for this component.

Parameters:
debug - The new debugging detail level

getInfo

public java.lang.String getInfo()
Return descriptive information about this Logger implementation and the corresponding version number, in the format <description>/<version>.

Specified by:
getInfo in interface Logger

getVerbosity

public int getVerbosity()
Return the verbosity level of this logger. Messages logged with a higher verbosity than this level will be silently ignored.

Specified by:
getVerbosity in interface Logger

setVerbosity

public void setVerbosity(int verbosity)
Set the verbosity level of this logger. Messages logged with a higher verbosity than this level will be silently ignored.

Specified by:
setVerbosity in interface Logger
Parameters:
verbosity - The new verbosity level

setVerbosityLevel

public void setVerbosityLevel(java.lang.String verbosity)
Set the verbosity level of this logger. Messages logged with a higher verbosity than this level will be silently ignored.

Parameters:
verbosity - The new verbosity level, as a string

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Add a property change listener to this component.

Specified by:
addPropertyChangeListener in interface Logger
Parameters:
listener - The listener to add

log

public void log(java.lang.String msg)
Writes the specified message to a servlet log file, usually an event log. The name and type of the servlet log is specific to the servlet container. This message will be logged unconditionally.

Specified by:
log in interface Logger
Parameters:
msg - A String specifying the message to be written to the log file

log

public void log(java.lang.Exception exception,
                java.lang.String msg)
Writes the specified exception, and message, to a servlet log file. The implementation of this method should call log(msg, exception) instead. This method is deprecated in the ServletContext interface, but not deprecated here to avoid many useless compiler warnings. This message will be logged unconditionally.

Specified by:
log in interface Logger
Parameters:
exception - An Exception to be reported
msg - The associated message string

log

public void log(java.lang.String msg,
                java.lang.Throwable throwable)
Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file. The name and type of the servlet log file is specific to the servlet container, usually an event log. This message will be logged unconditionally.

Specified by:
log in interface Logger
Parameters:
msg - A String that describes the error or exception
throwable - The Throwable error or exception

log

public void log(java.lang.String message,
                int verbosity)
Writes the specified message to the servlet log file, usually an event log, if the logger is set to a verbosity level equal to or higher than the specified value for this message.

Specified by:
log in interface Logger
Parameters:
message - A String specifying the message to be written to the log file
verbosity - Verbosity level of this message

log

public void log(java.lang.String message,
                java.lang.Throwable throwable,
                int verbosity)
Writes the specified message and exception to the servlet log file, usually an event log, if the logger is set to a verbosity level equal to or higher than the specified value for this message.

Specified by:
log in interface Logger
Parameters:
message - A String that describes the error or exception
throwable - The Throwable error or exception
verbosity - Verbosity level of this message

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Remove a property change listener from this component.

Specified by:
removePropertyChangeListener in interface Logger
Parameters:
listener - The listener to remove

getController

public javax.management.ObjectName getController()

setController

public void setController(javax.management.ObjectName controller)

getObjectName

public javax.management.ObjectName getObjectName()

getDomain

public java.lang.String getDomain()

preRegister

public javax.management.ObjectName preRegister(javax.management.MBeanServer server,
                                               javax.management.ObjectName name)
                                        throws java.lang.Exception
Specified by:
preRegister in interface javax.management.MBeanRegistration
Throws:
java.lang.Exception

postRegister

public void postRegister(java.lang.Boolean registrationDone)
Specified by:
postRegister in interface javax.management.MBeanRegistration

preDeregister

public void preDeregister()
                   throws java.lang.Exception
Specified by:
preDeregister in interface javax.management.MBeanRegistration
Throws:
java.lang.Exception

postDeregister

public void postDeregister()
Specified by:
postDeregister in interface javax.management.MBeanRegistration

init

public void init()

destroy

public void destroy()

createObjectName

public javax.management.ObjectName createObjectName()

addLifecycleListener

public void addLifecycleListener(LifecycleListener listener)
Add a lifecycle event listener to this component.

Specified by:
addLifecycleListener in interface Lifecycle
Parameters:
listener - The listener to add

findLifecycleListeners

public LifecycleListener[] findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle. If this Lifecycle has no listeners registered, a zero-length array is returned.

Specified by:
findLifecycleListeners in interface Lifecycle

removeLifecycleListener

public void removeLifecycleListener(LifecycleListener listener)
Remove a lifecycle event listener from this component.

Specified by:
removeLifecycleListener in interface Lifecycle
Parameters:
listener - The listener to add

start

public void start()
           throws LifecycleException
Prepare for the beginning of active use of the public methods of this component. This method should be called after configure(), and before any of the public methods of the component are utilized.

Specified by:
start in interface Lifecycle
Throws:
LifecycleException - if this component detects a fatal error that prevents this component from being used

stop

public void stop()
          throws LifecycleException
Gracefully terminate the active use of the public methods of this component. This method should be the last one called on a given instance of this component.

Specified by:
stop in interface Lifecycle
Throws:
LifecycleException - if this component detects a fatal error that needs to be reported


Copyright ? 2000-2003 Apache Software Foundation. All Rights Reserved.