FileDocCategorySizeDatePackage
LoggerBase.javaAPI DocGlassfish v2 API8388Fri May 04 22:35:30 BST 2007com.sun.enterprise.web.logger

LoggerBase

public abstract class LoggerBase extends Object implements org.apache.catalina.Logger
Convenience base class for Logger implementations. The only method that must be implemented is write(String msg, int verbosity), plus any property setting and lifecycle methods required for configuration.

Fields Summary
protected org.apache.catalina.Container
container
The Container with which this Logger has been associated.
protected static final String
info
The descriptive information about this implementation.
protected PropertyChangeSupport
support
The property change support for this component.
Constructors Summary
Methods Summary
public voidaddPropertyChangeListener(java.beans.PropertyChangeListener listener)
Add a property change listener to this component.

param
listener The listener to add

        support.addPropertyChangeListener(listener);
    
public org.apache.catalina.ContainergetContainer()
Return the Container with which this Logger has been associated.


    // ------------------------------------------------------------- Properties

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

        return (info);
    
public intgetVerbosity()
Logger interface method (ignored)

        //Ignored
        return -1;
    
public voidlog(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.

param
message A String specifying the message to be written to the log file
param
verbosity Verbosity level of this message

        write(message, verbosity);
    
public voidlog(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.

param
message A String that describes the error or exception
param
throwable The Throwable error or exception
param
verbosity Verbosity level of this message

        write(message, throwable, verbosity);
    
public voidlog(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.

param
message A String specifying the message to be written to the log file

        write(msg, DEBUG);
    
public voidlog(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.

param
exception An Exception to be reported
param
msg The associated message string

        log(msg, exception);
    
public voidlog(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.

param
msg A String that describes the error or exception
param
throwable The Throwable error or exception

        write(msg, throwable, ERROR);
    
public voidremovePropertyChangeListener(java.beans.PropertyChangeListener listener)
Remove a property change listener from this component.

param
listener The listener to remove

        support.removePropertyChangeListener(listener);
    
public voidsetContainer(org.apache.catalina.Container container)
Set the Container with which this Logger has been associated.

param
container The associated Container


        Container oldContainer = this.container;
        this.container = container;
        support.firePropertyChange("container", oldContainer, this.container);
    
public voidsetVerbosity(int verbosity)
Logger interface method (ignored)

param
verbosity The new verbosity level

        //Ignored
    
protected voidwrite(java.lang.String msg, java.lang.Throwable throwable, int verbosity)

        CharArrayWriter buf = new CharArrayWriter();
        PrintWriter writer = new PrintWriter(buf);
        writer.println(msg);
        throwable.printStackTrace(writer);
        Throwable rootCause = null;
        if (throwable instanceof LifecycleException)
            rootCause = ((LifecycleException) throwable).getThrowable();
        else if (throwable instanceof ServletException)
            rootCause = ((ServletException) throwable).getRootCause();
        if (rootCause != null) {
            writer.println("----- Root Cause -----");
            rootCause.printStackTrace(writer);
        }
        write(buf.toString(), verbosity);
    
protected abstract voidwrite(java.lang.String msg, int verbosity)
Logs the given message at the given verbosity level.