001/**
002 * Copyright (c) 2004-2011 QOS.ch
003 * All rights reserved.
004 *
005 * Permission is hereby granted, free  of charge, to any person obtaining
006 * a  copy  of this  software  and  associated  documentation files  (the
007 * "Software"), to  deal in  the Software without  restriction, including
008 * without limitation  the rights to  use, copy, modify,  merge, publish,
009 * distribute,  sublicense, and/or sell  copies of  the Software,  and to
010 * permit persons to whom the Software  is furnished to do so, subject to
011 * the following conditions:
012 *
013 * The  above  copyright  notice  and  this permission  notice  shall  be
014 * included in all copies or substantial portions of the Software.
015 *
016 * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
017 * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
018 * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
019 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
020 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
021 * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION
022 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
023 *
024 */
025package org.slf4j.spi;
026
027import org.slf4j.Logger;
028import org.slf4j.Marker;
029
030/**
031 * An <b>optional</b> interface helping integration with logging systems capable of 
032 * extracting location information. This interface is mainly used by SLF4J bridges 
033 * such as jcl-over-slf4j, jul-to-slf4j and log4j-over-slf4j or {@link Logger} wrappers
034 * which need to provide hints so that the underlying logging system can extract
035 * the correct location information (method name, line number).
036 *
037 * @author Ceki Gulcu
038 * @since 1.3
039 */
040public interface LocationAwareLogger extends Logger {
041
042    // these constants should be in EventContants. However, in order to preserve binary backward compatibility
043    // we keep these constants here
044    final public int TRACE_INT = 00;
045    final public int DEBUG_INT = 10;
046    final public int INFO_INT = 20;
047    final public int WARN_INT = 30;
048    final public int ERROR_INT = 40;
049
050    /**
051     * Printing method with support for location information. 
052     * 
053     * @param marker The marker to be used for this event, may be null.
054     * @param fqcn The fully qualified class name of the <b>logger instance</b>,
055     * typically the logger class, logger bridge or a logger wrapper.
056     * @param level One of the level integers defined in this interface
057     * @param message The message for the log event
058     * @param t Throwable associated with the log event, may be null.
059     */
060    public void log(Marker marker, String fqcn, int level, String message, Object[] argArray, Throwable t);
061
062}