July 2006 - logback-dev - mailman3.qos.ch

svn commit: r387 - in logback/core/trunk/src: main/java/ch/qos/logback/core main/java/ch/qos/logback/core/joran main/java/ch/qos/logback/core/joran/action main/java/ch/qos/logback/core/joran/spi main/java/ch/qos/logback/core/pattern main/java/ch/qos/logback/core/util test/java/ch/qos/logback/core/appender test/java/ch/qos/logback/core/pattern/parser
by noreply.ceki＠qos.ch 31 Jul '06

31 Jul '06

Author: ceki Date: Mon Jul 31 20:14:14 2006 New Revision: 387 Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/Context.java logback/core/trunk/src/main/java/ch/qos/logback/core/ContextBase.java logback/core/trunk/src/main/java/ch/qos/logback/core/joran/JoranConfiguratorBase.java logback/core/trunk/src/main/java/ch/qos/logback/core/joran/action/AbstractEventEvaluatorAction.java logback/core/trunk/src/main/java/ch/qos/logback/core/joran/action/AppenderAction.java logback/core/trunk/src/main/java/ch/qos/logback/core/joran/action/ConversionRuleAction.java logback/core/trunk/src/main/java/ch/qos/logback/core/joran/action/RepositoryPropertyAction.java logback/core/trunk/src/main/java/ch/qos/logback/core/joran/spi/ExecutionContext.java logback/core/trunk/src/main/java/ch/qos/logback/core/joran/spi/Interpreter.java logback/core/trunk/src/main/java/ch/qos/logback/core/pattern/PatternLayoutBase.java logback/core/trunk/src/main/java/ch/qos/logback/core/util/OptionHelper.java logback/core/trunk/src/main/java/ch/qos/logback/core/util/PropertySetter.java logback/core/trunk/src/test/java/ch/qos/logback/core/appender/ListAppender.java logback/core/trunk/src/test/java/ch/qos/logback/core/pattern/parser/SamplePatternLayout.java Log: minor changes correcting type safety issues Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/Context.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/Context.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/Context.java Mon Jul 31 20:14:14 2006 @@ -56,7 +56,7 @@ * LB contexts have a notion of context-specific converter maps. * @return */ - public Map getConverterMap(); + public Map<String, String> getConverterMap(); /** * Contexts are named objects. Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/ContextBase.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/ContextBase.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/ContextBase.java Mon Jul 31 20:14:14 2006 @@ -23,14 +23,14 @@ StatusManager sm = new BasicStatusManager(); Map<String, String> propertyMap = new HashMap<String, String>(); Map<String, Object> objectMap = new HashMap<String, Object>(); - Map converterMap = new HashMap(); + Map<String, String> converterMap = new HashMap<String, String>(); private FilterAttachableImpl fai = new FilterAttachableImpl(); public StatusManager getStatusManager() { return sm; } - public Map getPropertyMap() { + public Map<String, String> getPropertyMap() { return propertyMap; } @@ -50,7 +50,7 @@ objectMap.put(key, value); } - public Map getConverterMap() { + public Map<String, String> getConverterMap() { return converterMap; } Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/joran/JoranConfiguratorBase.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/joran/JoranConfiguratorBase.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/joran/JoranConfiguratorBase.java Mon Jul 31 20:14:14 2006 @@ -176,7 +176,7 @@ nestedIA.setContext(context); joranInterpreter.addImplicitAction(nestedSimpleIA); - Map omap = ec.getObjectMap(); + Map<String, Object> omap = ec.getObjectMap(); omap.put(ActionConst.APPENDER_BAG, new HashMap()); omap.put(ActionConst.FILTER_CHAIN_BAG, new HashMap()); } Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/joran/action/AbstractEventEvaluatorAction.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/joran/action/AbstractEventEvaluatorAction.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/joran/action/AbstractEventEvaluatorAction.java Mon Jul 31 20:14:14 2006 @@ -113,7 +113,7 @@ ec.popObject(); try { - Map evaluatorMap = (Map) context.getObject(CoreGlobal.EVALUATOR_MAP); + Map<String, EventEvaluator> evaluatorMap = (Map) context.getObject(CoreGlobal.EVALUATOR_MAP); evaluatorMap.put(evaluator.getName(), evaluator); } catch (Exception ex) { addError( Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/joran/action/AppenderAction.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/joran/action/AppenderAction.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/joran/action/AppenderAction.java Mon Jul 31 20:14:14 2006 @@ -59,7 +59,7 @@ // The execution context contains a bag which contains the appenders // created thus far. - HashMap appenderBag = + HashMap<String, Appender> appenderBag = (HashMap) ec.getObjectMap().get(ActionConst.APPENDER_BAG); // add the appender just created to the appender bag. Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/joran/action/ConversionRuleAction.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/joran/action/ConversionRuleAction.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/joran/action/ConversionRuleAction.java Mon Jul 31 20:14:14 2006 @@ -60,9 +60,9 @@ //LoggerRepository repository = (LoggerRepository) ec.getObjectStack().get(0); - Map ruleRegistry = (Map) context.getObject(CoreGlobal.PATTERN_RULE_REGISTRY); + Map<String, String> ruleRegistry = (Map) context.getObject(CoreGlobal.PATTERN_RULE_REGISTRY); if(ruleRegistry == null) { - ruleRegistry = new HashMap(); + ruleRegistry = new HashMap<String, String>(); context.putObject(CoreGlobal.PATTERN_RULE_REGISTRY, ruleRegistry); } // put the new rule into the rule registry Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/joran/action/RepositoryPropertyAction.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/joran/action/RepositoryPropertyAction.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/joran/action/RepositoryPropertyAction.java Mon Jul 31 20:14:14 2006 @@ -11,6 +11,11 @@ */ public class RepositoryPropertyAction extends PropertyAction { + /** + * Add all the properties found in the argument named 'props' to an ExecutionContext. + * + */ + @SuppressWarnings("unchecked") public void setProperties(ExecutionContext ec, Properties props) { this.context.getPropertyMap().putAll(props); } Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/joran/spi/ExecutionContext.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/joran/spi/ExecutionContext.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/joran/spi/ExecutionContext.java Mon Jul 31 20:14:14 2006 @@ -34,15 +34,15 @@ * @author Ceki Gülcü */ public class ExecutionContext extends ContextAwareBase { - Stack objectStack; - Map objectMap; + Stack<Object> objectStack; + Map<String, Object> objectMap; Properties substitutionProperties; Interpreter joranInterpreter; public ExecutionContext(Interpreter joranInterpreter) { this.joranInterpreter = joranInterpreter; - objectStack = new Stack(); - objectMap = new HashMap(5); + objectStack = new Stack<Object> (); + objectMap = new HashMap<String, Object>(5); substitutionProperties = new Properties(); } @@ -101,7 +101,7 @@ return joranInterpreter; } - public Stack getObjectStack() { + public Stack<Object> getObjectStack() { return objectStack; } @@ -121,7 +121,7 @@ return objectStack.get(i); } - public Map getObjectMap() { + public Map<String, Object> getObjectMap() { return objectMap; } Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/joran/spi/Interpreter.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/joran/spi/Interpreter.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/joran/spi/Interpreter.java Mon Jul 31 20:14:14 2006 @@ -62,7 +62,7 @@ private static List EMPTY_LIST = new Vector(0); private RuleStore ruleStore; private ExecutionContext ec; - private ArrayList implicitActions; + private ArrayList<ImplicitAction> implicitActions; Pattern pattern; Locator locator; @@ -74,7 +74,7 @@ * {@link #endElement}. * */ - Stack actionListStack; + Stack<List> actionListStack; /** * If the skip nested is set, then we skip all its nested elements until it is @@ -85,9 +85,9 @@ public Interpreter(RuleStore rs) { ruleStore = rs; ec = new ExecutionContext(this); - implicitActions = new ArrayList(3); + implicitActions = new ArrayList<ImplicitAction>(3); pattern = new Pattern(); - actionListStack = new Stack(); + actionListStack = new Stack<List>(); } public ExecutionContext getExecutionContext() { @@ -192,7 +192,7 @@ ImplicitAction ia = (ImplicitAction) implicitActions.get(i); if (ia.isApplicable(pattern, attributes, ec)) { - List actionList = new ArrayList(1); + List<Action> actionList = new ArrayList<Action>(1); actionList.add(ia); return actionList; Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/pattern/PatternLayoutBase.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/pattern/PatternLayoutBase.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/pattern/PatternLayoutBase.java Mon Jul 31 20:14:14 2006 @@ -33,21 +33,21 @@ * * @return A map associating pattern words to the names of converter classes */ - abstract public Map getDefaultConverterMap(); + abstract public Map<String, String> getDefaultConverterMap(); /** * Returns a map where the default converter map is merged with the map * contained in the context. */ - public Map getConverterMap() { - Map map = new HashMap(); - Map defaultMap = getDefaultConverterMap(); + public Map<String, String> getConverterMap() { + Map<String, String> map = new HashMap<String, String>(); + Map<String, String> defaultMap = getDefaultConverterMap(); if (defaultMap != null) { map.putAll(defaultMap); } Context context = getContext(); if (context != null) { - Map contextMap = context.getConverterMap(); + Map<String, String> contextMap = context.getConverterMap(); if (contextMap != null) { map.putAll(contextMap); } Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/util/OptionHelper.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/util/OptionHelper.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/util/OptionHelper.java Mon Jul 31 20:14:14 2006 @@ -19,6 +19,7 @@ */ public class OptionHelper { + @SuppressWarnings("unchecked") public static Object instantiateByClassName(String className, Class superClass) throws ClassNotFoundException, IncompatibleClassException, InstantiationException, IllegalAccessException { Modified: logback/core/trunk/src/main/java/ch/qos/logback/core/util/PropertySetter.java ============================================================================== --- logback/core/trunk/src/main/java/ch/qos/logback/core/util/PropertySetter.java (original) +++ logback/core/trunk/src/main/java/ch/qos/logback/core/util/PropertySetter.java Mon Jul 31 20:14:14 2006 @@ -261,6 +261,7 @@ return objClass; } + @SuppressWarnings("unchecked") public void addComponent(String name, Object childComponent) { Class ccc = childComponent.getClass(); name = capitalizeFirstLetter(name); Modified: logback/core/trunk/src/test/java/ch/qos/logback/core/appender/ListAppender.java ============================================================================== --- logback/core/trunk/src/test/java/ch/qos/logback/core/appender/ListAppender.java (original) +++ logback/core/trunk/src/test/java/ch/qos/logback/core/appender/ListAppender.java Mon Jul 31 20:14:14 2006 @@ -19,6 +19,7 @@ public List list = new ArrayList(); + @SuppressWarnings("unchecked") protected void append(Object o) { list.add(o); } Modified: logback/core/trunk/src/test/java/ch/qos/logback/core/pattern/parser/SamplePatternLayout.java ============================================================================== --- logback/core/trunk/src/test/java/ch/qos/logback/core/pattern/parser/SamplePatternLayout.java (original) +++ logback/core/trunk/src/test/java/ch/qos/logback/core/pattern/parser/SamplePatternLayout.java Mon Jul 31 20:14:14 2006 @@ -27,7 +27,7 @@ converterMap.put("hello", ConverterHello.class.getName()); } - public Map getDefaultConverterMap() { + public Map<String, String> getDefaultConverterMap() { return converterMap; }

1 0

svn commit: r386 - in logback/classic/trunk: . anakia-lib examples examples/src examples/src/chapter1 src/main/java/ch/qos/logback/classic src/main/java/ch/qos/logback/classic/examples src/site/xdocTemplates src/test/java/ch/qos/logback/classic/control src/test/java/ch/qos/logback/classic/joran
by noreply.ceki＠qos.ch 31 Jul '06

31 Jul '06

Author: ceki Date: Mon Jul 31 20:12:57 2006 New Revision: 386 Added: logback/classic/trunk/anakia-lib/ logback/classic/trunk/anakia-lib/ant-1.4.1.jar (contents, props changed) logback/classic/trunk/anakia-lib/commons-collections-2.0.jar (contents, props changed) logback/classic/trunk/anakia-lib/jdom-b8.jar (contents, props changed) logback/classic/trunk/anakia-lib/log4j-1.1.3.jar (contents, props changed) logback/classic/trunk/anakia-lib/velocity-1.4-dev.jar (contents, props changed) logback/classic/trunk/anakia-lib/velocity-1.4.jar (contents, props changed) logback/classic/trunk/anakia-lib/xerces-1.4.4.jar (contents, props changed) logback/classic/trunk/examples/ logback/classic/trunk/examples/src/ logback/classic/trunk/examples/src/chapter1/ logback/classic/trunk/examples/src/chapter1/BabySteps1.java - copied, changed from r385, logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps1.java logback/classic/trunk/examples/src/chapter1/BabySteps2.java - copied, changed from r385, logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps2.java logback/classic/trunk/examples/src/chapter1/BabySteps3.java - copied, changed from r385, logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps3.java logback/classic/trunk/examples/src/chapter1/MyApp.java - copied, changed from r385, logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/MyApp.java logback/classic/trunk/site.xml Removed: logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/ Modified: logback/classic/trunk/pom.xml logback/classic/trunk/src/main/java/ch/qos/logback/classic/PatternLayout.java logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml logback/classic/trunk/src/test/java/ch/qos/logback/classic/control/ControlLoggerContext.java logback/classic/trunk/src/test/java/ch/qos/logback/classic/control/Scenario.java logback/classic/trunk/src/test/java/ch/qos/logback/classic/joran/BasicJoranTest.java Log: - added anakia-lib directory for faster site builds - moved examples to examples/src directory. They shoould not be part of the main build - small changes correcting type safety issues Added: logback/classic/trunk/anakia-lib/ant-1.4.1.jar ============================================================================== Binary file. No diff available. Added: logback/classic/trunk/anakia-lib/commons-collections-2.0.jar ============================================================================== Binary file. No diff available. Added: logback/classic/trunk/anakia-lib/jdom-b8.jar ============================================================================== Binary file. No diff available. Added: logback/classic/trunk/anakia-lib/log4j-1.1.3.jar ============================================================================== Binary file. No diff available. Added: logback/classic/trunk/anakia-lib/velocity-1.4-dev.jar ============================================================================== Binary file. No diff available. Added: logback/classic/trunk/anakia-lib/velocity-1.4.jar ============================================================================== Binary file. No diff available. Added: logback/classic/trunk/anakia-lib/xerces-1.4.4.jar ============================================================================== Binary file. No diff available. Copied: logback/classic/trunk/examples/src/chapter1/BabySteps1.java (from r385, logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps1.java) ============================================================================== --- logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps1.java (original) +++ logback/classic/trunk/examples/src/chapter1/BabySteps1.java Mon Jul 31 20:12:57 2006 @@ -1,14 +1,13 @@ -package ch.qos.logback.classic.examples; +package chapter1; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class BabySteps1 { - final static Logger logger = LoggerFactory.getLogger(BabySteps1.class); - public static void main(String[] args) { + Logger logger = LoggerFactory.getLogger(BabySteps1.class); logger.debug("Hello world."); } Copied: logback/classic/trunk/examples/src/chapter1/BabySteps2.java (from r385, logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps2.java) ============================================================================== --- logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps2.java (original) +++ logback/classic/trunk/examples/src/chapter1/BabySteps2.java Mon Jul 31 20:12:57 2006 @@ -1,4 +1,4 @@ -package ch.qos.logback.classic.examples; +package chapter1; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -7,10 +7,10 @@ public class BabySteps2 { - final static Logger logger = LoggerFactory.getLogger(BabySteps1.class); - public static void main(String[] args) { + Logger logger = LoggerFactory.getLogger(BabySteps1.class); + logger.debug("Hello world."); LoggerStatusPrinter.printStatusInDefaultContext(); Copied: logback/classic/trunk/examples/src/chapter1/BabySteps3.java (from r385, logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps3.java) ============================================================================== --- logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps3.java (original) +++ logback/classic/trunk/examples/src/chapter1/BabySteps3.java Mon Jul 31 20:12:57 2006 @@ -1,4 +1,4 @@ -package ch.qos.logback.classic.examples; +package chapter1; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -8,9 +8,10 @@ public class BabySteps3 { - final static Logger logger = LoggerFactory.getLogger(BabySteps1.class); - + public static void main(String[] args) { + + Logger logger = LoggerFactory.getLogger(BabySteps1.class); BasicConfigurator.configureDefaultContext(); logger.debug("Hello world."); Copied: logback/classic/trunk/examples/src/chapter1/MyApp.java (from r385, logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/MyApp.java) ============================================================================== --- logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/MyApp.java (original) +++ logback/classic/trunk/examples/src/chapter1/MyApp.java Mon Jul 31 20:12:57 2006 @@ -1,6 +1,6 @@ -package ch.qos.logback.classic.examples; +package chapter1; -// Import logback classes. +// Import SLF4J classes. import org.slf4j.LoggerFactory; import org.slf4j.Logger; @@ -25,7 +25,7 @@ } class Bar { - static Logger logger = LoggerFactory.getLogger(Bar.class); + Logger logger = LoggerFactory.getLogger(Bar.class); public void doIt() { logger.debug("doing my job"); } Modified: logback/classic/trunk/pom.xml ============================================================================== --- logback/classic/trunk/pom.xml (original) +++ logback/classic/trunk/pom.xml Mon Jul 31 20:12:57 2006 @@ -9,8 +9,8 @@ <artifactId>logback-classic</artifactId> <packaging>jar</packaging> <version>0.2-SNAPSHOT</version> - <name>Logback Classic Module</name> - + <name>Logback Classic Module</name> + <url>http://logback.qos.ch/classic</url> <description>  + </plugin> + <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> @@ -184,5 +186,5 @@ <id>pixie</id> <url>scp://pixie/var/www/logback.qos.ch/htdocs/classic</url> </site> - </distributionManagement> + </distributionManagement> </project> \ No newline at end of file Added: logback/classic/trunk/site.xml ============================================================================== --- (empty file) +++ logback/classic/trunk/site.xml Mon Jul 31 20:12:57 2006 @@ -0,0 +1,71 @@ + +<project name="logback-classic-site" default="site" basedir="." > + + +  + <property file="build.properties"/> + +  + <property name="base" value="."/> + +  + <property name="docs.dest" value="./target/site"/> + +  + <property name="xdocs.src" value="./src/site/xdocTemplates/"/> + +  + <path id="site.classpath"> + <fileset dir="./anakia-lib"> + <include name="*.jar"/> + </fileset> + </path> + + +  +  +  + + <target name="usage"> + <echo> + + These are the targets supported by this ANT build scpript: + + site - build LOGBACK CLASSIC web-site + </echo> + </target> + +  +  +  + <target name="prepareSite"> + <available classname="org.apache.velocity.anakia.AnakiaTask" + property="AnakiaTask.present"> + <classpath refid="site.classpath"/> + </available> + </target> + + <target name="checkSite" depends="prepareSite" unless="AnakiaTask.present"> + <echo> + AnakiaTask is not present! Please check to make sure that + velocity.jar is in your classpath. + </echo> + </target> + + <target name="site" depends="checkSite" if="AnakiaTask.present"> + <taskdef name="anakia" classname="org.apache.velocity.anakia.AnakiaTask"> + <classpath refid="site.classpath"/> + </taskdef> + + <anakia basedir="${xdocs.src}" destdir="${docs.dest}/" + extension=".html" + style="site.vm" + projectFile="stylesheets/project.xml" + excludes="**/stylesheets/**" + includes="**/*.xml" + lastModifiedCheck="true" + templatePath="./stylesheets"> + </anakia> + </target> +</project> + Modified: logback/classic/trunk/src/main/java/ch/qos/logback/classic/PatternLayout.java ============================================================================== --- logback/classic/trunk/src/main/java/ch/qos/logback/classic/PatternLayout.java (original) +++ logback/classic/trunk/src/main/java/ch/qos/logback/classic/PatternLayout.java Mon Jul 31 20:12:57 2006 @@ -115,7 +115,7 @@ setContextForConverters(head); } - public Map getDefaultConverterMap() { + public Map<String, String> getDefaultConverterMap() { return defaultConverterMap; } Modified: logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml ============================================================================== --- logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml (original) +++ logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml Mon Jul 31 20:12:57 2006 @@ -9,9 +9,7 @@ <body> - <div class="section"> - <h2>Short introduction</h2> - </div> + <h2>Short introduction</h2> <div class="author"> Authors: Ceki Gülcü, Sébastien Pennec </div> @@ -44,9 +42,8 @@ </tr> </table> - <div class="section"> - <h2>Introduction</h2> - </div> + <h2>Introduction</h2> + <p> Logging is a low-tech way of debugging your code. It might also be the only way, when debuggers are not available or @@ -68,57 +65,53 @@ work. </p> - <div class="section"> - <h2>Logback architecture</h2> + <h2>Logback architecture</h2> - <p> - Logback's basic architecture is sufficiently generic so - as to apply under different circumstances. At present - time, logback is divided into three modules, Core, - Classic and Access. - </p> - <p> - The Core module lays the groundwork for the other two - modules. The Classic module extends the core module, it - can be assimilated to an improved version of log4j. - Logback Classic natively implements the SLF4J API so - that you can readily switch back and forth between - logback and other logging systems such as log4j or JDK14 - Logging. The Access module also extends the core - functionnalities and integrates with Servlet containers - to provide HTPP-access log functionality. - </p> - <p> - Note that you can easily build your own modules on top - of the Core module. - </p> - </div> - - <div class="section"> - <h2>First Baby Steps</h2> - </div> - <p> - After you have added the logback classic jar to your classpath, - you can test a small program that uses its functionalities. + <p> + Logback's basic architecture is sufficiently generic so as to + apply under different circumstances. At present time, logback + is divided into three modules, Core, Classic and Access. + </p> + + <p>The Core module lays the groundwork for the other two + modules. The Classic module extends the core module, it can be + assimilated to an improved version of log4j. Logback Classic + natively implements the SLF4J API so that you can readily switch + back and forth between logback and other logging systems such as + log4j or JDK14 Logging. The Access module also extends the core + functionnalities and integrates with Servlet containers to provide + HTPP-access log functionality. + </p> + + <p>Note that you can easily build your own modules on top of the + Core module. + </p> + + <h2>First Baby Steps</h2> + + <p> After you have added the jar fiiles <em>logback-core.jar</em> + and <em>logback-classic.jar</em> to your classpath, you can start + testing a small program that uses logback. </p> <div class="source"> -package ch.qos.logback.classic.examples; +package chapter1; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class BabySteps1 { - final static Logger logger = LoggerFactory.getLogger(BabySteps1.class); public static void main(String[] args) { + Logger logger = LoggerFactory.getLogger(BabySteps1.class); logger.debug("Hello world."); } } </div> + <p> This is the basic, yet usual way of using logback classic. It starts by importing the Logger and LoggerFactory from SLF4J. @@ -254,9 +247,8 @@ of logback. </p> - <div class="section"> - <h3>Logger hierarchy</h3> - </div> + <h3>Logger hierarchy</h3> + <p> The first and foremost advantage of any logging API over plain System.out.println resides in its ability to disable @@ -699,9 +691,7 @@ located seems to be the best strategy known so far. </p> - <div class="section"> - <h3>Appenders and Layouts</h3> - </div> + <h3>Appenders and Layouts</h3> <p> The ability to selectively enable or disable logging @@ -980,9 +970,8 @@ <div class="source">logger.debug("Value {} was inserted between {} and {}.", new Object[] {newVal, below, above});</div> - <div class="section"> - <h3>Configuration</h3> - </div> + <h3>Configuration</h3> + <p> Inserting log requests into the application code requires a fair amount of planning and effort. Observation shows that Modified: logback/classic/trunk/src/test/java/ch/qos/logback/classic/control/ControlLoggerContext.java ============================================================================== --- logback/classic/trunk/src/test/java/ch/qos/logback/classic/control/ControlLoggerContext.java (original) +++ logback/classic/trunk/src/test/java/ch/qos/logback/classic/control/ControlLoggerContext.java Mon Jul 31 20:12:57 2006 @@ -33,7 +33,7 @@ private ControlLogger root; // // Hashtable loggerMap = new Hashtable(); - Map loggerMap = new HashMap(); + Map<String, ControlLogger> loggerMap = new HashMap<String, ControlLogger>(); public ControlLoggerContext() { this.root = new ControlLogger("root", null); Modified: logback/classic/trunk/src/test/java/ch/qos/logback/classic/control/Scenario.java ============================================================================== --- logback/classic/trunk/src/test/java/ch/qos/logback/classic/control/Scenario.java (original) +++ logback/classic/trunk/src/test/java/ch/qos/logback/classic/control/Scenario.java Mon Jul 31 20:12:57 2006 @@ -14,7 +14,6 @@ import java.util.Vector; import ch.qos.logback.classic.Level; -import ch.qos.logback.core.joran.action.Action; public class Scenario { // the frequency of a set levelInt event for every create logger event Modified: logback/classic/trunk/src/test/java/ch/qos/logback/classic/joran/BasicJoranTest.java ============================================================================== --- logback/classic/trunk/src/test/java/ch/qos/logback/classic/joran/BasicJoranTest.java (original) +++ logback/classic/trunk/src/test/java/ch/qos/logback/classic/joran/BasicJoranTest.java Mon Jul 31 20:12:57 2006 @@ -48,7 +48,6 @@ StatusPrinter.print(loggerContext.getStatusManager()); Logger logger = loggerContext.getLogger(this.getClass().getName()); - Logger root = loggerContext.getRootLogger(); String msg = "hello world"; logger.debug("toto"); logger.debug(msg);

1 0

svn commit: r385 - logback/classic/trunk/src/site/xdocTemplates
by noreply.seb＠qos.ch 28 Jul '06

28 Jul '06

Author: seb Date: Fri Jul 28 19:15:19 2006 New Revision: 385 Modified: logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml Log: minor change Modified: logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml ============================================================================== --- logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml (original) +++ logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml Fri Jul 28 19:15:19 2006 @@ -209,7 +209,7 @@ } </div> <p> - Let’s run the BabySteps class again. Now, the BasicConfigurator will create + Let's run the BabySteps class again. Now, the BasicConfigurator will create a simple console Appender. The logging request will then be propagated to the Appender and the console will output the following: </p> @@ -1050,7 +1050,7 @@ <p> The output of MyApp is: </p> -<div class="source"> +<div class="source"> 0 [main] INFO ch.qos.logback.classic.examples.MyApp - Entering application. 0 [main] DEBUG ch.qos.logback.classic.examples.Bar - doing my job 0 [main] INFO ch.qos.logback.classic.examples.MyApp - Exiting application.

1 0

svn commit: r384 - in logback/classic/trunk/src: main/java/ch/qos/logback/classic/examples site/xdocTemplates
by noreply.seb＠qos.ch 28 Jul '06

28 Jul '06

Author: seb Date: Fri Jul 28 19:02:39 2006 New Revision: 384 Added: logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/MyApp.java Modified: logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml Log: updated introduction + added a MyApp class in the examples Added: logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/MyApp.java ============================================================================== --- (empty file) +++ logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/MyApp.java Fri Jul 28 19:02:39 2006 @@ -0,0 +1,32 @@ +package ch.qos.logback.classic.examples; + +// Import logback classes. +import org.slf4j.LoggerFactory; +import org.slf4j.Logger; + +import ch.qos.logback.BasicConfigurator; + +public class MyApp { + + // Define a static logger variable so that it references the + // Logger instance named "MyApp". + static Logger logger = LoggerFactory.getLogger(MyApp.class); + + public static void main(String[] args) { + + // Set up a simple configuration that logs on the console. + BasicConfigurator.configureDefaultContext(); + + logger.info("Entering application."); + Bar bar = new Bar(); + bar.doIt(); + logger.info("Exiting application."); + } +} + +class Bar { + static Logger logger = LoggerFactory.getLogger(Bar.class); + public void doIt() { + logger.debug("doing my job"); + } +} \ No newline at end of file Modified: logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml ============================================================================== --- logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml (original) +++ logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml Fri Jul 28 19:02:39 2006 @@ -214,7 +214,7 @@ the Appender and the console will output the following: </p> <div class="source"> -Hello world. +0 [main] DEBUG ch.qos.logback.classic.examples.BabySteps3 - Hello world. This status manager contains no errors. </div> <p> @@ -980,10 +980,101 @@ <div class="source">logger.debug("Value {} was inserted between {} and {}.", new Object[] {newVal, below, above});</div> + <div class="section"> + <h3>Configuration</h3> + </div> + <p> + Inserting log requests into the application code requires + a fair amount of planning and effort. Observation shows that + approximately 4 percent of code is dedicated to logging. Consequently, + even moderately sized applications will have thousands of logging + statements embedded within their code. Given their number, it becomes + imperative to manage these log statements without the need to + modify them manually. + </p> + <p> + The logback environment is fully configurable programmatically. + However, it is far more flexible to configure logback using + configuration files. Currently, configuration files must be written in + XML format. + </p> + <p> + Let us give a taste of how this is done with the help of an + imaginary application MyApp that uses logback classic. + </p> +<div class="source"> +package ch.qos.logback.classic.examples; + +// Import logback classes. +import org.slf4j.LoggerFactory; +import org.slf4j.Logger; + +import ch.qos.logback.BasicConfigurator; +public class MyApp { + // Define a static logger variable so that it references the + // Logger instance named "MyApp". + static Logger logger = LoggerFactory.getLogger(MyApp.class); + public static void main(String[] args) { + // Set up a simple configuration that logs on the console. + BasicConfigurator.configureDefaultContext(); + + logger.info("Entering application."); + Bar bar = new Bar(); + bar.doIt(); + logger.info("Exiting application."); + } +} +</div> + <p> + This class begins by defining a static logger instance variable + with the name MyApp. It then uses the Bar class, defined as shown below: + </p> +<div class="source"> +class Bar { + static Logger logger = LoggerFactory.getLogger(Bar.class); + + public void doIt() { + logger.debug("doing my job"); + } +} +</div> + <p> + The invocation of the BasicConfigurator create, as we have seen, + a simple yet sufficient logback classic setup. By default, + the root Logger is assigned to Level.DEBUG. + </p> + <p> + The output of MyApp is: + </p> +<div class="source"> +0 [main] INFO ch.qos.logback.classic.examples.MyApp - Entering application. +0 [main] DEBUG ch.qos.logback.classic.examples.Bar - doing my job +0 [main] INFO ch.qos.logback.classic.examples.MyApp - Exiting application. +</div> + + + + + + + + + + + + + + + + + + + + </body> </document>

1 0

svn commit: r383 - logback/classic/trunk/src/main/java/ch/qos/logback
by noreply.seb＠qos.ch 28 Jul '06

28 Jul '06

Author: seb Date: Fri Jul 28 19:01:18 2006 New Revision: 383 Modified: logback/classic/trunk/src/main/java/ch/qos/logback/BasicConfigurator.java Log: corrected pattern + supressed code duplication Modified: logback/classic/trunk/src/main/java/ch/qos/logback/BasicConfigurator.java ============================================================================== --- logback/classic/trunk/src/main/java/ch/qos/logback/BasicConfigurator.java (original) +++ logback/classic/trunk/src/main/java/ch/qos/logback/BasicConfigurator.java Fri Jul 28 19:01:18 2006 @@ -14,7 +14,7 @@ ca.setContext(lc); ca.setName("console"); PatternLayout pl = new PatternLayout(); - pl.setPattern("%-4r [%t] %-5p %c %x - %m%n"); + pl.setPattern("%-4relative [%thread] %-5level %class - %msg%n"); pl.start(); ca.setLayout(pl); @@ -26,16 +26,6 @@ public static void configureDefaultContext() { Logger logger = (Logger) LoggerFactory.getLogger(BasicConfigurator.class); LoggerContext lc = logger.getLoggerContext(); - ConsoleAppender ca = new ConsoleAppender(); - ca.setContext(lc); - ca.setName("console"); - PatternLayout pl = new PatternLayout(); - pl.setPattern("%m%n"); - pl.start(); - - ca.setLayout(pl); - ca.start(); - Logger rootLogger = lc.getRootLogger(); - rootLogger.addAppender(ca); + configure(lc); } }

1 0

svn commit: r382 - logback/classic/trunk/src/main/java/ch/qos/logback/classic/spi
by noreply.ceki＠qos.ch 28 Jul '06

28 Jul '06

Author: ceki Date: Fri Jul 28 18:59:14 2006 New Revision: 382 Modified: logback/classic/trunk/src/main/java/ch/qos/logback/classic/spi/CallerData.java Log: the client is assumed to be the first STE beyong the caller class. Modified: logback/classic/trunk/src/main/java/ch/qos/logback/classic/spi/CallerData.java ============================================================================== --- logback/classic/trunk/src/main/java/ch/qos/logback/classic/spi/CallerData.java (original) +++ logback/classic/trunk/src/main/java/ch/qos/logback/classic/spi/CallerData.java Fri Jul 28 18:59:14 2006 @@ -88,8 +88,12 @@ if(steArray[i].getClassName().equals(fqnOfInvokingClass)) { // the caller is assumed to be the next stack frame, hence the +1. found = i + 1; - break; + } else { + if(found != -1) { + break; + } } + } callerDataArray = new CallerData[steArray.length - found];

1 0

svn commit: r381 - logback/classic/trunk/src/main/java/ch/qos/logback
by noreply.seb＠qos.ch 28 Jul '06

28 Jul '06

Author: seb Date: Fri Jul 28 17:17:33 2006 New Revision: 381 Modified: logback/classic/trunk/src/main/java/ch/qos/logback/BasicConfigurator.java Log: basic configurator's PatternLayout config was too.. basic Modified: logback/classic/trunk/src/main/java/ch/qos/logback/BasicConfigurator.java ============================================================================== --- logback/classic/trunk/src/main/java/ch/qos/logback/BasicConfigurator.java (original) +++ logback/classic/trunk/src/main/java/ch/qos/logback/BasicConfigurator.java Fri Jul 28 17:17:33 2006 @@ -14,7 +14,7 @@ ca.setContext(lc); ca.setName("console"); PatternLayout pl = new PatternLayout(); - pl.setPattern("%m%n"); + pl.setPattern("%-4r [%t] %-5p %c %x - %m%n"); pl.start(); ca.setLayout(pl);

1 0

svn commit: r380 - in logback/classic/trunk/src: main/java/ch/qos/logback/classic/examples site/xdocTemplates
by noreply.seb＠qos.ch 28 Jul '06

28 Jul '06

Author: seb Date: Fri Jul 28 15:07:16 2006 New Revision: 380 Added: logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/ logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps1.java logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps2.java logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps3.java Modified: logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml Log: added the first baby steps to the intro, with associated classes Added: logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps1.java ============================================================================== --- (empty file) +++ logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps1.java Fri Jul 28 15:07:16 2006 @@ -0,0 +1,15 @@ +package ch.qos.logback.classic.examples; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class BabySteps1 { + + final static Logger logger = LoggerFactory.getLogger(BabySteps1.class); + + public static void main(String[] args) { + + logger.debug("Hello world."); + + } +} Added: logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps2.java ============================================================================== --- (empty file) +++ logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps2.java Fri Jul 28 15:07:16 2006 @@ -0,0 +1,18 @@ +package ch.qos.logback.classic.examples; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import ch.qos.logback.classic.util.LoggerStatusPrinter; + +public class BabySteps2 { + + final static Logger logger = LoggerFactory.getLogger(BabySteps1.class); + + public static void main(String[] args) { + + logger.debug("Hello world."); + LoggerStatusPrinter.printStatusInDefaultContext(); + + } +} Added: logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps3.java ============================================================================== --- (empty file) +++ logback/classic/trunk/src/main/java/ch/qos/logback/classic/examples/BabySteps3.java Fri Jul 28 15:07:16 2006 @@ -0,0 +1,20 @@ +package ch.qos.logback.classic.examples; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import ch.qos.logback.BasicConfigurator; +import ch.qos.logback.classic.util.LoggerStatusPrinter; + +public class BabySteps3 { + + final static Logger logger = LoggerFactory.getLogger(BabySteps1.class); + + public static void main(String[] args) { + + BasicConfigurator.configureDefaultContext(); + logger.debug("Hello world."); + LoggerStatusPrinter.printStatusInDefaultContext(); + + } +} Modified: logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml ============================================================================== --- logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml (original) +++ logback/classic/trunk/src/site/xdocTemplates/shortIntro.xml Fri Jul 28 15:07:16 2006 @@ -1,4 +1,13 @@ <document> +  + + <body> <div class="section"> <h2>Short introduction</h2> @@ -7,27 +16,34 @@ Authors: Ceki Gülcü, Sébastien Pennec </div> - - <table> - <tr> - <td valign="top" align="top"> - <a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/2.5/"> - <img alt="Creative Commons License" border="0" valign="top" align="top" - src="http://creativecommons.org/images/public/somerights20.png"/> - </a> - </td> - <td> - <p>Copyright © 2000-2006, QOS.ch </p> - - <p>This work is licensed under a <a rel="license" - href="http://creativecommons.org/licenses/by-nc-nd/2.5/">Creative - Commons Attribution-Noncommercial-No Derivative Works 2.5 - License</a>. - </p> - </td> - </tr> - </table> - + + <table> + <tr> + <td valign="top" align="top"> + <a rel="license" + href="http://creativecommons.org/licenses/by-nc-nd/2.5/"> + <img alt="Creative Commons License" border="0" + valign="top" align="top" + src="http://creativecommons.org/images/public/somerights20.png" /> + </a> + </td> + <td> + <p>Copyright © 2000-2006, QOS.ch</p> + + <p> + This work is licensed under a + <a rel="license" + href="http://creativecommons.org/licenses/by-nc-nd/2.5/"> + Creative Commons + Attribution-Noncommercial-No Derivative + Works 2.5 License + </a> + . + </p> + </td> + </tr> + </table> + <div class="section"> <h2>Introduction</h2> </div> @@ -47,25 +63,6 @@ back as far as 1999. </p> <p> - Logback's basic architecture is sufficiently generic so as - to apply under different circumstances. At present time, - logback is divided into three modules, Core, Classic and - Access. - </p> - <p> - The Core module lays the groundwork for the other two - modules. The Classic module can be assimilated to an - improved version of log4j. Logback Classic natively - implements the - <a href="http://www.slf4j.org">SLF4J API</a> - so that you can readily switch back and forth between - logback and other logging systems such as log4j or JDK14 - Logging. The Access module integrates with Servlet - containers to provide HTPP-access log functionality. Note - that you can easily build your own modules on top of the - Core module. - </p> - <p> Before rushing to install and configure logback classic on your own application, here is a presentation of how things work. @@ -98,6 +95,150 @@ </div> <div class="section"> + <h2>First Baby Steps</h2> + </div> + <p> + After you have added the logback classic jar to your classpath, + you can test a small program that uses its functionalities. + </p> + +<div class="source"> +package ch.qos.logback.classic.examples; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class BabySteps1 { + + final static Logger logger = LoggerFactory.getLogger(BabySteps1.class); + + public static void main(String[] args) { + + logger.debug("Hello world."); + + } +} +</div> + <p> + This is the basic, yet usual way of using logback classic. + It starts by importing the Logger and LoggerFactory from SLF4J. + You will note that, for the sake of compatibility with SLF4J and + implementation-freedom, no actual reference to any of the logback + classic classes is required. + You only import and use SLF4J classes for usual logging. + </p> + <p> + Then a static variable gets a Logger that is initialised with the + <code>BabySteps.class</code>. + The main method then invokes the debug method of the received Logger. + It gives the method a simple String with the message to log. + Put differently, the main method contains a logging statement of + level debug containing the message “Hello world”. + </p> + <p> + You can compile and run this class as follows: + </p> + <div class="source">java ch.qos.logback.classic.examples.BabySteps1</div> + <p> + This will not produce any logging output. What happened? + Well, a powerful tool in logback is the Status and associated classes. + It keeps track of any events of importance that happen during the use + of logback. A simple statement can help us see why nothing was logged: + </p> +<div class="source"> +package ch.qos.logback.classic.examples; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import ch.qos.logback.classic.util.LoggerStatusPrinter; + +public class BabySteps2 { + + final static Logger logger = LoggerFactory.getLogger(BabySteps1.class); + + public static void main(String[] args) { + + logger.debug("Hello world."); + LoggerStatusPrinter.printStatusInDefaultContext(); + + } +} +</div> + <p> + The LoggerStatusPrinter will print whatever Statuses were sent to the + StatusManager. Running again the class with the new statement will + output to the console the next lines: + </p> +<div class="source"> +ERROR in Logger[ch.qos.logback.classic.examples.BabySteps2] - No appenders present \\ +in the hierarchy [default] for logger [ch.qos.logback.classic.examples.BabySteps2]. +</div> + <p> + We now know why nothing was logged: no Appenders are configured. + An Appender is a class that can be seen as an output destination. + Appenders exist for many different destinations including the console, + files, and many more. Users can also easily create their own Appenders + for any specific situation. + </p> + <p> + Configuring logback classic can be done a different ways. + The simplest but less flexible way is by calling the <code>BasicConfigurator</code> + class, like in the following code snippet. + </p> +<div class="source"> +package ch.qos.logback.classic.examples; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import ch.qos.logback.BasicConfigurator; +import ch.qos.logback.classic.util.LoggerStatusPrinter; + +public class BabySteps3 { + + final static Logger logger = LoggerFactory.getLogger(BabySteps1.class); + + public static void main(String[] args) { + + BasicConfigurator.configureDefaultContext(); + logger.debug("Hello world."); + LoggerStatusPrinter.printStatusInDefaultContext(); + + } +} +</div> + <p> + Let’s run the BabySteps class again. Now, the BasicConfigurator will create + a simple console Appender. The logging request will then be propagated to + the Appender and the console will output the following: + </p> +<div class="source"> +Hello world. +This status manager contains no errors. +</div> + <p> + This example is very simple. However, actual logging in a bigger + application is not much more complicated. The logging statement will barely + change. Only the configuration process will be different, since you don't + need (nor should) configure the logging context in each and every class that + will require logging. As well, the LoggerStatusPrinter will certainly not be + used after all the logging statements. + </p> + <p> + These are the three steps that are required to allow full logging in any application. + </p> + <ol> + <li>Configure the logback classic environment. You can do it using several + sophisticated ways. The BasicConfigurator is the simplest but also least flexible.</li> + <li>In every class where you wish to perform logging, retrieve a Logger + instance by invoking the LoggerFactory and passing the current class as the parameter.</li> + <li>Use this logger instance by invoking its printing methods, namely + the debug(), info() and error() methods. This will produce logging on the + configured devices.</li> + </ol> + + <div class="section"> <h2>Logger, Appenders and Layouts</h2> </div> <p> @@ -141,48 +282,51 @@ </div> <p> - For example, the logger named <code>"com.foo"</code> is a parent - of the logger named <code>"com.foo.Bar"</code> . Similarly, - <code>"java"</code> is a parent of <code>"java.util"</code> and - an ancestor of <code>"java.util.Vector"</code> . This naming - scheme should be familiar to most developers. + For example, the logger named + <code>"com.foo"</code> + is a parent of the logger named + <code>"com.foo.Bar"</code> + . Similarly, + <code>"java"</code> + is a parent of + <code>"java.util"</code> + and an ancestor of + <code>"java.util.Vector"</code> + . This naming scheme should be familiar to most developers. </p> <p> The root logger resides at the top of the logger hierarchy. - It is exceptional in two ways: + It is exceptional in a way that is always exists. Like every + logger, it can be retrieved by its name, like this: </p> - <ol> - <li>it always exists,</li> - <li>it cannot be retrieved by name.</li> - </ol> + <div class="source">Logger rootLogger = LoggerFactory.getLogger("root");</div> + + <p> + All other loggers are retrieved with the class static + LoggerFactory.getLogger method. This method takes the name + of the desired logger as a parameter. Some of the basic + methods in the Logger interface are listed below. + </p> + + <div class="source">package org.slf4j; public interface Logger { + +// Creation and retrieval method: +public static LoggergetLogger(String name); - <p>All other loggers are retrieved with the class static - LoggerFactory.getLogger method. This method takes the name of - the desired logger as a parameter. Some of the basic methods in - the Logger interface are listed below. - </p> - - <div class="source">package org.slf4j; - -public interface Logger { - - // Creation and retrieval method: - public static Logger getLogger(String name); - - // printing methods: - public void debug(Object message); - public void info(Object message); - public void warn(Object message); - public void error(Object message); - public void fatal(Object message); +// Printing methods: +public void debug(Object message); +public void info(Object message); +public void warn(Object message); +public void error(Object message); +public void fatal(Object message); }</div> - - <p> - Loggers may be assigned levels. The set of possible levels, that - is DEBUG, INFO, WARN and ERROR are defined in the - org.apache.log4j.Level class. The level class cannot be - sub-classed as a much better approach exist in the form of - Marker objects. + + <p> + Loggers may be assigned levels. The set of possible levels, + that is DEBUG, INFO, WARN and ERROR are defined in the + ch.qos.logback.classic.Level class. The level class cannot + be sub-classed as a much better approach exist in the form + of Marker objects. </p> <p> @@ -194,10 +338,13 @@ <div class="definition"> <div class="deftitle">Level Inheritance</div> <p> - The inherited level for a given logger <em>L</em>, is equal to - the first non-null level in the logger hierarchy, starting at - <em>L</em> and proceeding upwards in the hierarchy towards the - root logger. + The inherited level for a given logger + <em>L</em> + , is equal to the first non-null level in the logger + hierarchy, starting at + <em>L</em> + and proceeding upwards in the hierarchy towards the root + logger. </p> </div> <p> @@ -412,13 +559,22 @@ </table> <p> - In example 4, the loggers <code>root</code> and <code>X</code> - and are assigned the levels <code>Proot</code> and + In example 4, the loggers + <code>root</code> + and + <code>X</code> + and are assigned the levels + <code>Proot</code> + and <code>Px</code> - respectively. The loggers <code>X.Y</code> and - <code>X.Y.Z</code> inherits their level value from their nearest - parent <code>X</code> having an assigned level. + respectively. The loggers + <code>X.Y</code> + and + <code>X.Y.Z</code> + inherits their level value from their nearest parent + <code>X</code> + having an assigned level. </p> <p> @@ -429,16 +585,20 @@ <p> By definition, the printing method determines the level of a - logging request. For example, if <code>c</code> is a logger - instance, then the statement <code>c.info("..")</code> is a - logging request of level INFO. + logging request. For example, if + <code>L</code> + is a logger instance, then the statement + <code>L.info("..")</code> + is a logging request of level INFO. </p> <p> - A logging request is said to be <em>enabled</em> if its level is - higher than or equal to the level of its logger. Otherwise, the - request is said to be <em>disabled</em>. A logger without an - assigned level will inherit one from the hierarchy. This rule is - summarized below. + A logging request is said to be + <em>enabled</em> + if its level is higher than or equal to the level of its + logger. Otherwise, the request is said to be + <em>disabled</em> + . A logger without an assigned level will inherit one from + the hierarchy. This rule is summarized below. </p> <div class="definition"> <div class="deftitle">Basic Selection Rule</div> @@ -464,26 +624,25 @@ </p> <p>Here is an example of this rule.</p> - <div class="source">// get a logger instance named "com.foo", with an <span class="blue">INFO</span> level. - Logger logger = LoggerFactory.getLogger("com.foo"); - - Logger barlogger = LoggerFactory.getLogger("com.foo.Bar"); - - // This request is enabled, because <span class="green">WARN</span> >= <span class="blue">INFO</span> - logger.<span class="green">warn</span>("Low fuel level."); - - - // This request is disabled, because <span class="green">DEBUG</span> < <span class="blue">INFO</span>. - logger.<span class="green">debug</span>("Starting search for nearest gas station."); - // The logger instance barlogger, named "com.foo.Bar", - // will inherit its level from the logger named - // "com.foo" Thus, the following request is enabled - // because <span class="green">INFO</span> >= <span class="blue">INFO</span>. - barlogger.<span class="green">info</span>("Located nearest gas station."); - - // This request is disabled, because <span class="green">DEBUG</span> < <span class="blue">INFO</span>. - barlogger.<span class="green">debug</span>("Exiting gas station search"); - </div> + <div class="source">// get a logger instance named "com.foo", with an <span class="blue">INFO</span>level. +Logger logger = LoggerFactory.getLogger("com.foo"); +Logger barlogger = LoggerFactory.getLogger("com.foo.Bar"); + +// This request is enabled, because <span class="green">WARN</span> >= <span class="blue">INFO</span> +logger.<span class="green">warn</span>("Low fuel level."); + +// This request is disabled, because <span class="green">DEBUG</span> < <span class="blue">INFO</span>. +logger.<span class="green">debug</span>("Starting search for nearest gas station."); + +// The logger instance barlogger, named "com.foo.Bar", +// will inherit its level from the logger named +// "com.foo" Thus, the following request is enabled +// because <span class="green">INFO</span> >= <span class="blue">INFO</span>. +barlogger.<span class="green">info</span>("Located nearest gas station."); + +// This request is disabled, because<span class="green">DEBUG</span> < <span class="blue">INFO</span>. +barlogger.<span class="green">debug</span>("Exiting gas station search"); +</div> <p> Calling the @@ -493,21 +652,27 @@ </p> <p>For example, in</p> - <div class="source">Logger x = LoggerFactory.getLogger("wombat"); + <div class="source">Logger x = LoggerFactory.getLogger("wombat"); Logger y = LoggerFactory.getLogger("wombat");</div> - <p><code>x</code> and <code>y</code> refer to <em>exactly</em> the - same logger object. - </p> + <p> + <code>x</code> + and + <code>y</code> + refer to + <em>exactly</em> + the same logger object. + </p> <p> - Thus, it is possible to configure a logger and then to retrieve - the same instance somewhere else in the code without passing - around references. In fundamental contradiction to biological - parenthood, where parents always preceed their children, logback - classic loggers can be created and configured in any order. In - particular, a "parent" logger will find and link to its - descendants even if it is instantiated after them. + Thus, it is possible to configure a logger and then to + retrieve the same instance somewhere else in the code + without passing around references. In fundamental + contradiction to biological parenthood, where parents always + preceed their children, logback classic loggers can be + created and configured in any order. In particular, a + "parent" logger will find and link to its descendants even + if it is instantiated after them. </p> <p> Configuration of the logback environment is typically done @@ -516,16 +681,18 @@ discussed shortly. </p> <p> - Logback makes it easy to name loggers by <em>software - component</em>. This can be accomplished by statically - instantiating a logger in each class, with the logger name equal - to the fully qualified name of the class. This is a useful and - straightforward method of defining loggers. As the log output - bears the name of the generating logger, this naming strategy - makes it easy to identify the origin of a log message. However, - this is only one possible, albeit common, strategy for naming - loggers. Logback does not restrict the possible set of - loggers. The developer is free to name the loggers as desired. + Logback makes it easy to name loggers by + <em>software component</em> + . This can be accomplished by statically instantiating a + logger in each class, with the logger name equal to the + fully qualified name of the class. This is a useful and + straightforward method of defining loggers. As the log + output bears the name of the generating logger, this naming + strategy makes it easy to identify the origin of a log + message. However, this is only one possible, albeit common, + strategy for naming loggers. Logback does not restrict the + possible set of loggers. The developer is free to name the + loggers as desired. </p> <p> Nevertheless, naming loggers after the class where they are @@ -536,29 +703,36 @@ <h3>Appenders and Layouts</h3> </div> - <p> The ability to selectively enable or disable logging requests - based on their logger is only part of the picture. Logback allows - logging requests to print to multiple destinations. In logback - speak, an output destination is called an appender. Currently, - appenders exist for the console, files, remote socket servers, - JMS, and remote UNIX Syslog daemons. It is also possible to log - asynchronously. + <p> + The ability to selectively enable or disable logging + requests based on their logger is only part of the picture. + Logback allows logging requests to print to multiple + destinations. In logback speak, an output destination is + called an appender. Currently, appenders exist for the + console, files, remote socket servers, JMS, and remote UNIX + Syslog daemons. It is also possible to log asynchronously. </p> <p>More than one appender can be attached to a logger.</p> <p> - The addAppender method adds an appender to a given logger. Each - enabled logging request for a given logger will be forwarded to - all the appenders in that logger as well as the appenders higher - in the hierarchy. In other words, appenders are inherited - additively from the logger hierarchy. For example, if a console - appender is added to the root logger, then all enabled logging - requests will at least print on the console. If in addition a - file appender is added to a logger, say <em>L</em>, then enabled - logging requests for <em>L</em> and <em>L</em>'s children will - print on a file and on the console. It is possible to override - this default behavior so that appender accumulation is no longer - additive by setting the additivity flag to false. + The addAppender method adds an appender to a given logger. + Each enabled logging request for a given logger will be + forwarded to all the appenders in that logger as well as the + appenders higher in the hierarchy. In other words, appenders + are inherited additively from the logger hierarchy. For + example, if a console appender is added to the root logger, + then all enabled logging requests will at least print on the + console. If in addition a file appender is added to a + logger, say + <em>L</em> + , then enabled logging requests for + <em>L</em> + and + <em>L</em> + 's children will print on a file and on the console. It is + possible to override this default behavior so that appender + accumulation is no longer additive by setting the additivity + flag to false. </p> <p> @@ -568,22 +742,35 @@ <div class="definition"> <div class="deftitle">Appender Additivity</div> - - <p> - The output of a log statement of logger <em>L</em> will go to - all the appenders in <em>L</em> and its ancestors. This is the - meaning of the term "appender additivity". + + <p> + The output of a log statement of logger + <em>L</em> + will go to all the appenders in + <em>L</em> + and its ancestors. This is the meaning of the term + "appender additivity". </p> - <p> However, if an ancestor of logger <em>L</em> , say - <em>P</em>, has the additivity flag set to false, then - <em>L</em>'s output will be directed to all the appenders in - <em>L</em> and it's ancestors upto and including <em>P</em> but - not the appenders in any of the ancestors of <em>P</em> . + <p> + However, if an ancestor of logger + <em>L</em> + , say + <em>P</em> + , has the additivity flag set to false, then + <em>L</em> + 's output will be directed to all the appenders in + <em>L</em> + and it's ancestors upto and including + <em>P</em> + but not the appenders in any of the ancestors of + <em>P</em> + . </p> <p> - Loggers have their additivity flag set to true by default. + Loggers have their additivity flag set to true by + default. </p> </div> @@ -657,15 +844,19 @@ <p> - More often than not, users wish to customize not only the output - destination but also the output format. This is accomplished by - associating a <em>layout</em> with an appender. The layout is - responsible for formatting the logging request according to the - user's wishes, whereas an appender takes care of sending the - formatted output to its destination. The PatternLayout, part of - the standard logback distribution, lets the user specify the - output format according to conversion patterns similar to the C - language <code>printf</code> function. + More often than not, users wish to customize not only the + output destination but also the output format. This is + accomplished by associating a + <em>layout</em> + with an appender. The layout is responsible for formatting + the logging request according to the user's wishes, whereas + an appender takes care of sending the formatted output to + its destination. The PatternLayout, part of the standard + logback distribution, lets the user specify the output + format according to conversion patterns similar to the C + language + <code>printf</code> + function. </p> <p> @@ -673,9 +864,7 @@ "%r [%t] %-5p %c - %m%n" will output something akin to: </p> - <div class="source"> - 176 [main] INFO org.foo.Bar - Located nearest gas station. - </div> + <div class="source">176 [main] INFO org.foo.Bar - Located nearest gas station.</div> <p> The first field is the number of milliseconds elapsed since @@ -690,45 +879,53 @@ <p> If you are a SLF4J user (if not, you should be...), you'll - notice that the methods used to request logging do not only take - a String as a parameter. Some methods allow more sophisticated - parameter configurations. + notice that the methods used to request logging do not only + take a String as a parameter. Some methods allow more + sophisticated parameter configurations. </p> - <p> For some Logger <code>logger</code>, writing, </p> + <p> + For some Logger + <code>logger</code> + , writing, + </p> - <div class="source"> - logger.debug("Entry number: " + i + " is " + - String.valueOf(entry[i])); - </div> + <div class="source">logger.debug("Entry number: " + i + " is " + String.valueOf(entry[i]));</div> - <p> incurs the cost of constructing the message parameter, that is - converting both integer <code>i</code> and <code>entry[i]</code> - to a String, and concatenating intermediate strings. This, - regardless of whether the message will be logged or not. + <p> + incurs the cost of constructing the message parameter, that + is converting both integer + <code>i</code> + and + <code>entry[i]</code> + to a String, and concatenating intermediate strings. This, + regardless of whether the message will be logged or not. </p> <p> - One possible way to avoid the cost of parameter construction is - by surrounding the log statement with a test. Here is an + One possible way to avoid the cost of parameter construction + is by surrounding the log statement with a test. Here is an example. </p> - <div class="source"> -if(logger.isDebugEnabled()) { - logger.debug("Entry number: " + i + " is " + - String.valueOf(entry[i])); -} </div> + <div class="source">if(logger.isDebugEnabled()) { + logger.debug("Entry number: " + i + " is " + String.valueOf(entry[i])); +}</div> - <p> This way you will not incur the cost of parameter construction - if debugging is disabled for <code>logger</code> . On the other - hand, if the logger is enabled for the DEBUG level, you will incur - the cost of evaluating whether the logger is enabled or not, - twice: once in <code>debugEnabled</code> and once in - <code>debug</code> . This is an insignificant overhead because - evaluating a logger takes less than 1% of the time it takes to - actually log a statement. + <p> + This way you will not incur the cost of parameter + construction if debugging is disabled for + <code>logger</code> + . On the other hand, if the logger is enabled for the DEBUG + level, you will incur the cost of evaluating whether the + logger is enabled or not, twice: once in + <code>debugEnabled</code> + and once in + <code>debug</code> + . This is an insignificant overhead because evaluating a + logger takes less than 1% of the time it takes to actually + log a statement. </p> <h4>Better alternative based on format messages</h4> @@ -741,11 +938,7 @@ </p> - <div class="source"> - Object entry = new SomeObject(); - <br /> - logger.debug("The entry is {}.", entry); - </div> + <div class="source">Object entry = new SomeObject(); logger.debug("The entry is {}.", entry);</div> <p> After evaluting whether to log or not, and only if the @@ -767,11 +960,8 @@ logging statement. </p> - <div class="source"> - logger.debug("The new entry is "+entry+"."); - <br /> - logger.debug("The new entry is {}.", entry); - </div> + <div class="source">logger.debug("The new entry is "+entry+"."); +logger.debug("The new entry is {}.", entry);</div> <p> @@ -779,10 +969,7 @@ can write: </p> - <div class="source"> - logger.debug("The new entry is {}. It replaces {}.", entry, - oldEntry); - </div> + <div class="source">logger.debug("The new entry is {}. It replaces {}.", entry, oldEntry);</div> <p> If three or more arguments need to be passed, an @@ -791,10 +978,7 @@ </p> - <div class="source"> - logger.debug("Value {} was inserted between {} and {}.", new - Object[] {newVal, below, above}); - </div> + <div class="source">logger.debug("Value {} was inserted between {} and {}.", new Object[] {newVal, below, above});</div>

1 0

svn commit: r379 - logback/skin/trunk/src/main/resources/css
by noreply.seb＠qos.ch 28 Jul '06

28 Jul '06

Author: seb Date: Fri Jul 28 15:06:28 2006 New Revision: 379 Modified: logback/skin/trunk/src/main/resources/css/site.css Log: source class has a bit more width Modified: logback/skin/trunk/src/main/resources/css/site.css ============================================================================== --- logback/skin/trunk/src/main/resources/css/site.css (original) +++ logback/skin/trunk/src/main/resources/css/site.css Fri Jul 28 15:06:28 2006 @@ -249,7 +249,7 @@ padding-top: 0.5ex; padding-left: 1ex; white-space: pre; - width: 55em; + width: 60em; }

1 0

Release of logback 0.1
by Sebastien Pennec 28 Jul '06

28 Jul '06

July 28th, 2006 - Release of logback 0.1 Release 0.1 is an alpha release. Logback's modules Core, Classic and Access are now available. You can download the modules, including full source code, class files and documentation on our download page, shown below. http://logback.qos.ch/download.html You can receive logback related announcements by subscribing to the logback announce mailing list. To subscribe to logback-announce list, please visit the following URL. http://logback.qos.ch/mailinglist.html -- Sébastien Pennec sebastien(a)qos.ch Logback: the generic, reliable, fast and flexible logging library for Java.

1 0