org.apache.catalina.logger.LoggerBase Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2016 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Portions Copyright [2019-2021] Payara Foundation and/or affiliates
package org.apache.catalina.logger;
import org.apache.catalina.Container;
import org.apache.catalina.Lifecycle;
import org.apache.catalina.LifecycleException;
import org.apache.catalina.LifecycleListener;
import org.apache.catalina.LogFacade;
import org.apache.catalina.core.StandardContext;
import org.apache.catalina.core.StandardEngine;
import org.apache.catalina.core.StandardHost;
import org.apache.catalina.util.LifecycleSupport;
import javax.management.ObjectName;
import jakarta.servlet.ServletException;
import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeSupport;
import java.io.CharArrayWriter;
import java.io.PrintWriter;
import java.text.MessageFormat;
import java.util.List;
import java.util.ResourceBundle;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.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.
*
* @author Craig R. McClanahan
* @version $Revision: 1.4 $ $Date: 2006/10/07 01:14:23 $
*/
public class LoggerBase implements Lifecycle, org.apache.catalina.Logger {
protected static final Logger log = LogFacade.getLogger();
protected static final ResourceBundle rb = log.getResourceBundle();
// ----------------------------------------------------- Instance Variables
/**
* The Container with which this Logger has been associated.
*/
protected Container container = null;
/**
* The debugging detail level for this component.
*/
protected int debug = 0;
/**
* The descriptive information about this implementation.
*/
protected static final String info =
"org.apache.catalina.logger.LoggerBase/1.0";
/**
* The lifecycle event support for this component.
*/
protected LifecycleSupport lifecycle = new LifecycleSupport(this);
/**
* The property change support for this component.
*/
protected PropertyChangeSupport support = new PropertyChangeSupport(this);
/**
* The verbosity level for above which log messages may be filtered.
*/
protected int verbosity = ERROR;
// ------------------------------------------------------------- Properties
/**
* Return the Container with which this Logger has been associated.
*/
@Override
public Container getContainer() {
return (container);
}
/**
* Set the Container with which this Logger has been associated.
*
* @param container The associated Container
*/
@Override
public void setContainer(Container container) {
Container oldContainer = this.container;
this.container = container;
support.firePropertyChange("container", oldContainer, this.container);
}
/**
* Return the debugging detail level for this component.
*/
public int getDebug() {
return (this.debug);
}
/**
* Set the debugging detail level for this component.
*
* @param debug The new debugging detail level
*/
public void setDebug(int debug) {
this.debug = debug;
}
/**
* Return descriptive information about this Logger implementation and
* the corresponding version number, in the format
* <description>/<version>.
*/
@Override
public String getInfo() {
return (info);
}
/**
* Return the verbosity level of this logger. Messages logged with a
* higher verbosity than this level will be silently ignored.
*/
@Override
public int getVerbosity() {
return (this.verbosity);
}
/**
* Set the verbosity level of this logger. Messages logged with a
* higher verbosity than this level will be silently ignored.
*
* @param verbosity The new verbosity level
*/
@Override
public void setVerbosity(int verbosity) {
this.verbosity = verbosity;
}
/**
* Set the verbosity level of this logger. Messages logged with a
* higher verbosity than this level will be silently ignored.
*
* @param verbosityLevel The new verbosity level, as a string
*/
public void setVerbosityLevel(String verbosity) {
if ("FATAL".equalsIgnoreCase(verbosity))
this.verbosity = FATAL;
else if ("ERROR".equalsIgnoreCase(verbosity))
this.verbosity = ERROR;
else if ("WARNING".equalsIgnoreCase(verbosity))
this.verbosity = WARNING;
else if ("INFORMATION".equalsIgnoreCase(verbosity))
this.verbosity = INFORMATION;
else if ("DEBUG".equalsIgnoreCase(verbosity))
this.verbosity = DEBUG;
}
/**
* Set the verbosity level of this logger. Messages logged with a
* higher verbosity than this level will be silently ignored.
*
* @param verbosityLevel The new verbosity level, as a string
*/
public void setLevel(String logLevel) {
if ("SEVERE".equalsIgnoreCase(logLevel)) {
log.setLevel(Level.SEVERE);
} else if ("WARNING".equalsIgnoreCase(logLevel)) {
log.setLevel(Level.WARNING);
} else if ("INFO".equalsIgnoreCase(logLevel)) {
log.setLevel(Level.INFO);
} else if ("CONFIG".equalsIgnoreCase(logLevel)) {
log.setLevel(Level.CONFIG);
} else if ("FINE".equalsIgnoreCase(logLevel)) {
log.setLevel(Level.FINE);
} else if ("FINER".equalsIgnoreCase(logLevel)) {
log.setLevel(Level.FINER);
} else if ("FINEST".equalsIgnoreCase(logLevel)) {
log.setLevel(Level.FINEST);
} else {
log.setLevel(Level.INFO);
}
}
public void addHandler(Handler handler) {
log.setUseParentHandlers(false);
handler.setLevel(log.getLevel());
log.addHandler(handler);
}
// --------------------------------------------------------- Public Methods
/**
* Add a property change listener to this component.
*
* @param listener The listener to add
*/
@Override
public void addPropertyChangeListener(PropertyChangeListener listener) {
support.addPropertyChangeListener(listener);
}
/**
* 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.
*
* @param msg A String specifying the message to be
* written to the log file
*/
@Override
public void log(String msg) {
log.log(Level.FINE, 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
*/
@Override
public void log(Exception exception, String msg) {
log(msg, exception);
}
/**
* 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
*/
@Override
public void log(String msg, Throwable throwable) {
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).getCause();
else if (throwable instanceof ServletException)
rootCause = ((ServletException) throwable).getRootCause();
if (rootCause != null) {
writer.println("----- Root Cause -----");
rootCause.printStackTrace(writer);
}
log(buf.toString());
}
/**
* 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
*/
@Override
public void log(String message, int verbosity) {
if (this.verbosity >= verbosity) {
log(message);
}
}
/**
* 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
*/
@Override
public void log(String message, Throwable throwable, int verbosity) {
if (this.verbosity >= verbosity) {
log(message, throwable);
}
}
/**
* Remove a property change listener from this component.
*
* @param listener The listener to remove
*/
@Override
public void removePropertyChangeListener(PropertyChangeListener listener) {
support.removePropertyChangeListener(listener);
}
protected ObjectName oname;
protected ObjectName controller;
public ObjectName getController() {
return controller;
}
public void setController(ObjectName controller) {
this.controller = controller;
}
public ObjectName getObjectName() {
return oname;
}
public void init() {
}
public void destroy() {
}
public ObjectName createObjectName() {
if(log.isLoggable(Level.FINE)) {
log.log(Level.FINE, "createObjectName with {0}", container);
}
// register
try {
StandardEngine engine=null;
String suffix="";
if( container instanceof StandardEngine ) {
engine=(StandardEngine)container;
} else if( container instanceof StandardHost ) {
engine=(StandardEngine)container.getParent();
suffix=",host=" + container.getName();
} else if( container instanceof StandardContext ) {
String path = ((StandardContext)container).getPath();
// add "/" to avoid MalformedObjectName Exception
if (path.equals("")) {
path = "/";
}
engine=(StandardEngine)container.getParent().getParent();
suffix= ",path=" + path + ",host=" +
container.getParent().getName();
} else {
log.log(Level.SEVERE, LogFacade.UNKNOWN_CONTAINER_EXCEPTION);
}
if( engine != null ) {
oname=new ObjectName(engine.getDomain()+ ":type=Logger" + suffix);
} else {
log.log(Level.SEVERE, LogFacade.NULL_ENGINE_EXCEPTION, container);
}
} catch (Throwable e) {
log.log(Level.WARNING,LogFacade.UNABLE_CREATE_OBJECT_NAME_FOR_LOGGER_EXCEPTION, e);
}
return oname;
}
// ------------------------------------------------------ Lifecycle Methods
/**
* Add a lifecycle event listener to this component.
*
* @param listener The listener to add
*/
@Override
public void addLifecycleListener(LifecycleListener listener) {
lifecycle.addLifecycleListener(listener);
}
/**
* Gets the (possibly empty) list of lifecycle listeners
* associated with this LoggerBase.
*/
@Override
public List findLifecycleListeners() {
return lifecycle.findLifecycleListeners();
}
/**
* Remove a lifecycle event listener from this component.
*
* @param listener The listener to add
*/
@Override
public void removeLifecycleListener(LifecycleListener listener) {
lifecycle.removeLifecycleListener(listener);
}
/**
* 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 error
* that prevents this component from being used
*/
@Override
public void start() throws LifecycleException {
// register this logger
if ( getObjectName()==null ) {
ObjectName oname = createObjectName();
try {
if (log.isLoggable(Level.FINE)) {
log.log(Level.FINE, "Registering logger {0}", oname);
}
} catch( Exception ex ) {
String msg = MessageFormat.format(rb.getString(LogFacade.CANNOT_REGISTER_LOGGER_EXCEPTION),
oname);
log.log(Level.SEVERE, msg, ex);
}
}
}
/**
* 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 error
* that needs to be reported
*/
@Override
public void stop() throws LifecycleException {
// unregister this logger
if ( getObjectName()!=null ) {
ObjectName oname = createObjectName();
try {
if (log.isLoggable(Level.FINE)) {
log.log(Level.FINE, "Unregistering logger {0}", oname);
}
} catch( Exception ex ) {
String msg = MessageFormat.format(rb.getString(LogFacade.CANNOT_REGISTER_LOGGER_EXCEPTION),
oname);
log.log(Level.SEVERE, msg, ex);
}
}
}
}