December 2006 - logback-dev

svn commit: r1078 - in logback/trunk: . log4j-bridge log4j-bridge/src log4j-bridge/src/main log4j-bridge/src/main/java log4j-bridge/src/main/java/org log4j-bridge/src/main/java/org/apache log4j-bridge/src/main/java/org/apache/log4j log4j-bridge/src/test log4j-bridge/src/test/java log4j-bridge/src/test/java/org log4j-bridge/src/test/java/org/apache log4j-bridge/src/test/java/org/apache/log4j logback-classic/src/main/java/ch/qos/logback/classic
by noreply.seb＠qos.ch 13 Dec '06

13 Dec '06

Author: seb Date: Wed Dec 13 14:27:05 2006 New Revision: 1078 Added: logback/trunk/log4j-bridge/ (props changed) logback/trunk/log4j-bridge/pom.xml logback/trunk/log4j-bridge/src/ logback/trunk/log4j-bridge/src/main/ logback/trunk/log4j-bridge/src/main/java/ logback/trunk/log4j-bridge/src/main/java/org/ logback/trunk/log4j-bridge/src/main/java/org/apache/ logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/ logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/Category.java logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/Level.java logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/Log4jLoggerFactory.java logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/Logger.java logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/Priority.java logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/package.html logback/trunk/log4j-bridge/src/test/ logback/trunk/log4j-bridge/src/test/java/ logback/trunk/log4j-bridge/src/test/java/org/ logback/trunk/log4j-bridge/src/test/java/org/apache/ logback/trunk/log4j-bridge/src/test/java/org/apache/log4j/ logback/trunk/log4j-bridge/src/test/java/org/apache/log4j/InvokeLog4jTest.java Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/Logger.java logback/trunk/pom.xml Log: Added a log4j bridge module Added: logback/trunk/log4j-bridge/pom.xml ============================================================================== --- (empty file) +++ logback/trunk/log4j-bridge/pom.xml Wed Dec 13 14:27:05 2006 @@ -0,0 +1,40 @@ +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> + + <parent> + <groupId>ch.qos.logback</groupId> + <artifactId>logback-parent</artifactId> + <version>0.7-SNAPSHOT</version> + </parent> + + <modelVersion>4.0.0</modelVersion> + + <groupId>ch.qos.logback</groupId> + <artifactId>log4j-bridge</artifactId> + <version>0.7-SNAPSHOT</version> + <packaging>jar</packaging> + <name>Log4j Bridge Module</name> + + <url>http://logback.qos.ch</url> + <description> +  + Logback: the generic, reliable, fast and flexible logging library for Java. + </description> + <licenses> + <license> + <name>Apache Software Licenses</name> + <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> + </license> + </licenses> + + <dependencies> + <dependency> + <groupId>ch.qos.logback</groupId> + <artifactId>logback-classic</artifactId> + </dependency> + </dependencies> + +</project> \ No newline at end of file Added: logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/Category.java ============================================================================== --- (empty file) +++ logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/Category.java Wed Dec 13 14:27:05 2006 @@ -0,0 +1,242 @@ +/* + * Copyright 2001-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.log4j; + +import org.slf4j.LoggerFactory; +import org.slf4j.Marker; +import org.slf4j.MarkerFactory; + +/** + * <p> + * This class is a minimal implementation of the origianl + * org.apache.log4j.Logger class delegating all calls to a + * {@link org.slf4j.Logger} instance, which in turn will delegate to a final + * logging system chosen by the user.. + * </p> + * + * <p> + * Log4j's <code>debug()</code>, <code>info()</code>, <code>warn()</code>, + * <code>error()</code> printing methods are directly mapped to their SLF4J + * equivalents. Log4j's <code>trace()</code> printing method is mapped to + * SLF4J's <code>debug()</code> method with a TRACE marker. Log4j's + * <code>fatal()</code> printing method is mapped to SLF4J's + * <code>error()</code> method with a FATAL marker. + * + * @author Sébastien Pennec + * @author Ceki Gülcü + */ + +public class Category { + + private String name; + + private ch.qos.logback.classic.Logger lbLogger; + + private static Marker TRACE_MARKER = MarkerFactory.getMarker("TRACE"); + private static Marker FATAL_MARKER = MarkerFactory.getMarker("FATAL"); + + Category(String name) { + this.name = name; + lbLogger = (ch.qos.logback.classic.Logger) LoggerFactory.getLogger(name); + } + + public static Logger getLogger(String name) { + return Log4jLoggerFactory.getLogger(name); + } + + public static Logger getLogger(Class clazz) { + return getLogger(clazz.getName()); + } + + /** + * Does the obvious. + * + * @return + */ + public static Logger getRootLogger() { + return getLogger("root"); + } + + /** + * Returns the obvious. + * + * @return + */ + public String getName() { + return name; + } + + /** + * Delegates to {@link org.slf4j.Logger#isDebugEnabled} method of the SLF4J + * API, in addition, the call is marked with a marker named "TRACE". + */ + public boolean isTraceEnabled() { + return lbLogger.isDebugEnabled(TRACE_MARKER); + } + + /** + * Delegates to {@link org.slf4j.Logger#isDebugEnabled} method of the SLF4J + * API. + */ + public boolean isDebugEnabled() { + return lbLogger.isDebugEnabled(); + } + + /** + * Delegates to {@link org.slf4j.Logger#isInfoEnabled} method of the SLF4J + * API. + */ + public boolean isInfoEnabled() { + return lbLogger.isInfoEnabled(); + } + + /** + * Delegates to {@link org.slf4j.Logger#isWarnEnabled} method of the SLF4J + * API. + */ + public boolean isWarnEnabled() { + return lbLogger.isWarnEnabled(); + } + + /** + * Delegates to {@link org.slf4j.Logger#isErrorEnabled} method of the SLF4J + * API. + */ + public boolean isErrorEnabled() { + return lbLogger.isErrorEnabled(); + } + + /** + * Delegates to {@link org.slf4j.Logger#debug(String)} method of the SLF4J + * API, in addition, the call is marked with a marker named "TRACE". + */ + public void trace(Object message) { + lbLogger.debug(TRACE_MARKER, (String) message); + } + + /** + * Delegates to {@link org.slf4j.Logger#debug(String,Throwable)} method of the + * SLF4J API, in addition, the call is marked with a marker named "TRACE". + */ + public void trace(Object message, Throwable t) { + lbLogger.debug(TRACE_MARKER, (String) message, t); + } + + /** + * Delegates to {@link org.slf4j.Logger#debug(String)} method of the SLF4J + * API. + */ + public void debug(Object message) { + // casting to String as SLF4J only accepts String instances, not Object + // instances. + lbLogger.debug((String) message); + } + + /** + * Delegates to {@link org.slf4j.Logger#debug(String,Throwable)} method of the + * SLF4J API. + */ + public void debug(Object message, Throwable t) { + lbLogger.debug((String) message, t); + } + + /** + * Delegates to {@link org.slf4j.Logger#info(String)} method of the SLF4J API. + */ + public void info(Object message) { + lbLogger.info((String) message); + } + + /** + * Delegates to {@link org.slf4j.Logger#info(String, Throwable)} method of the + * SLF4J API. + */ + public void info(Object message, Throwable t) { + lbLogger.info((String) message, t); + } + + /** + * Delegates to {@link org.slf4j.Logger#warn(String)} method of the SLF4J API. + */ + public void warn(Object message) { + lbLogger.warn((String) message); + } + + /** + * Delegates to {@link org.slf4j.Logger#warn(String,Throwable)} method of the + * SLF4J API. + */ + public void warn(Object message, Throwable t) { + lbLogger.warn((String) message, t); + } + + /** + * Delegates to {@link org.slf4j.Logger#error(String)} method of the SLF4J + * API. + */ + public void error(Object message) { + lbLogger.error((String) message); + } + + /** + * Delegates to {@link org.slf4j.Logger#error(String,Throwable)} method of the + * SLF4J API. + */ + public void error(Object message, Throwable t) { + lbLogger.error((String) message, t); + } + + /** + * Delegates to {@link org.slf4j.Logger#error(String)} method of the SLF4J + * API, in addition, the call is marked with a marker named "FATAL". + */ + public void fatal(Object message) { + lbLogger.error(FATAL_MARKER, (String) message); + } + + /** + * Delegates to {@link org.slf4j.Logger#error(String,Throwable)} method of the + * SLF4J API, in addition, the call is marked with a marker named "FATAL". + */ + public void fatal(Object message, Throwable t) { + lbLogger.error(FATAL_MARKER, (String) message, t); + } + + public void log(String FQCN, Priority p, Object msg, Throwable t) { + ch.qos.logback.classic.Level level; + switch (p.level) { + case Priority.DEBUG_INT: + level = ch.qos.logback.classic.Level.DEBUG; + break; + case Priority.INFO_INT: + level = ch.qos.logback.classic.Level.INFO; + break; + case Priority.WARN_INT: + level = ch.qos.logback.classic.Level.WARN; + break; + case Priority.ERROR_INT: + level = ch.qos.logback.classic.Level.ERROR; + break; + case Priority.FATAL_INT: + level = ch.qos.logback.classic.Level.ERROR; + break; + default: + throw new IllegalStateException("Unknown Priority " + p); + } + lbLogger.filterAndLog(FQCN, null, level, msg.toString(), null, t); + } + +} Added: logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/Level.java ============================================================================== --- (empty file) +++ logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/Level.java Wed Dec 13 14:27:05 2006 @@ -0,0 +1,218 @@ +/* + * Copyright 1999-2005 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. + */ + +// Contributors: Kitching Simon <Simon.Kitching(a)orange.ch> +// Nicholas Wolff + +package org.apache.log4j; +import java.io.IOException; +import java.io.ObjectInputStream; +import java.io.ObjectOutputStream; +import java.io.ObjectStreamException; +import java.io.Serializable; + +/** + Defines the minimum set of levels recognized by the system, that is + <code>OFF</code>, <code>FATAL</code>, <code>ERROR</code>, + <code>WARN</code>, <code>INFO</code, <code>DEBUG</code> and + <code>ALL</code>. + + <p>The <code>Level</code> class may be subclassed to define a larger + level set. + + @author Ceki Gülcü + + */ +public class Level extends Priority implements Serializable { + + /** + * TRACE level integer value. + * @since 1.2.12 + */ + public static final int TRACE_INT = 5000; + + /** + The <code>OFF</code> has the highest possible rank and is + intended to turn off logging. */ + final static public Level OFF = new Level(OFF_INT, "OFF", 0); + + /** + The <code>FATAL</code> level designates very severe error + events that will presumably lead the application to abort. + */ + final static public Level FATAL = new Level(FATAL_INT, "FATAL", 0); + + /** + The <code>ERROR</code> level designates error events that + might still allow the application to continue running. */ + final static public Level ERROR = new Level(ERROR_INT, "ERROR", 3); + + /** + The <code>WARN</code> level designates potentially harmful situations. + */ + final static public Level WARN = new Level(WARN_INT, "WARN", 4); + + /** + The <code>INFO</code> level designates informational messages + that highlight the progress of the application at coarse-grained + level. */ + final static public Level INFO = new Level(INFO_INT, "INFO", 6); + + /** + The <code>DEBUG</code> Level designates fine-grained + informational events that are most useful to debug an + application. */ + final static public Level DEBUG = new Level(DEBUG_INT, "DEBUG", 7); + + /** + * The <code>TRACE</code> Level designates finer-grained + * informational events than the <code>DEBUG</code level. + * @since 1.2.12 + */ + public static final Level TRACE = new Level(TRACE_INT, "TRACE", 7); + + + /** + The <code>ALL</code> has the lowest possible rank and is intended to + turn on all logging. */ + final static public Level ALL = new Level(ALL_INT, "ALL", 7); + + /** + * Serialization version id. + */ + static final long serialVersionUID = 3491141966387921974L; + + /** + Instantiate a Level object. + */ + protected + Level(int level, String levelStr, int syslogEquivalent) { + super(level, levelStr, syslogEquivalent); + } + + + /** + Convert the string passed as argument to a level. If the + conversion fails, then this method returns {@link #DEBUG}. + */ + public + static + Level toLevel(String sArg) { + return (Level) toLevel(sArg, Level.DEBUG); + } + + /** + Convert an integer passed as argument to a level. If the + conversion fails, then this method returns {@link #DEBUG}. + + */ + public + static + Level toLevel(int val) { + return (Level) toLevel(val, Level.DEBUG); + } + + /** + Convert an integer passed as argument to a level. If the + conversion fails, then this method returns the specified default. + */ + public + static + Level toLevel(int val, Level defaultLevel) { + switch(val) { + case ALL_INT: return ALL; + case DEBUG_INT: return Level.DEBUG; + case INFO_INT: return Level.INFO; + case WARN_INT: return Level.WARN; + case ERROR_INT: return Level.ERROR; + case FATAL_INT: return Level.FATAL; + case OFF_INT: return OFF; + case TRACE_INT: return Level.TRACE; + default: return defaultLevel; + } + } + + /** + Convert the string passed as argument to a level. If the + conversion fails, then this method returns the value of + <code>defaultLevel</code>. + */ + public + static + Level toLevel(String sArg, Level defaultLevel) { + if(sArg == null) + return defaultLevel; + + String s = sArg.toUpperCase(); + + if(s.equals("ALL")) return Level.ALL; + if(s.equals("DEBUG")) return Level.DEBUG; + if(s.equals("INFO")) return Level.INFO; + if(s.equals("WARN")) return Level.WARN; + if(s.equals("ERROR")) return Level.ERROR; + if(s.equals("FATAL")) return Level.FATAL; + if(s.equals("OFF")) return Level.OFF; + if(s.equals("TRACE")) return Level.TRACE; + return defaultLevel; + } + + /** + * Custom deserialization of Level. + * @param s serialization stream. + * @throws IOException if IO exception. + * @throws ClassNotFoundException if class not found. + */ + private void readObject(final ObjectInputStream s) throws IOException, ClassNotFoundException { + s.defaultReadObject(); + level = s.readInt(); + syslogEquivalent = s.readInt(); + levelStr = s.readUTF(); + if (levelStr == null) { + levelStr = ""; + } + } + + /** + * Serialize level. + * @param s serialization stream. + * @throws IOException if exception during serialization. + */ + private void writeObject(final ObjectOutputStream s) throws IOException { + s.defaultWriteObject(); + s.writeInt(level); + s.writeInt(syslogEquivalent); + s.writeUTF(levelStr); + } + + /** + * Resolved deserialized level to one of the stock instances. + * May be overriden in classes derived from Level. + * @return resolved object. + * @throws ObjectStreamException if exception during resolution. + */ + private Object readResolve() throws ObjectStreamException { + // + // if the deserizalized object is exactly an instance of Level + // + if (getClass() == Level.class) { + return toLevel(level); + } + // + // extension of Level can't substitute stock item + // + return this; + } +} \ No newline at end of file Added: logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/Log4jLoggerFactory.java ============================================================================== --- (empty file) +++ logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/Log4jLoggerFactory.java Wed Dec 13 14:27:05 2006 @@ -0,0 +1,45 @@ +/* + * Copyright 2001-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.log4j; + +import java.util.Hashtable; + +/** + * This class is a factory that creates and maintains org.apache.log4j.Loggers + * warpping org.slf4j.Loggers. + * + * It keeps a hashtable of all created org.apache.log4j.Logger instances so that + * all newly created instances are not dulpicates of existing loggers. + * + * @author Sébastien Pennec + */ +class Log4jLoggerFactory { + + private static Hashtable log4jLoggers = new Hashtable(); + + public static synchronized Logger getLogger(String name) { + if (log4jLoggers.containsKey(name)) { + return (org.apache.log4j.Logger) log4jLoggers.get(name); + } else { + Logger log4jLogger = new Logger(name); + + log4jLoggers.put(name, log4jLogger); + return log4jLogger; + } + } + +} Added: logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/Logger.java ============================================================================== --- (empty file) +++ logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/Logger.java Wed Dec 13 14:27:05 2006 @@ -0,0 +1,25 @@ +/* + * Copyright 2001-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.log4j; + +public class Logger extends Category { + + Logger(String name) { + super(name); + } + +} Added: logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/Priority.java ============================================================================== --- (empty file) +++ logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/Priority.java Wed Dec 13 14:27:05 2006 @@ -0,0 +1,192 @@ +/* + * Copyright 1999-2005 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. + */ + +// Contributors: Kitching Simon <Simon.Kitching(a)orange.ch> + +package org.apache.log4j; + +/** + <font color="#AA4444">Refrain from using this class directly, use + the {@link Level} class instead</font>. + + @author Ceki Gülcü */ +public class Priority { + + transient int level; + transient String levelStr; + transient int syslogEquivalent; + + public final static int OFF_INT = Integer.MAX_VALUE; + public final static int FATAL_INT = 50000; + public final static int ERROR_INT = 40000; + public final static int WARN_INT = 30000; + public final static int INFO_INT = 20000; + public final static int DEBUG_INT = 10000; + //public final static int FINE_INT = DEBUG_INT; + public final static int ALL_INT = Integer.MIN_VALUE; + + /** + * @deprecated Use {@link Level#FATAL} instead. + */ + final static public Priority FATAL = new Level(FATAL_INT, "FATAL", 0); + + /** + * @deprecated Use {@link Level#ERROR} instead. + */ + final static public Priority ERROR = new Level(ERROR_INT, "ERROR", 3); + + /** + * @deprecated Use {@link Level#WARN} instead. + */ + final static public Priority WARN = new Level(WARN_INT, "WARN", 4); + + /** + * @deprecated Use {@link Level#INFO} instead. + */ + final static public Priority INFO = new Level(INFO_INT, "INFO", 6); + + /** + * @deprecated Use {@link Level#DEBUG} instead. + */ + final static public Priority DEBUG = new Level(DEBUG_INT, "DEBUG", 7); + + + /** + * Default constructor for deserialization. + */ + protected Priority() { + level = DEBUG_INT; + levelStr = "DEBUG"; + syslogEquivalent = 7; + } + + /** + Instantiate a level object. + */ + protected + Priority(int level, String levelStr, int syslogEquivalent) { + this.level = level; + this.levelStr = levelStr; + this.syslogEquivalent = syslogEquivalent; + } + + /** + Two priorities are equal if their level fields are equal. + @since 1.2 + */ + public + boolean equals(Object o) { + if(o instanceof Priority) { + Priority r = (Priority) o; + return (this.level == r.level); + } else { + return false; + } + } + + /** + Return the syslog equivalent of this priority as an integer. + */ + public + final + int getSyslogEquivalent() { + return syslogEquivalent; + } + + + + /** + Returns <code>true</code> if this level has a higher or equal + level than the level passed as argument, <code>false</code> + otherwise. + + <p>You should think twice before overriding the default + implementation of <code>isGreaterOrEqual</code> method. + + */ + public + boolean isGreaterOrEqual(Priority r) { + return level >= r.level; + } + + /** + Return all possible priorities as an array of Level objects in + descending order. + + @deprecated This method will be removed with no replacement. + */ + public + static + Priority[] getAllPossiblePriorities() { + return new Priority[] {Priority.FATAL, Priority.ERROR, Level.WARN, + Priority.INFO, Priority.DEBUG}; + } + + + /** + Returns the string representation of this priority. + */ + final + public + String toString() { + return levelStr; + } + + /** + Returns the integer representation of this level. + */ + public + final + int toInt() { + return level; + } + + /** + * @deprecated Please use the {@link Level#toLevel(String)} method instead. + */ + public + static + Priority toPriority(String sArg) { + return Level.toLevel(sArg); + } + + /** + * @deprecated Please use the {@link Level#toLevel(int)} method instead. + */ + public + static + Priority toPriority(int val) { + return toPriority(val, Priority.DEBUG); + } + + /** + * @deprecated Please use the {@link Level#toLevel(int, Level)} method instead. + */ + public + static + Priority toPriority(int val, Priority defaultPriority) { + return Level.toLevel(val, (Level) defaultPriority); + } + + /** + * @deprecated Please use the {@link Level#toLevel(String, Level)} method instead. + */ + public + static + Priority toPriority(String sArg, Priority defaultPriority) { + return Level.toLevel(sArg, (Level) defaultPriority); + } +} \ No newline at end of file Added: logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/package.html ============================================================================== --- (empty file) +++ logback/trunk/log4j-bridge/src/main/java/org/apache/log4j/package.html Wed Dec 13 14:27:05 2006 @@ -0,0 +1,18 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> + + +<html> + <head> + <title></title> + </head> + + + <body> + + <p>An rather minimal but sufficient implementation redirecting all + calls to a log4j logger to a logback logger.</p> + + </body> +</html> + + Added: logback/trunk/log4j-bridge/src/test/java/org/apache/log4j/InvokeLog4jTest.java ============================================================================== --- (empty file) +++ logback/trunk/log4j-bridge/src/test/java/org/apache/log4j/InvokeLog4jTest.java Wed Dec 13 14:27:05 2006 @@ -0,0 +1,87 @@ +/* + * Copyright (c) 2004-2006 SLF4J.ORG + * Copyright (c) 2004-2006 QOS.ch + * + * All rights reserved. + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, and/or sell copies of the Software, and to permit persons + * to whom the Software is furnished to do so, provided that the above + * copyright notice(s) and this permission notice appear in all copies of + * the Software and that both the above copyright notice(s) and this + * permission notice appear in supporting documentation. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT + * OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR + * HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY + * SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER + * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF + * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN + * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + * + * Except as contained in this notice, the name of a copyright holder + * shall not be used in advertising or otherwise to promote the sale, use + * or other dealings in this Software without prior written authorization + * of the copyright holder. + * + */ + + +package org.apache.log4j; + +import junit.framework.TestCase; + +/** + * A class that tests the invocation of the org.apache.log4j.Logger class + * that belongs to the log4j-bridge package + * + * @author Sébastien Pennec + * @author Ceki Gülcü + */ +public class InvokeLog4jTest extends TestCase { + + public void testIsEnabledAPI() { + // assume that we are running over slf4j-simple + Logger log = Logger.getLogger(InvokeLog4jTest.class.getName()); + + assertTrue(log.isTraceEnabled()); + assertTrue(log.isDebugEnabled()); + assertTrue(log.isInfoEnabled()); + assertTrue(log.isWarnEnabled()); + assertTrue(log.isErrorEnabled()); + } + + public void testPrintAPI() { + Logger log = Logger.getLogger(InvokeLog4jTest.class.getName()); + Exception e = new Exception("just testing"); + + log.debug(null); + log.debug("debug message"); + + log.info(null); + log.info("info message"); + + log.warn(null); + log.warn("warn message"); + + log.error(null); + log.error("error message"); + + log.debug(null, e); + log.debug("debug message", e); + + log.info(null, e); + log.info("info message", e); + + log.warn(null, e); + log.warn("warn message", e); + + log.error(null, e); + log.error("error message", e); + } +} Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/Logger.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/Logger.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/Logger.java Wed Dec 13 14:27:05 2006 @@ -404,7 +404,8 @@ filterAndLog(marker, Level.DEBUG, msg, null, null); } - final void filterAndLog(final Marker marker, final Level level, final String msg, final Object[] params, + + public final void filterAndLog(final String localFQCN, final Marker marker, final Level level, final String msg, final Object[] params, final Throwable t) { final FilterReply decision = loggerContext.getTurboFilterChainDecision(marker, this, Level.DEBUG, msg, params, t); @@ -417,9 +418,16 @@ return; } - LoggingEvent le = new LoggingEvent(FQCN, this, level, msg, t, params); + LoggingEvent le = new LoggingEvent(localFQCN, this, level, msg, t, params); le.setMarker(marker); callAppenders(le); + + } + + + final void filterAndLog(final Marker marker, final Level level, final String msg, final Object[] params, + final Throwable t) { + filterAndLog(FQCN, marker, level, msg, params, t); } public void debug(Marker marker, String format, Object arg) { Modified: logback/trunk/pom.xml ============================================================================== --- logback/trunk/pom.xml (original) +++ logback/trunk/pom.xml Wed Dec 13 14:27:05 2006 @@ -24,6 +24,7 @@ <module>logback-site</module> <module>logback-skin</module> <module>logback-examples</module> + <module>log4j-bridge</module> </modules> <dependencies> @@ -129,6 +130,14 @@ </extension> </extensions> <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-compiler-plugin</artifactId> + <configuration> + <source>1.5</source> + <target>1.5</target> + </configuration> + </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-source-plugin</artifactId>

1 0

svn commit: r1077 - in logback/trunk: logback-examples logback-examples/src/main/java/chapter6 logback-site/src/site/xdocTemplates/manual
by noreply.seb＠qos.ch 13 Dec '06

13 Dec '06

Author: seb Date: Wed Dec 13 14:26:33 2006 New Revision: 1077 Added: logback/trunk/logback-examples/src/main/java/chapter6/sampleTurboFilterConfig.xml Modified: logback/trunk/logback-examples/pom.xml logback/trunk/logback-examples/src/main/java/chapter6/SampleTurboFilter.java logback/trunk/logback-site/src/site/xdocTemplates/manual/filters.xml Log: improved examples Modified: logback/trunk/logback-examples/pom.xml ============================================================================== --- logback/trunk/logback-examples/pom.xml (original) +++ logback/trunk/logback-examples/pom.xml Wed Dec 13 14:26:33 2006 @@ -36,11 +36,6 @@ <groupId>ch.qos.logback</groupId> <artifactId>logback-core</artifactId> </dependency> - - <dependency> - <groupId>ch.qos.logback</groupId> - <artifactId>logback-core</artifactId> - </dependency> <dependency> <groupId>ch.qos.logback</groupId> Modified: logback/trunk/logback-examples/src/main/java/chapter6/SampleTurboFilter.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter6/SampleTurboFilter.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter6/SampleTurboFilter.java Wed Dec 13 14:26:33 2006 @@ -10,16 +10,33 @@ public class SampleTurboFilter extends TurboFilter { - Marker sampleMarker = MarkerFactory.getMarker("sample"); + String marker; + Marker acceptedMarker; @Override public FilterReply decide(Marker marker, Logger logger, Level level, String format, Object[] params, Throwable t) { - if ((sampleMarker.equals(marker))) { + if ((acceptedMarker.equals(marker))) { return FilterReply.ACCEPT; } else { return FilterReply.NEUTRAL; } } + + public String getMarker() { + return marker; + } + + public void setMarker(String markerStr) { + this.marker = markerStr; + } + + @Override + public void start() { + if (marker != null && marker.trim().length() > 0) { + acceptedMarker = MarkerFactory.getMarker(marker); + super.start(); + } + } } Added: logback/trunk/logback-examples/src/main/java/chapter6/sampleTurboFilterConfig.xml ============================================================================== --- (empty file) +++ logback/trunk/logback-examples/src/main/java/chapter6/sampleTurboFilterConfig.xml Wed Dec 13 14:26:33 2006 @@ -0,0 +1,19 @@ +<configuration> + + <turboFilter class="chapter6.SampleTurboFilter"> + <Marker>sample</Marker> + </turboFilter> + + <appender name="STDOUT" + class="ch.qos.logback.core.ConsoleAppender"> + <layout class="ch.qos.logback.classic.PatternLayout"> + <pattern> + %-4relative [%thread] %-5level %logger - %msg%n + </pattern> + </layout> + </appender> + + <root> + <appender-ref ref="STDOUT" /> + </root> +</configuration> \ No newline at end of file Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/filters.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/filters.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/filters.xml Wed Dec 13 14:26:33 2006 @@ -439,7 +439,8 @@ To create your own <code>TurboFilter</code> component, just extend the <code>TurboFilter</code> abstract class. Like previously, when implementing a custumized filter object, developing a custom <code>TurboFilter</code> only - ask that one implement the <code>decide()</code> method, as shown below: + ask that one implement the <code>decide()</code> method. In the next example, we + create a slightly more complex filter: </p> <em>Example 6.5: Basic custom <code>TurboFilter</code> (<a href="../xref/chapter6/SampleTurboFilter.html">logback-examples/src/main/java/chapter6/SampleTurboFilter.java</a>)</em> @@ -455,16 +456,37 @@ public class SampleTurboFilter extends TurboFilter { + String marker; + Marker acceptedMarker; + @Override public FilterReply decide(Marker marker, Logger logger, Level level, String format, Object[] params, Throwable t) { - if ((MarkerFactory.getMarker("sample").equals(marker))) { + + if ((acceptedMarker.equals(marker))) { return FilterReply.ACCEPT; } else { return FilterReply.NEUTRAL; } } -}</pre></div> + + public String getMarker() { + return marker; + } + + public void setMarker(String markerStr) { + this.marker = markerStr; + } + + @Override + public void start() { + if (marker != null && marker.trim().length() > 0) { + acceptedMarker = MarkerFactory.getMarker(marker); + super.start(); + } + } +} +</pre></div> <p> The <code>TurboFilter</code> above accepts events that contain a specific marker. @@ -473,12 +495,35 @@ </p> <p> - Like any other logback component, adding an option only requires implementing the - getter and setter methods in the corresponding class. Once done, the option can be specified - by adding nested elements inside the <em>TurboFilter</em> element. + To allow more flexibility, the marker that will be tested can be specified + in the configuration file. Hence the getter and setter methods. We also implemented + the <code>start()</code> method, to check that the option has been specified during the + configuration process. </p> - - + + <p> + Here is a sample configuration that makes use of the newly created <code>TurboFilter</code>. + </p> + +<em>Example 6.5: Basic custom <code>TurboFilter</code> configuration (logback-examples/src/main/java/chapter6/sampleTurboFilterConfig.xml)</em> +<div class="source"><pre><configuration> + <b><turboFilter class="chapter6.SampleTurboFilter"> + <Marker>sample</Marker> + </turboFilter></b> + + <appender name="STDOUT" + class="ch.qos.logback.core.ConsoleAppender"> + <layout class="ch.qos.logback.classic.PatternLayout"> + <pattern> + %-4relative [%thread] %-5level %logger - %msg%n + </pattern> + </layout> + </appender> + + <root> + <appender-ref ref="STDOUT" /> + </root> +</configuration></pre></div> <h2>Logback Access</h2>

1 0

svn commit: r1076 - in logback/trunk: logback-examples/src/main/java/chapter6 logback-site/src/site/xdocTemplates/manual
by noreply.seb＠qos.ch 12 Dec '06

12 Dec '06

Author: seb Date: Tue Dec 12 20:04:56 2006 New Revision: 1076 Modified: logback/trunk/logback-examples/src/main/java/chapter6/SampleFilter.java logback/trunk/logback-examples/src/main/java/chapter6/SampleTurboFilter.java logback/trunk/logback-site/src/site/xdocTemplates/manual/filters.xml logback/trunk/logback-site/src/site/xdocTemplates/manual/index.xml logback/trunk/logback-site/src/site/xdocTemplates/manual/mdc.xml Log: on going work Modified: logback/trunk/logback-examples/src/main/java/chapter6/SampleFilter.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter6/SampleFilter.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter6/SampleFilter.java Tue Dec 12 20:04:56 2006 @@ -9,7 +9,7 @@ @Override public FilterReply decide(Object eventObject) { LoggingEvent event = (LoggingEvent)eventObject; - if (event.getMessage().contains("sample")) { + if (event.getMessage() != null && event.getMessage().contains("sample")) { return FilterReply.ACCEPT; } else { return FilterReply.NEUTRAL; Modified: logback/trunk/logback-examples/src/main/java/chapter6/SampleTurboFilter.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter6/SampleTurboFilter.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter6/SampleTurboFilter.java Tue Dec 12 20:04:56 2006 @@ -10,10 +10,13 @@ public class SampleTurboFilter extends TurboFilter { + Marker sampleMarker = MarkerFactory.getMarker("sample"); + @Override public FilterReply decide(Marker marker, Logger logger, Level level, String format, Object[] params, Throwable t) { - if ((MarkerFactory.getMarker("sample").equals(marker))) { + + if ((sampleMarker.equals(marker))) { return FilterReply.ACCEPT; } else { return FilterReply.NEUTRAL; Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/filters.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/filters.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/filters.xml Tue Dec 12 20:04:56 2006 @@ -5,10 +5,10 @@ Since "source" divs use pre as white-space, it affects the look of the code parts in this document. - --> +--> <body> - <h2>Chapter 6: Filters</h2> + <h2>Chapter 6: Filter chains</h2> <div class="author"> Authors: Ceki Gülcü, Sébastien Pennec </div> @@ -239,7 +239,7 @@ logging event should be accepted, or rejected. </p> - <h2>Implementing your own Filter</h2> + <h3>Implementing your own Filter</h3> <p> Creating your own filter is not difficult. If your filter doesn't need any evaluation @@ -283,7 +283,6 @@ <em>Example 6.3: SampleFilter configuration (logback-examples/src/main/java/chapter6/SampleFilterConfig.xml)</em> <div class="source"><pre><configuration> - <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <b><Filter class="chapter6.SampleFilter" /></b> @@ -434,7 +433,7 @@ </p> - <h2>Implementing your own TurboFilter</h2> + <h3>Implementing your own TurboFilter</h3> <p> To create your own <code>TurboFilter</code> component, just extend the @@ -443,7 +442,7 @@ ask that one implement the <code>decide()</code> method, as shown below: </p> -<em>Example 6.5: Basic custom <code>TurboFilter</code> (<a href="../xref/chapter6/SampleTurboFilter.html">logback-examples/src/main/java/chapter6/SampleFilter.java</a>)</em> +<em>Example 6.5: Basic custom <code>TurboFilter</code> (<a href="../xref/chapter6/SampleTurboFilter.html">logback-examples/src/main/java/chapter6/SampleTurboFilter.java</a>)</em> <div class="source"><pre>package chapter6; import org.slf4j.Marker; @@ -474,7 +473,9 @@ </p> <p> - + Like any other logback component, adding an option only requires implementing the + getter and setter methods in the corresponding class. Once done, the option can be specified + by adding nested elements inside the <em>TurboFilter</em> element. </p> @@ -486,7 +487,11 @@ Logback access benefits from most of the possibilities available to the classic module. <code>Filter</code> objects are available and work in the same way as their classic counterpart. They handle access' implementation - of logging events: <code>AccessEvent</code>. On the other hand, + of logging events: <code>AccessEvent</code>. + Thus, a customized filter + for logback access is follows strictly the same rules than one for the + classic module, except for the event implemenation recieved as a parameter. + On the other hand, <code>TurboFilter</code> objects are not available to the access module. </p> Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/index.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/index.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/index.xml Tue Dec 12 20:04:56 2006 @@ -67,6 +67,14 @@ <li><p> <a href="layouts.html"><b>Chapter 5: Layouts</b></a> </p></li> + + <li><p> + <a href="layouts.html"><b>Chapter 6: Filter chains</b></a> + </p></li> + + <li><p> + <a href="layouts.html"><b>Chapter 7: Diagnostic Context</b></a> + </p></li> </ul> </div> </body> Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/mdc.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/mdc.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/mdc.xml Tue Dec 12 20:04:56 2006 @@ -8,7 +8,7 @@ --> <body> - <h2>Chapter 7: Mapped Diagnostic Context</h2> + <h2>Chapter 7: Diagnostic Context</h2> <div class="author"> Authors: Ceki Gülcü, Sébastien Pennec </div>

1 0

svn commit: r1075 - in logback/trunk: logback-examples/src/main/java/chapter6 logback-site/src/site/xdocTemplates/manual
by noreply.seb＠qos.ch 12 Dec '06

12 Dec '06

Author: seb Date: Tue Dec 12 16:25:09 2006 New Revision: 1075 Added: logback/trunk/logback-examples/src/main/java/chapter6/SampleFilter.java logback/trunk/logback-examples/src/main/java/chapter6/SampleTurboFilter.java logback/trunk/logback-examples/src/main/java/chapter6/sampleFilterConfig.xml Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml logback/trunk/logback-site/src/site/xdocTemplates/manual/filters.xml Log: On going work in filters documentation Added: logback/trunk/logback-examples/src/main/java/chapter6/SampleFilter.java ============================================================================== --- (empty file) +++ logback/trunk/logback-examples/src/main/java/chapter6/SampleFilter.java Tue Dec 12 16:25:09 2006 @@ -0,0 +1,18 @@ +package chapter6; + +import ch.qos.logback.classic.spi.LoggingEvent; +import ch.qos.logback.core.filter.Filter; +import ch.qos.logback.core.spi.FilterReply; + +public class SampleFilter extends Filter { + + @Override + public FilterReply decide(Object eventObject) { + LoggingEvent event = (LoggingEvent)eventObject; + if (event.getMessage().contains("sample")) { + return FilterReply.ACCEPT; + } else { + return FilterReply.NEUTRAL; + } + } +} Added: logback/trunk/logback-examples/src/main/java/chapter6/SampleTurboFilter.java ============================================================================== --- (empty file) +++ logback/trunk/logback-examples/src/main/java/chapter6/SampleTurboFilter.java Tue Dec 12 16:25:09 2006 @@ -0,0 +1,22 @@ +package chapter6; + +import org.slf4j.Marker; +import org.slf4j.MarkerFactory; + +import ch.qos.logback.classic.Level; +import ch.qos.logback.classic.Logger; +import ch.qos.logback.classic.turbo.TurboFilter; +import ch.qos.logback.core.spi.FilterReply; + +public class SampleTurboFilter extends TurboFilter { + + @Override + public FilterReply decide(Marker marker, Logger logger, Level level, + String format, Object[] params, Throwable t) { + if ((MarkerFactory.getMarker("sample").equals(marker))) { + return FilterReply.ACCEPT; + } else { + return FilterReply.NEUTRAL; + } + } +} Added: logback/trunk/logback-examples/src/main/java/chapter6/sampleFilterConfig.xml ============================================================================== --- (empty file) +++ logback/trunk/logback-examples/src/main/java/chapter6/sampleFilterConfig.xml Tue Dec 12 16:25:09 2006 @@ -0,0 +1,17 @@ +<configuration> + + <appender name="STDOUT" + class="ch.qos.logback.core.ConsoleAppender"> + <Filter class="chapter6.SampleFilter" /> + + <layout class="ch.qos.logback.classic.PatternLayout"> + <pattern> + %-4relative [%thread] %-5level %logger - %msg%n + </pattern> + </layout> + </appender> + + <root> + <appender-ref ref="STDOUT" /> + </root> +</configuration> \ No newline at end of file Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml Tue Dec 12 16:25:09 2006 @@ -1488,7 +1488,7 @@ <td><code>String</code></td> <td> The email address of the recipient. Multiple recipients can - be specified by separating each recipient with a comma. + be specified by using several <To> elements. </td> </tr> <tr> Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/filters.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/filters.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/filters.xml Tue Dec 12 16:25:09 2006 @@ -239,6 +239,79 @@ logging event should be accepted, or rejected. </p> + <h2>Implementing your own Filter</h2> + + <p> + Creating your own filter is not difficult. If your filter doesn't need any evaluation + functionnalities, then all you have to do is extend the <code>Filter</code> abstract class. + The only method that you will have to implement is the <code>decide()</code> method, allowing + you to contentrate only on the behaviour of your filter. + </p> + + <p> + The next class is all it takes to implement one's own filter. All it does is accept + logging events who's message contains the String <em>sample</em>. The filter will give a + neutral response to any logging event who's message does not contain this String. + </p> + +<em>Example 6.2: Basic custom filter (<a href="../xref/chapter6/SampleFilter.html">logback-examples/src/main/java/chapter6/SampleFilter.java</a>)</em> +<div class="source"><pre>package chapter6; + +import ch.qos.logback.classic.spi.LoggingEvent; +import ch.qos.logback.core.filter.Filter; +import ch.qos.logback.core.spi.FilterReply; + +public class SampleFilter extends Filter { + + @Override + public FilterReply decide(Object eventObject) { + LoggingEvent event = (LoggingEvent)eventObject; + + if (event.getMessage().contains("sample")) { + return FilterReply.ACCEPT; + } else { + return FilterReply.NEUTRAL; + } + } +}</pre></div> + + <p> + What is shown above might be the simplest filter. Like any filter, it + can be attached to any appender using the <Filter> element, as + shown below: + </p> + +<em>Example 6.3: SampleFilter configuration (logback-examples/src/main/java/chapter6/SampleFilterConfig.xml)</em> +<div class="source"><pre><configuration> + + <appender name="STDOUT" + class="ch.qos.logback.core.ConsoleAppender"> + <b><Filter class="chapter6.SampleFilter" /></b> + + <layout class="ch.qos.logback.classic.PatternLayout"> + <pattern> + %-4relative [%thread] %-5level %logger - %msg%n + </pattern> + </layout> + </appender> + + <root> + <appender-ref ref="STDOUT" /> + </root> +</configuration></pre></div> + + <p> + Thanks to Joran, logback's powerful configuration framework, adding + an option to such a filter is very easy. Just add the corresponding + getter and setter methods in the class, and you can specify the + option's value in a xml element, nested in the filter element. + </p> + + <p> + Creating a filter that makes use of <code>EventEvaluator</code> objects + works the same way, except that one must extend the <code>EvaluatorFilter</code> + class, instead of the <code>Filter</code> class. + </p> <a name="TurboFilter" /> <h3>TurboFilters</h3> @@ -284,7 +357,7 @@ <code>MarkerFilter</code>. </p> -<em>Example 6.2: <code>MDCFilter</code> and <code>MarkerFilter</code> +<em>Example 6.4: <code>MDCFilter</code> and <code>MarkerFilter</code> configuration (logback-examples/src/main/java/chapter6/turboFilters.xml)</em> <div class="source"><pre><configuration> @@ -359,6 +432,52 @@ whose <span class="option">OnMatch</span> option is set to <em>DENY</em>. Thus, the 6th request was not displayed. </p> + + + <h2>Implementing your own TurboFilter</h2> + + <p> + To create your own <code>TurboFilter</code> component, just extend the + <code>TurboFilter</code> abstract class. Like previously, when implementing + a custumized filter object, developing a custom <code>TurboFilter</code> only + ask that one implement the <code>decide()</code> method, as shown below: + </p> + +<em>Example 6.5: Basic custom <code>TurboFilter</code> (<a href="../xref/chapter6/SampleTurboFilter.html">logback-examples/src/main/java/chapter6/SampleFilter.java</a>)</em> +<div class="source"><pre>package chapter6; + +import org.slf4j.Marker; +import org.slf4j.MarkerFactory; + +import ch.qos.logback.classic.Level; +import ch.qos.logback.classic.Logger; +import ch.qos.logback.classic.turbo.TurboFilter; +import ch.qos.logback.core.spi.FilterReply; + +public class SampleTurboFilter extends TurboFilter { + + @Override + public FilterReply decide(Marker marker, Logger logger, Level level, + String format, Object[] params, Throwable t) { + if ((MarkerFactory.getMarker("sample").equals(marker))) { + return FilterReply.ACCEPT; + } else { + return FilterReply.NEUTRAL; + } + } +}</pre></div> + + <p> + The <code>TurboFilter</code> above accepts events that contain a specific marker. + If said marker is not found, then the filter passes the responsability to + the next filter in the chain. + </p> + + <p> + + </p> + + <h2>Logback Access</h2> @@ -386,7 +505,7 @@ Here is a sample configuration that will ensure that any 404 error will be displayed: </p> -<em>Example 6.3: Access Evaluator (logback-examples/src/main/java/chapter6/accessEventEvaluator.xml)</em> +<em>Example 6.6: Access Evaluator (logback-examples/src/main/java/chapter6/accessEventEvaluator.xml)</em> <div class="source"><pre><configuration> <appender name="STDOUT" @@ -414,7 +533,7 @@ would look like: </p> -<em>Example 6.4: Access Evaluator (logback-examples/src/main/java/chapter6/accessEventEvaluator2.xml)</em> +<em>Example 6.7: Access Evaluator (logback-examples/src/main/java/chapter6/accessEventEvaluator2.xml)</em> <div class="source"><pre><configuration> <appender name="STDOUT"

1 0

svn commit: r1074 - in logback/trunk: logback-classic/src/test/java/ch/qos/logback/classic/net logback-core/src/main/java/ch/qos/logback/core/net
by noreply.seb＠qos.ch 12 Dec '06

12 Dec '06

Author: seb Date: Tue Dec 12 15:11:29 2006 New Revision: 1074 Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SMTPAppenderTest.java logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SMTPAppenderTestApp.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/net/SMTPAppenderBase.java Log: Now allowing multiple <To> elements in config files Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SMTPAppenderTest.java ============================================================================== --- logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SMTPAppenderTest.java (original) +++ logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SMTPAppenderTest.java Tue Dec 12 15:11:29 2006 @@ -24,7 +24,7 @@ appender.setLayout(buildLayout(lc)); appender.setSMTPHost("mail2.qos.ch"); appender.setSubject("logging report"); - appender.setTo("sebastien.nospam(a)qos.ch"); + appender.addTo("sebastien.nospam(a)qos.ch"); appender.start(); } Modified: logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SMTPAppenderTestApp.java ============================================================================== --- logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SMTPAppenderTestApp.java (original) +++ logback/trunk/logback-classic/src/test/java/ch/qos/logback/classic/net/SMTPAppenderTestApp.java Tue Dec 12 15:11:29 2006 @@ -24,7 +24,7 @@ appender.setLayout(buildLayout(lc)); appender.setSMTPHost("mail.qos.ch"); appender.setSubject("logging report"); - appender.setTo("sebastien.nospam(a)qos.ch"); + appender.addTo("sebastien.nospam(a)qos.ch"); appender.start(); Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/net/SMTPAppenderBase.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/net/SMTPAppenderBase.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/net/SMTPAppenderBase.java Tue Dec 12 15:11:29 2006 @@ -10,7 +10,9 @@ package ch.qos.logback.core.net; +import java.util.ArrayList; import java.util.Date; +import java.util.List; import java.util.Properties; import javax.mail.Message; @@ -30,20 +32,19 @@ import ch.qos.logback.core.boolex.EventEvaluator; /** - * An abstract class that provides basic support for - * sending events to an email address. + * An abstract class that provides basic support for sending events to an email + * address. * * @author Ceki Gülcü * @author Sébastien Pennec * */ public abstract class SMTPAppenderBase extends AppenderBase { - - + protected Layout layout; protected Layout subjectLayout; - private String to; + private List<String> to = new ArrayList<String>(); private String from; private String subjectStr = null; private String smtpHost; @@ -53,16 +54,16 @@ protected EventEvaluator eventEvaluator; /** - * return a layout for the subjet string as appropriate for the - * module. If the subjectStr parameter is null, then a default - * value for subjectStr should be used. + * return a layout for the subjet string as appropriate for the module. If the + * subjectStr parameter is null, then a default value for subjectStr should be + * used. * * @param subjectStr * * @return a layout as appropriate for the module */ abstract protected Layout makeSubjectLayout(String subjectStr); - + /** * Start the appender */ @@ -84,9 +85,9 @@ } msg.setRecipients(Message.RecipientType.TO, parseAddress(to)); - + subjectLayout = makeSubjectLayout(subjectStr); - + started = true; } catch (MessagingException e) { @@ -95,8 +96,8 @@ } /** - * Perform SMTPAppender specific appending actions, delegating some - * of them to a subclass and checking if the event triggers an e-mail to be sent. + * Perform SMTPAppender specific appending actions, delegating some of them to + * a subclass and checking if the event triggers an e-mail to be sent. */ protected void append(Object eventObject) { @@ -107,14 +108,14 @@ subAppend(eventObject); try { - if (eventEvaluator.evaluate(eventObject)) { - sendBuffer(eventObject); - } + if (eventEvaluator.evaluate(eventObject)) { + sendBuffer(eventObject); + } } catch (EvaluationException ex) { addError("SMTPAppender's EventEvaluator threw an Exception" + ex); } } - + abstract protected void subAppend(Object eventObject); /** @@ -137,7 +138,9 @@ } if (this.layout == null) { - addError("No layout set for appender named [" + name + "]. For more information, please visit http://logback.qos.ch/codes.html#smtp_no_layout"); + addError("No layout set for appender named [" + + name + + "]. For more information, please visit http://logback.qos.ch/codes.html#smtp_no_layout"); return false; } return true; @@ -156,19 +159,28 @@ } } - InternetAddress[] parseAddress(String addressStr) { - try { - return InternetAddress.parse(addressStr, true); - } catch (AddressException e) { - addError("Could not parse address [" + addressStr + "].", e); - return null; + InternetAddress[] parseAddress(List<String> addressList) { + + InternetAddress[] iaArray = new InternetAddress[addressList.size()]; + + for (int i = 0; i < addressList.size(); i++) { + try { + InternetAddress[] tmp = InternetAddress.parse(addressList.get(i), true); + //one <To> element should contain one email address + iaArray[i] = tmp[0]; + } catch (AddressException e) { + addError("Could not parse address [" + addressList.get(i) + "].", e); + return null; + } } + + return iaArray; } /** * Returns value of the <b>To</b> option. */ - public String getTo() { + public List<String> getTo() { return to; } @@ -183,7 +195,7 @@ MimeBodyPart part = new MimeBodyPart(); StringBuffer sbuf = new StringBuffer(); - + String header = layout.getFileHeader(); if (header != null) { sbuf.append(header); @@ -201,11 +213,11 @@ if (presentationFooter != null) { sbuf.append(presentationFooter); } - + if (subjectLayout != null) { msg.setSubject(subjectLayout.doLayout(lastEventObject)); } - + part.setContent(sbuf.toString(), layout.getContentType()); Multipart mp = new MimeMultipart(); @@ -218,8 +230,8 @@ addError("Error occured while sending e-mail notification.", e); } } - - abstract protected void fillBuffer(StringBuffer sbuf); + + abstract protected void fillBuffer(StringBuffer sbuf); /** * Returns value of the <b>From</b> option. @@ -234,7 +246,7 @@ public String getSubject() { return subjectStr; } - + /** * The <b>From</b> option takes a string value which should be a e-mail * address of the sender. @@ -250,7 +262,7 @@ public void setSubject(String subject) { this.subjectStr = subject; } - + /** * The <b>SMTPHost</b> option takes a string value which should be a the host * name of the SMTP server that will send the e-mail message. @@ -267,28 +279,28 @@ } /** - * The <b>To</b> option takes a string value which should be a comma - * separated list of e-mail address of the recipients. + * The <b>To</b> option takes a string value which should be + * an e-mail address of one of the recipients. */ - public void setTo(String to) { - this.to = to; + public void addTo(String to) { + this.to.add(to); } - - //for testing purpose only + + // for testing purpose only public Message getMessage() { return msg; } - - //for testing purpose only + + // for testing purpose only public void setMessage(Message msg) { this.msg = msg; } - + /** * The <b>EventEvaluator</b> option takes a string value representing the - * name of the class implementing the {@link EventEvaluators} - * interface. A corresponding object will be instantiated and assigned as the - * event evaluator for the SMTPAppender. + * name of the class implementing the {@link EventEvaluators} interface. A + * corresponding object will be instantiated and assigned as the event + * evaluator for the SMTPAppender. */ public void setEvaluator(EventEvaluator eventEvaluator) { this.eventEvaluator = eventEvaluator;

1 0

svn commit: r1073 - logback/trunk/logback-site/src/site/resources
by noreply.seb＠qos.ch 06 Dec '06

06 Dec '06

Author: seb Date: Wed Dec 6 19:42:16 2006 New Revision: 1073 Removed: logback/trunk/logback-site/src/site/resources/modules.EAP Log: removed unused file

1 0

svn commit: r1072 - logback/trunk/logback-site/src/site/xdocTemplates/manual
by noreply.seb＠qos.ch 06 Dec '06

06 Dec '06

Author: seb Date: Wed Dec 6 19:39:25 2006 New Revision: 1072 Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml Log: minor fix Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml Wed Dec 6 19:39:25 2006 @@ -197,8 +197,6 @@ event to the appropriate device. </p> -  - <p>In appenders, the term option or property is reserved for named attributes that are dynamically inferred using JavaBeans introspection. </p>

1 0

svn commit: r1071 - in logback/trunk/logback-site/src/site: resources/images xdocTemplates
by noreply.seb＠qos.ch 06 Dec '06

06 Dec '06

Author: seb Date: Wed Dec 6 19:36:52 2006 New Revision: 1071 Removed: logback/trunk/logback-site/src/site/resources/images/hortisMG.ai logback/trunk/logback-site/src/site/resources/images/hortisMG.gif Modified: logback/trunk/logback-site/src/site/xdocTemplates/documentation.xml logback/trunk/logback-site/src/site/xdocTemplates/index.xml Log: Removed demo ad Added a link to the ppt on the documentation page Modified: logback/trunk/logback-site/src/site/xdocTemplates/documentation.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/documentation.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/documentation.xml Wed Dec 6 19:36:52 2006 @@ -47,6 +47,14 @@ </li> </ul> + <p> + Recently, Ceki Gülcü presented the top 10 reasons for migrating your projects to logback. + Issues such as migration strategy, new APIs, SLF4J and Joran were be discussed. Emphasis was given to + practical aspects and a live demo rather than relatively theoretical considerations. If you were + not able to attend the presentation (or even if you were there), you can + <a href="10reasons.ppt">download the slides</a> that Ceki used. + </p> + </body> </document> \ No newline at end of file Modified: logback/trunk/logback-site/src/site/xdocTemplates/index.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/index.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/index.xml Wed Dec 6 19:36:52 2006 @@ -9,30 +9,10 @@ <body> - <h3>10 reasons to switch to logback</h3> - - <p> - <a href=" http://tinyurl.com/yjcq33"> <img border="0" src="images/hortisMG.gif"/></a> - </p> - - <p>On the 5th of December, Ceki Gülcü will be presenting - (in French) top <a href="10reasons.ppt"><b>10 reasons for - migrating</b></a> your projects to logback. Issues such as - migration strategy, new APIs, SLF4J and Joran will be - discussed. Emphasis will be given to practical aspects and a live - demo rather than relatively theoretical considerations. - </p> - - <p>This <a href=" http://tinyurl.com/yjcq33">free-entry event</a> - is organized in colloboration with <a - href="http://www.hortis.ch">Hortis SA</a>.</p> - - - <h2>Logback Project</h2> <p> Logback is intended as a successor to the popular log4j - project. It was designed by Ceki Gülc�, the founder of the + project. It was designed by Ceki Gülcü, the founder of the log4j project. It builds upon exerience gained in building industrial-strength logging systems going back as far as 1999. </p>

1 0

svn commit: r1070 - in logback/trunk: logback-site/src/site/resources/manual/images/chapter4 logback-site/src/site/resources/manual/images/chapter6 logback-site/src/site/xdocTemplates/manual logback-skin/src/main/resources/css
by noreply.seb＠qos.ch 06 Dec '06

06 Dec '06

Author: seb Date: Wed Dec 6 19:30:01 2006 New Revision: 1070 Added: logback/trunk/logback-site/src/site/resources/manual/images/chapter4/fileAppenderUML.png (contents, props changed) Modified: logback/trunk/logback-site/src/site/resources/manual/images/chapter6/ (props changed) logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml logback/trunk/logback-skin/src/main/resources/css/site.css Log: Added a diagram to illustrate WriterAppender and surrounding classes Modified CSS style to center images Added: logback/trunk/logback-site/src/site/resources/manual/images/chapter4/fileAppenderUML.png ============================================================================== Binary file. No diff available. Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml Wed Dec 6 19:30:01 2006 @@ -328,10 +328,11 @@ <p> The <code>WriterAppender</code> is the super class of four other appenders, namely <code>ConsoleAppender</code>, <code>FileAppender</code> which in turn is - the super class of <code>RollingFileAppender</code>. + the super class of <code>RollingFileAppender</code>. The next figure illustrates + the class diagram for <code>WriterAppender</code> and its subclasses. </p> -  + <img src="images/chapter4/fileAppenderUML.png" alt="A UML diagram showing FileAppender"/> <a name="ConsoleAppender" /> <h3>ConsoleAppender</h3> @@ -2634,7 +2635,7 @@ </configuration></pre></div> - <a name="WriteOwnAppender" /> + <a name="WriteYourOwnAppender" /> <h2>Writing your own Appender</h2> Modified: logback/trunk/logback-skin/src/main/resources/css/site.css ============================================================================== --- logback/trunk/logback-skin/src/main/resources/css/site.css (original) +++ logback/trunk/logback-skin/src/main/resources/css/site.css Wed Dec 6 19:30:01 2006 @@ -11,6 +11,9 @@ img { border: none; + display: block; + margin-left: auto; + margin-right: auto } acronym {

1 0

svn commit: r1069 - in logback/trunk/logback-core/src: main/java/ch/qos/logback/core main/java/ch/qos/logback/core/db main/java/ch/qos/logback/core/net main/java/ch/qos/logback/core/read test/java/ch/qos/logback/core/appender
by noreply.seb＠qos.ch 06 Dec '06

06 Dec '06

Author: seb Date: Wed Dec 6 19:14:28 2006 New Revision: 1069 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/AppenderBase.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/db/DBAppenderBase.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/net/SocketAppenderBase.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/read/CyclicBufferAppender.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/read/ListAppender.java logback/trunk/logback-core/src/test/java/ch/qos/logback/core/appender/NOPAppender.java Log: Moved getter and setter for layout to AppenderBase. Removed unused methods from subclasses Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/AppenderBase.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/AppenderBase.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/AppenderBase.java Wed Dec 6 19:14:28 2006 @@ -129,4 +129,11 @@ public FilterReply getFilterChainDecision(Object event) { return fai.getFilterChainDecision(event); } + + public Layout getLayout() { + return null; + } + + public void setLayout(Layout layout) { + } } Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/db/DBAppenderBase.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/db/DBAppenderBase.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/db/DBAppenderBase.java Wed Dec 6 19:14:28 2006 @@ -19,7 +19,6 @@ import java.sql.Statement; import ch.qos.logback.core.AppenderBase; -import ch.qos.logback.core.Layout; import ch.qos.logback.core.db.dialect.DBUtil; import ch.qos.logback.core.db.dialect.SQLDialect; @@ -159,12 +158,4 @@ public void stop() { super.stop(); } - - public Layout getLayout() { - return null; - } - - public void setLayout(Layout layout) { - } - } Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/net/SocketAppenderBase.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/net/SocketAppenderBase.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/net/SocketAppenderBase.java Wed Dec 6 19:14:28 2006 @@ -17,7 +17,6 @@ import java.net.Socket; import ch.qos.logback.core.AppenderBase; -import ch.qos.logback.core.Layout; /** * @@ -251,13 +250,6 @@ return reconnectionDelay; } - public Layout getLayout() { - return null; - } - - public void setLayout(Layout layout) { - } - /** * The Connector will reconnect when the server becomes available again. It * does this by attempting to open a new connection every Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/read/CyclicBufferAppender.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/read/CyclicBufferAppender.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/read/CyclicBufferAppender.java Wed Dec 6 19:14:28 2006 @@ -10,7 +10,6 @@ package ch.qos.logback.core.read; import ch.qos.logback.core.AppenderBase; -import ch.qos.logback.core.Layout; import ch.qos.logback.core.helpers.CyclicBuffer; /** @@ -59,13 +58,6 @@ } } - public Layout getLayout() { - return null; - } - - public void setLayout(Layout layout) { - } - /** * Set the size of the cyclic buffer. */ Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/read/ListAppender.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/read/ListAppender.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/read/ListAppender.java Wed Dec 6 19:14:28 2006 @@ -13,7 +13,6 @@ import java.util.List; import ch.qos.logback.core.AppenderBase; -import ch.qos.logback.core.Layout; public class ListAppender extends AppenderBase { @@ -23,12 +22,4 @@ protected void append(Object o) { list.add(o); } - - public void setLayout(Layout layout) { - } - - public Layout getLayout() { - return null; - } - } Modified: logback/trunk/logback-core/src/test/java/ch/qos/logback/core/appender/NOPAppender.java ============================================================================== --- logback/trunk/logback-core/src/test/java/ch/qos/logback/core/appender/NOPAppender.java (original) +++ logback/trunk/logback-core/src/test/java/ch/qos/logback/core/appender/NOPAppender.java Wed Dec 6 19:14:28 2006 @@ -1,19 +1,10 @@ package ch.qos.logback.core.appender; import ch.qos.logback.core.AppenderBase; -import ch.qos.logback.core.Layout; public class NOPAppender extends AppenderBase { @Override protected void append(Object eventObject) { } - - public Layout getLayout() { - return null; - } - - public void setLayout(Layout layout) { - } - }

1 0