org.apache.tomcat.util.log.LogHandler Maven / Gradle / Ivy
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 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.
*/
package org.apache.tomcat.util.log;
import org.apache.tomcat.util.log.*;
import java.io.Writer;
import java.io.PrintWriter;
import java.io.FileWriter;
import java.io.File;
import java.io.OutputStreamWriter;
import java.io.IOException;
import java.io.StringWriter;
import java.util.*;
/**
* Log destination ( or channel ). This is the base class that will be
* extended by log handlers - tomcat uses util.qlog.QueueLogger,
* in future we'll use log4j or java.util.logger adapters.
*
* The base class writes to a (default) writer, and it can
* be used for very simple logging.
*
* @author Anil Vijendran ([email protected])
* @author Alex Chaffee ([email protected])
* @author Ignacio J. Ortega ([email protected])
* @author Costin Manolache
*/
public class LogHandler {
protected PrintWriter sink = defaultSink;
protected int level = Log.INFORMATION;
/**
* Prints log message and stack trace.
* This method should be overriden by real logger implementations
*
* @param prefix optional prefix.
* @param message the message to log.
* @param t the exception that was thrown.
* @param verbosityLevel what type of message is this?
* (WARNING/DEBUG/INFO etc)
*/
public void log(String prefix, String msg, Throwable t,
int verbosityLevel)
{
if( sink==null ) return;
// default implementation ( in case no real logging is set up )
if( verbosityLevel > this.level ) return;
if (prefix != null)
sink.println(prefix + ": " + msg );
else
sink.println( msg );
if( t!=null )
t.printStackTrace( sink );
}
/**
* Flush the log.
*/
public void flush() {
if( sink!=null)
sink.flush();
}
/**
* Close the log.
*/
public synchronized void close() {
this.sink = null;
}
/**
* Set the verbosity level for this logger. This controls how the
* logs will be filtered.
*
* @param level one of the verbosity level codes.
*/
public void setLevel(int level) {
this.level = level;
}
/**
* Get the current verbosity level.
*/
public int getLevel() {
return this.level;
}
// -------------------- Default sink
protected static PrintWriter defaultSink =
new PrintWriter( new OutputStreamWriter(System.err), true);
/**
* Set the default output stream that is used by all logging
* channels.
*
* @param w the default output stream.
*/
public static void setDefaultSink(Writer w) {
if( w instanceof PrintWriter )
defaultSink=(PrintWriter)w;
else
defaultSink = new PrintWriter(w);
}
// -------------------- General purpose utilitiy --------------------
}