LoggerBase (Payara Project 5.193 API)

java.lang.Object
- org.apache.catalina.logger.LoggerBase

All Implemented Interfaces:

Lifecycle, Logger

Direct Known Subclasses:

FileLogger, SystemErrLogger, SystemOutLogger
```
public class LoggerBase
extends Object
implements Lifecycle, Logger
```
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.4 $ $Date: 2006/10/07 01:14:23 $

Author:

Craig R. McClanahan

Field Summary

Fields
Modifier and Type	Field and Description
`protected Container`	`container` The Container with which this Logger has been associated.
`protected ObjectName`	`controller`
`protected int`	`debug` The debugging detail level for this component.
`protected static String`	`info` The descriptive information about this implementation.
`protected LifecycleSupport`	`lifecycle` The lifecycle event support for this component.
`protected static Logger`	`log`
`protected ObjectName`	`oname`
`protected static ResourceBundle`	`rb`
`protected 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, INIT_EVENT, START_EVENT, STOP_EVENT

Fields inherited from interface org.apache.catalina.Logger
DEBUG, ERROR, FATAL, INFORMATION, WARNING

Constructor Summary

Constructors
Constructor and Description

LoggerBase()

Constructors
Constructor and Description
`LoggerBase()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHandler(Handler handler)`
`void`	`addLifecycleListener(LifecycleListener listener)` Add a lifecycle event listener to this component.
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Add a property change listener to this component.
`ObjectName`	`createObjectName()`
`void`	`destroy()`
`List<LifecycleListener>`	`findLifecycleListeners()` Gets the (possibly empty) list of lifecycle listeners associated with this LoggerBase.
`Container`	`getContainer()` Return the Container with which this Logger has been associated.
`ObjectName`	`getController()`
`int`	`getDebug()` Return the debugging detail level for this component.
`String`	`getInfo()` Return descriptive information about this Logger implementation and the corresponding version number, in the format `<description>/<version>`.
`ObjectName`	`getObjectName()`
`int`	`getVerbosity()` Return the verbosity level of this logger.
`void`	`init()`
`void`	`log(Exception exception, String msg)` Writes the specified exception, and message, to a servlet log file.
`void`	`log(String msg)` Writes the specified message to a servlet log file, usually an event log.
`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.
`void`	`log(String msg, Throwable throwable)` Writes an explanatory message and a stack trace for a given `Throwable` exception to the servlet log file.
`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.
`void`	`removeLifecycleListener(LifecycleListener listener)` Remove a lifecycle event listener from this component.
`void`	`removePropertyChangeListener(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(ObjectName controller)`
`void`	`setDebug(int debug)` Set the debugging detail level for this component.
`void`	`setLevel(String logLevel)` Set the verbosity level of this logger.
`void`	`setVerbosity(int verbosity)` Set the verbosity level of this logger.
`void`	`setVerbosityLevel(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
  - log
```
protected static final Logger log
```
  - rb
```
protected static final ResourceBundle rb
```
  - 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 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 PropertyChangeSupport support
```
    The property change support for this component.
  - verbosity
```
protected int verbosity
```
    The verbosity level for above which log messages may be filtered.
  - oname
```
protected ObjectName oname
```
  - controller
```
protected ObjectName controller
```
- 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 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(String verbosity)
```
    Set the verbosity level of this logger. Messages logged with a higher verbosity than this level will be silently ignored.
    
    Parameters:
    
    verbosityLevel - The new verbosity level, as a string
  - setLevel
```
public void setLevel(String logLevel)
```
    Set the verbosity level of this logger. Messages logged with a higher verbosity than this level will be silently ignored.
    
    Parameters:
    
    verbosityLevel - The new verbosity level, as a string
  - addHandler
```
public void addHandler(Handler handler)
```
  - addPropertyChangeListener
```
public void addPropertyChangeListener(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(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(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. 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(String msg,
                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(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(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.
    
    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(PropertyChangeListener listener)
```
    Remove a property change listener from this component.
    
    Specified by:
    
    removePropertyChangeListener in interface Logger
    
    Parameters:
    
    listener - The listener to remove
  - getController
```
public ObjectName getController()
```
  - setController
```
public void setController(ObjectName controller)
```
  - getObjectName
```
public ObjectName getObjectName()
```
  - init
```
public void init()
```
  - destroy
```
public void destroy()
```
  - createObjectName
```
public 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 List<LifecycleListener> findLifecycleListeners()
```
    Gets the (possibly empty) list of lifecycle listeners associated with this LoggerBase.
    
    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

Class LoggerBase

Field Summary

Fields inherited from interface org.apache.catalina.Lifecycle

Fields inherited from interface org.apache.catalina.Logger

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

rb

container

debug

info

lifecycle

support

verbosity

oname

controller

Constructor Detail

LoggerBase

Method Detail

getContainer

setContainer

getDebug

setDebug

getInfo

getVerbosity

setVerbosity

setVerbosityLevel

setLevel

addHandler

addPropertyChangeListener

log

log

log

log

log

removePropertyChangeListener

getController

setController

getObjectName

init

destroy

createObjectName

addLifecycleListener

findLifecycleListeners

removeLifecycleListener

start

stop