| java.lang.Object
 org.apache.catalina.logger.LoggerBase
All known Subclasses: org.apache.catalina.logger.FileLogger, org.apache.catalina.logger.SystemErrLogger, org.apache.catalina.logger.SystemOutLogger,
| LoggerBase | | public class LoggerBase implements Lifecycle,Logger,MBeanRegistration(Code) | | 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.
author:
Craig R. McClanahan
version:
$Revision: 1.9 $ $Date: 2004/05/26 15:48:29 $ |
| Method Summary | |
| public void | addLifecycleListener(LifecycleListener listener)
Add a lifecycle event listener to this component. | | public void | addPropertyChangeListener(PropertyChangeListener listener)
Add a property change listener to this component. | | public ObjectName | createObjectName()
| | public void | destroy()
| | public LifecycleListener[] | findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle. | | public Container | getContainer()
Return the Container with which this Logger has been associated. | | public ObjectName | getController()
| | public int | getDebug()
Return the debugging detail level for this component. | | public String | getDomain()
| | public String | getInfo()
Return descriptive information about this Logger implementation and
the corresponding version number, in the format
<description>/<version>. | | public ObjectName | getObjectName()
| | public int | getVerbosity()
Return the verbosity level of this logger. | | public void | init()
| | public void | log(String msg)
Writes the specified message to a servlet log file, usually an event
log. | | public void | log(Exception exception, String msg)
Writes the specified exception, and message, to a servlet log file.
The implementation of this method should call
log(msg, exception) instead. | | public void | log(String msg, Throwable throwable)
Writes an explanatory message and a stack trace for a given
Throwable exception to the servlet log file. | | public void | log(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. | | public void | log(String message, 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. | | public void | postDeregister()
| | public void | postRegister(Boolean registrationDone)
| | public void | preDeregister()
| | public ObjectName | preRegister(MBeanServer server, ObjectName name)
| | public void | removeLifecycleListener(LifecycleListener listener)
Remove a lifecycle event listener from this component. | | public void | removePropertyChangeListener(PropertyChangeListener listener)
Remove a property change listener from this component. | | public void | setContainer(Container container)
Set the Container with which this Logger has been associated. | | public void | setController(ObjectName controller)
| | public void | setDebug(int debug)
Set the debugging detail level for this component. | | public void | setVerbosity(int verbosity)
Set the verbosity level of this logger. | | public void | setVerbosityLevel(String verbosity)
Set the verbosity level of this logger. | | public void | start()
Prepare for the beginning of active use of the public methods of this
component. | | public void | stop()
Gracefully terminate the active use of the public methods of this
component. |
| container | | protected Container container(Code) | | The Container with which this Logger has been associated.
|
| debug | | protected int debug(Code) | | The debugging detail level for this component.
|
| info | | final protected static String info(Code) | | The descriptive information about this implementation.
|
| verbosity | | protected int verbosity(Code) | | The verbosity level for above which log messages may be filtered.
|
| addLifecycleListener | | public void addLifecycleListener(LifecycleListener listener)(Code) | | Add a lifecycle event listener to this component.
Parameters:
listener - The listener to add |
| addPropertyChangeListener | | public void addPropertyChangeListener(PropertyChangeListener listener)(Code) | | Add a property change listener to this component.
Parameters:
listener - The listener to add |
| destroy | | public void destroy()(Code) | | |
| findLifecycleListeners | | public LifecycleListener[] findLifecycleListeners()(Code) | | Get the lifecycle listeners associated with this lifecycle. If this
Lifecycle has no listeners registered, a zero-length array is returned.
|
| getContainer | | public Container getContainer()(Code) | | Return the Container with which this Logger has been associated.
|
| getDebug | | public int getDebug()(Code) | | Return the debugging detail level for this component.
|
| getInfo | | public String getInfo()(Code) | | Return descriptive information about this Logger implementation and
the corresponding version number, in the format
<description>/<version>.
|
| getVerbosity | | public int getVerbosity()(Code) | | Return the verbosity level of this logger. Messages logged with a
higher verbosity than this level will be silently ignored.
|
| log | | public void log(String msg)(Code) | | 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.
Parameters:
msg - A String specifying the message to bewritten to the log file |
| log | | public void log(Exception exception, String msg)(Code) | | 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.
Parameters:
exception - An Exception to be reported
Parameters:
msg - The associated message string |
| log | | public void log(String msg, Throwable throwable)(Code) | | 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.
Parameters:
msg - A String that describes the error orexception
Parameters:
throwable - The Throwable error or exception |
| log | | public void log(String message, int verbosity)(Code) | | 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.
Parameters:
message - A String specifying the message to bewritten to the log file
Parameters:
verbosity - Verbosity level of this message |
| log | | public void log(String message, Throwable throwable, int verbosity)(Code) | | 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.
Parameters:
message - A String that describes the error orexception
Parameters:
throwable - The Throwable error or exception
Parameters:
verbosity - Verbosity level of this message |
| postDeregister | | public void postDeregister()(Code) | | |
| postRegister | | public void postRegister(Boolean registrationDone)(Code) | | |
| removeLifecycleListener | | public void removeLifecycleListener(LifecycleListener listener)(Code) | | Remove a lifecycle event listener from this component.
Parameters:
listener - The listener to add |
| removePropertyChangeListener | | public void removePropertyChangeListener(PropertyChangeListener listener)(Code) | | Remove a property change listener from this component.
Parameters:
listener - The listener to remove |
| setContainer | | public void setContainer(Container container)(Code) | | Set the Container with which this Logger has been associated.
Parameters:
container - The associated Container |
| setDebug | | public void setDebug(int debug)(Code) | | Set the debugging detail level for this component.
Parameters:
debug - The new debugging detail level |
| setVerbosity | | public void setVerbosity(int verbosity)(Code) | | 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 |
| setVerbosityLevel | | public void setVerbosityLevel(String verbosity)(Code) | | 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 |
| start | | public void start() throws LifecycleException(Code) | | 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.
exception:
LifecycleException - if this component detects a fatal errorthat prevents this component from being used |
| stop | | public void stop() throws LifecycleException(Code) | | 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.
exception:
LifecycleException - if this component detects a fatal errorthat needs to be reported |
|
|