- logback-dev - mailman3.qos.ch

[JIRA] Created: (LBCORE-68) Add a pattern resolver to <file> property of FileAppnder
by Nicolas Giraud (JIRA) 03 Feb '09

03 Feb '09

Add a pattern resolver to <file> property of FileAppnder -------------------------------------------------------- Key: LBCORE-68 URL: http://jira.qos.ch/browse/LBCORE-68 Project: logback-core Issue Type: New Feature Components: Appender, Joran Affects Versions: 0.9.11 Environment: Ubuntu 8.04, J2SE 6 Reporter: Nicolas Giraud Assignee: Logback dev list Following discussion on the mailing list, it would be very convenient to be able to use patterns in the filename of a FileAppender. My initial expectation was to be able to do something like: <appender name="myFileAppender" class="ch.qos.logback.core.FileAppender"> <file>${logFolder}/SomePrefix.%d.someExt</file> [...] </appender> where %d would be substituted by the current date. However Ralph Goers, when replying to my question on the mailing list, suggested a more flexibl approach: <appender name="myFileAppender" class="ch.qos.logback.core.FileAppender"> <File resolver="com.mycorp.logback.MyPatternResolver">someName.%{host}.%{datetime}.log</File> [...] </appender> with MyPatternResolver implementing an interface like: package ch.qos.logback.core.pattern; public interface Resolver { String resolve(String pattern); } Providing a default implementation allowing to generate timestamp, use system properties, would be nice too. Currently this can be done programmatically, but it would be most convenient to have the possibility to do this using the Joran configurator. Best regards, Nicolas -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.qos.ch/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

2 1

[JIRA] Created: (LBCORE-85) Allow configuration of timezone with file name pattern
by Neil Lott (JIRA) 03 Feb '09

03 Feb '09

Allow configuration of timezone with file name pattern ------------------------------------------------------ Key: LBCORE-85 URL: http://jira.qos.ch/browse/LBCORE-85 Project: logback-core Issue Type: Bug Components: Appender Affects Versions: 0.9.14 Environment: Any Reporter: Neil Lott Assignee: Logback dev list <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> <FileNamePattern>/usr/local/neil/logs/msa-mdn-%i-%d{yyyyMMdd-HHmmss}.log</FileNamePattern> <MinIndex>1</MinIndex> <MaxIndex>5</MaxIndex> </rollingPolicy> In this case the filename pattern %d it would be nice to allow configuration of timezone somehow in the pattern. -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.qos.ch/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

1 0

Instant Messenger appender for logback?
by Thorbjørn Ravn Andersen 02 Feb '09

02 Feb '09

Hi. Just to hear if anybody has yet written an Instant Messenger logback appender? I think that the most robust backend would be Jabber so that would be preferred. If not, I'll probably have a go at writing one with the Smack library :) -- Thorbjørn Ravn Andersen "...plus... Tubular Bells!"

2 1

svn commit: r2138 - logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util
by noreply.ceki＠qos.ch 02 Feb '09

02 Feb '09

Author: ceki Date: Mon Feb 2 23:40:27 2009 New Revision: 2138 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util/StatusPrinter.java Log: - printInCaseOfErrorsOrWarnings should print ERRORS not just WARNings Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util/StatusPrinter.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util/StatusPrinter.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util/StatusPrinter.java Mon Feb 2 23:40:27 2009 @@ -50,7 +50,7 @@ ps.println("WARN: Context named \"" + context.getName() + "\" has no status manager"); } else { - if (sm.getLevel() == ErrorStatus.WARN) { + if (sm.getLevel() == ErrorStatus.WARN || (sm.getLevel() == ErrorStatus.ERROR) ) { print(sm); } } @@ -112,9 +112,9 @@ private static void buildStrFromStatusList(StringBuilder sb, List<Status> statusList) { - Iterator it = statusList.iterator(); - while (it.hasNext()) { - Status s = (Status) it.next(); + if(statusList == null) + return; + for(Status s : statusList) { buildStr(sb, "", s); } }

1 0

svn commit: r2137 - in logback/trunk: logback-core/src/main/java/ch/qos/logback/core/joran/action logback-examples/src/main/java/chapter10/calculator logback-examples/src/main/java/chapter10/helloWorld logback-examples/src/main/java/chapter10/implicit logback-site/src/site/pages/manual
by noreply.ceki＠qos.ch 02 Feb '09

02 Feb '09

Author: ceki Date: Mon Feb 2 23:16:18 2009 New Revision: 2137 Added: logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/readme.txt Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedComplexPropertyIA.java logback/trunk/logback-examples/src/main/java/chapter10/calculator/ComputationAction2.java logback/trunk/logback-examples/src/main/java/chapter10/calculator/calculator3.xml logback/trunk/logback-examples/src/main/java/chapter10/calculator/readme.txt logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMe.java logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMeImplicitAction.java logback/trunk/logback-examples/src/main/java/chapter10/implicit/implicit1.xml logback/trunk/logback-examples/src/main/java/chapter10/implicit/readme.txt logback/trunk/logback-site/src/site/pages/manual/menu.js logback/trunk/logback-site/src/site/pages/manual/onJoran.html Log: Ongoing work on LBSITE-25 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedComplexPropertyIA.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedComplexPropertyIA.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedComplexPropertyIA.java Mon Feb 2 23:16:18 2009 @@ -67,7 +67,6 @@ // we only push action data if NestComponentIA is applicable case AS_COMPLEX_PROPERTY_COLLECTION: case AS_COMPLEX_PROPERTY: - // addInfo("was deemed applicable for " + pattern); IADataForComplexProperty ad = new IADataForComplexProperty(parentBean, aggregationType, nestedElementTagName); actionDataStack.push(ad); Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/ComputationAction2.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/calculator/ComputationAction2.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/ComputationAction2.java Mon Feb 2 23:16:18 2009 @@ -21,7 +21,7 @@ /** * ComputationAction2 will print the result of the compuration made by - * children elements but only if the compuration itself is named, that is if the + * children elements but only if the computation itself is named, that is if the * name attribute of the associated computation element is not null. In other * words, anonymous computations will not print their result. * @@ -41,7 +41,7 @@ * saved by one begin() will be consumed only by the matching end() method. * * Note that in the vast majority of cases there is no need to resort to a - * separate stack for each variable. The situation of successibe begin() + * separate stack for each variable. The situation of successive begin() * invocations can only occur if: * * 1) the associated pattern contains a wildcard, i.e. the * character Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/calculator3.xml ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/calculator/calculator3.xml (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/calculator3.xml Mon Feb 2 23:16:18 2009 @@ -1,10 +1,8 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<!DOCTYPE computation> - +  + --> <computation name="toto"> <computation> Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/readme.txt ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/calculator/readme.txt (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/readme.txt Mon Feb 2 23:16:18 2009 @@ -1,17 +1,7 @@ -+------------------------------+ -| | -| Joran Examples | -| | -| Calculator | -| | -+------------------------------+ +This directory contains the the calculator example. It shows how Actions can +collaborate in order to accomplish a simple computation. -This directory contains the the calculator example. +For further information, please refer to -It shows how Actions can collaborate in order to accomplish a simple -computation. - -For more in-depth informations about this example, please visit: - -http://logback.qos.ch/manual/joran.html#calculator + http://logback.qos.ch/manual/onJoran.html#calculator Added: logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/readme.txt ============================================================================== --- (empty file) +++ logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/readme.txt Mon Feb 2 23:16:18 2009 @@ -0,0 +1,6 @@ +The example illustrates the minimal plumbing required for using Joran. + +For further explanations, please refer to + + http://logback.qos.ch/manual/onJoran.html#helloWorld + Modified: logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMe.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMe.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMe.java Mon Feb 2 23:16:18 2009 @@ -1,7 +1,7 @@ /** * Logback: the generic, reliable, fast and flexible logging framework. * - * Copyright (C) 1999-2006, QOS.ch + * Copyright (C) 2000-2009, QOS.ch * * This library is free software, you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the Free @@ -14,54 +14,46 @@ import java.util.List; import java.util.Map; -import chapter10.SimpleConfigurator; import ch.qos.logback.core.Context; import ch.qos.logback.core.ContextBase; import ch.qos.logback.core.joran.action.Action; import ch.qos.logback.core.joran.action.ImplicitAction; -import ch.qos.logback.core.joran.spi.JoranException; import ch.qos.logback.core.joran.spi.Pattern; import ch.qos.logback.core.util.StatusPrinter; - +import chapter10.SimpleConfigurator; /** - * This example illustrates the usage of implcit actions. + * This example illustrates the usage of implicit actions. * - * The crucial point to remember about implicit actions is that they - * are not associated with a pattern. Moreover, they are added directly to - * a Joran Interpreter instead of a rule store. + * <p>Keep in mind that implicit actions are not associated with any specific + * pattern. Moreover, they are added directly to a Joran Interpreter instead of + * a rule store. * * @author Ceki Güulcü */ public class PrintMe { - - + public static void main(String[] args) throws Exception { Context context = new ContextBase(); - + Map<Pattern, Action> ruleMap = new HashMap<Pattern, Action>(); - // we start with the rule for the top-most (root) element ruleMap.put(new Pattern("*/foo"), new NOPAction()); - + // Add an implicit action. List<ImplicitAction> iaList = new ArrayList<ImplicitAction>(); - // --------------------------+ - // Add an implicit action. | - // --------------------------+ iaList.add(new PrintMeImplicitAction()); - - SimpleConfigurator simpleConfigurator = new SimpleConfigurator(ruleMap, iaList); + SimpleConfigurator simpleConfigurator = new SimpleConfigurator(ruleMap, + iaList); + // link the configurator with its context simpleConfigurator.setContext(context); try { - simpleConfigurator.doConfigure(args[0]); - } catch (JoranException e) { - // Print any errors that might have occured. - StatusPrinter.print(context); + simpleConfigurator.doConfigure(args[0]); + } catch (Exception e) { + StatusPrinter.print(context); } - } } Modified: logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMeImplicitAction.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMeImplicitAction.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMeImplicitAction.java Mon Feb 2 23:16:18 2009 @@ -1,13 +1,12 @@ /** - * Logback: the reliable, fast and flexible logging library for Java. + * Logback: the generic, reliable, fast and flexible logging framework. * - * Copyright (C) 1999-2006, QOS.ch + * Copyright (C) 2000-2009, QOS.ch * * This library is free software, you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the Free * Software Foundation. */ - package chapter10.implicit; import org.xml.sax.Attributes; @@ -16,29 +15,26 @@ import ch.qos.logback.core.joran.spi.InterpretationContext; import ch.qos.logback.core.joran.spi.Pattern; - - /** - * - * A rather trivial implicit action which is applicable as soon as an - * element has a printme attribute set to true. - * + * + * A rather trivial implicit action which is applicable if an element has a + * printme attribute set to true. + * * @author Ceki Gülcü */ public class PrintMeImplicitAction extends ImplicitAction { - - public boolean isApplicable( - Pattern pattern, Attributes attributes, InterpretationContext ec) { + + public boolean isApplicable(Pattern pattern, Attributes attributes, + InterpretationContext ec) { String printmeStr = attributes.getValue("printme"); return Boolean.valueOf(printmeStr).booleanValue(); } public void begin(InterpretationContext ec, String name, Attributes attributes) { - System.out.println("Element ["+name+"] asked to be printed."); - } + System.out.println("Element [" + name + "] asked to be printed."); + } - public void end(InterpretationContext ec, String name) { } } Modified: logback/trunk/logback-examples/src/main/java/chapter10/implicit/implicit1.xml ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/implicit/implicit1.xml (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/implicit/implicit1.xml Mon Feb 2 23:16:18 2009 @@ -1,9 +1,6 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<!DOCTYPE foo> - <foo> -  +  <xyz printme="true"> <abc printme="true"/> </xyz> @@ -17,7 +14,7 @@  <foo printme="true"/> Modified: logback/trunk/logback-examples/src/main/java/chapter10/implicit/readme.txt ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/implicit/readme.txt (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/implicit/readme.txt Mon Feb 2 23:16:18 2009 @@ -1,17 +1,7 @@ -+------------------------------+ -| | -| Joran Examples | -| | -| Implicit | -| | -+------------------------------+ -This directory contains the implicit action example. +This directory contains an example illustrating implicit actions. -It shows how to use implicit actions, which do not require an explicit -pattern. - -For more in-depth informations about this example, please visit: - -http://logback.qos.ch/manual/joran.html#implicit +For further information, please refer to + http://logback.qos.ch/manual/onJoran.html#implicit + \ No newline at end of file Modified: logback/trunk/logback-site/src/site/pages/manual/menu.js ============================================================================== --- logback/trunk/logback-site/src/site/pages/manual/menu.js (original) +++ logback/trunk/logback-site/src/site/pages/manual/menu.js Mon Feb 2 23:16:18 2009 @@ -9,4 +9,4 @@ document.write('<p class="menu"><a href="mdc.html"><b>Ch7: Mapped Diagnostic Contexts</b></a>'); document.write('<p class="menu"><a href="loggingSeparation.html"><b>Ch8: Logging Separation</b></a>'); document.write('<p class="menu"><a href="jmxConfig.html"><b>Ch9: JMX Configurator</b></a>'); -document.write('<p class="menu"><a href="onJoran.html"><b>Ch9: Joran</b></a>'); +document.write('<p class="menu"><a href="onJoran.html"><b>Ch10: Joran</b></a>'); Modified: logback/trunk/logback-site/src/site/pages/manual/onJoran.html ============================================================================== --- logback/trunk/logback-site/src/site/pages/manual/onJoran.html (original) +++ logback/trunk/logback-site/src/site/pages/manual/onJoran.html Mon Feb 2 23:16:18 2009 @@ -305,7 +305,7 @@ <literal value="3"/> </computation></p> - <p>In the <a href="../xref/chapter3/calculator/Calculator1.html"> + <p>In the <a href="../xref/chapter10/calculator/Calculator1.html"> <code>Calculator1</code></a> application, we declare various parsing rules (patterns and actions) collaborating together to compute a result based on the contents of an XML document. @@ -326,16 +326,43 @@ </p> <ul> - <li>The <a - href="../xref/chapter3/calculator/ComputationAction1.html"> - <code>ComputationAction1</code></a> class' <code>begin()</code> - method is called</li> - <li>The <a href="../xref/chapter3/calculator/LiteralAction.html"> - <code>LiteralAction</code></a> class' <code>begin()</code> and <code>end()</code> - methods are called</li> - <li>The <a href="../xref/chapter3/calculator/ComputationAction1.html"> - <code>ComputationAction1</code></a> class' <code>end()</code> method - is called</li> + <li>The start event corresponding to the <computation> + element translates into the current pattern + "/computation". Since in the <a + href="../xref/chapter10/calculator/Calculator1.html"> + <code>Calculator1</code></a> application we associated the + pattern "/computation" with a + <a + href="../xref/chapter10/calculator/ComputationAction1.html"> + <code>ComputationAction1</code></a> instance, the + <code>begin()</code> method of that + <code>ComputationAction1</code> instance is invoked. + </li> + + <li><p>The start event corresponding to the <literal> + element translates into the current pattern + "/computation/literal". Given the association of the + "/computation/literal" pattern with a + <a + href="../xref/chapter10/calculator/LiteralAction.html"> + <code>LiteralAction</code></a> instance, the + <code>begin()</code> method of that <code>LiteralAction</code> + instance is called.</p> + </li> + + <li><p>By the same token, the end event corresponding to the + <literal> element triggers the invocation of the + <code>end</code>() method of the same <code>LiteralAction</code> + instance.</p> + </li> + + + <li><p>Similarly, the event corresponding to the end of + <computation> element triggers the invocation the + <code>end()</code> method of the <code>ComputationAction1</code> + same instance. + </p> + </li> </ul> <p>What is interesting here is the way actions collaborate. The @@ -349,14 +376,12 @@  - <p>The <em>calculator2.xml</em> file is a bit more complex, but - much more interesting.</p> - - <p>It contains the following elements:</p> + <p>The next example, <em>calculator2.xml</em> file is a bit more + complex, but also more interesting.</p> <em>Example 3.<span class="autoEx"/>: Calculator configuration file - (logback-examples/src/main/java/chapter3/calculator/calculator2.xml)</em> + (logback-examples/src/main/java/chapter10/calculator/calculator2.xml)</em> <div class="source"><pre><computation name="toto"> <literal value="7"/> <literal value="3"/> @@ -365,25 +390,38 @@ <multiply/> </computation></pre></div> - <p>Here, there are obviously more actions that will be part of the - computation. + + <p>As in the previous example, in response to the <literal> + element,the appropriate <a + href="../xref/chapter10/calculator/LiteralAction.html"> + <code>LiteralAction</code></a> instance will push an integer, + corresponding to the value attribute, at the top of the + interpretation context's object stack. In this example, that is + <em>calculator2.xml</em>, the values are 7 and 3. In response to the + <add> element, the appropriate <a + href="../xref/chapter10/calculator/AddAction.html"><code>AddAction</code></a> + will pop two previously pushed integers, compute their sum and push + the result, i.e. 10 (=7+3), at the top of the interpretation + context's stack. The next literal element will cause LiteralAction + to push an integer with value 3 at the top of the stack. In response + to the <multiply> element, the appropriate <a + href="../xref/chapter10/calculator/MultiplyAction.html"><code>MultiplyAction</code></a> + will pop two previously pushed integers, i.e. 10 and 3, and compute + their product. It will push the result, i.e. 30, at the top of the + stack. At the very end, in reponse to the end event corresponding to + the <;/computation> tag, the ComputationAction1 will print the + object at the top of the stack. Thus, running: </p> - <p>When called, the <a - href="../xref/chapter3/calculator/AddAction.html"> - <code>AddAction</code></a> class will remove the two integers at the - bottom of the stack, add them and push the resulting integer at the - top of the stack, for further use.</p> - - <p>Later in the computation, the <a - href="../xref/chapter3/calculator/MultiplyAction.html"> - <code>MultiplyAction</code></a> class will be called. It will take - the last two integers from the stack, multiply them and push the - result in the stack.</p> - - <p>We have here two examples of action whose <code>begin()</code> - method behaves in a certain, predictable way, but whose - <code>end()</code> methods are empty.</p> + <p class="command">java chapter10.calculator.Calculator1 src/main/java/chapter10/calculator/calculator2.xml </p> + + <p>will yield</p> + + <p class="console">The computation named [toto] resulted in the value 30 </p> + + +  <h3><a name="implicit" href="#implicit">Implicit actions</a></h3> - <p>The rules defined thus far are called explicit rules because they - require an explicit pattern, hence fixing the tag name of the - elements for which they apply. - </p> - - <p>In highly extensible systems, the number and type of components - to handle are innumerable so that it would become very tedious or - even impossible to list all the applicable patterns by name. + <p>The rules defined thus far are called explicit actions because an + pattern/action association could be found in the rule store for the + current element. However, in highly extensible systems, the number + and type of components can be so large so as to make it very tedious + to associate an explicit action for all patterns. </p> <p>At the same time, even in highly extensible systems one can - observe well-defined patterns linking the various parts - together. Implicit rules come in very handy when processing - components composed of sub-components unknown ahead of time. For + observe recurrent rules linking various parts together. Assuming we + could identify such rules, we could process components composed of + sub-components unknown at compilation time (of logback). For example, Apache Ant is capable of handling tasks which contain tags - unknown at compile time by looking at methods whose names start with - <em>add</em>, as in <code>addFile</code>, or - <code>addClassPath</code>. When Ant encounters an embedded tag - within a task, it simply instantiates an object that matches the - signature of the task class' add method and attaches the resulting - object to the parent. + unknown at compile time, simply by inspecting the component for + methods whose names start with <em>add</em>, as in + <code>addFile</code>, or <code>addClassPath</code>. When Ant + encounters an embedded tag within a task, it simply instantiates an + object that matches the signature of the task class' add method and + attaches the resulting object to the parent. </p> - <p>Joran includes similar capability in the form of implicit - actions. Joran keeps a list of implicit actions which can be applied - if no explicit pattern matches the current XML element. However, + <p>Joran supports similar capability in the form of implicit + actions. Joran keeps a list of implicit actions which are applied if + no explicit pattern could match the current pattern. However, applying an implicit action may not be always appropriate. Before - executing the implicit action, Joran asks an implicit action whether - it is appropriate in the current context. Only if the action replies - affirmatively does Joran interpreter invoke the (implicit) - action. This extra step makes it possible to support multiple - implicit actions or obviously none, if no implicit action is - appropriate for a given situation. + executing the implicit action, Joran asks a given implicit action + whether it is appropriate in the current situation. Only if the + action replies in the affirmative does the Joran configurator invoke + the (implicit) action. Note that this extra step makes it possible + to support multiple implicit actions for or possibly none, if no + implicit action is appropriate for a given situation. </p> - <p>For example, the <a - href="../xref/ch/qos/logback/core/joran/action/NestedComponentIA.html"> - <code>NestedComponentIA</code></a> extending <a - href="../xref/ch/qos/logback/core/joran/action/ImplicitAction.html"> - <code>ImplicitAction</code></a> , will instantiate the class - specified in a nested component and attach it to the parent - component by using setter method of the parent component and the - nested element's name. Under certain circumstances, a nested action - needs to be applied to an element say <a> and also to another - element <b> nested within <a>. The current implementation of - <code>NestedComponentIA</code> is capable of handling multiply - nested elements requiring intervention by the same implicit action. + <p>You can create and register a custom implicit action as + illustrated in the next example contained within the + <em>logback-examples/src/main/java/chapter10/implicit</em> folder. </p> - <p>Both <code>ImplicitAction</code> and - <code>NestedComponentIA</code> are located in the - <code>ch.qos.logback.core.joran.action</code> package. + <p>The <a + href="../xref/chapter10/implicit/PrintMe.html"><code>PrintMe</code></a> + application associates an <a + href="../xref/chapter3/implicit/NOPAction.html"> + <code>NOPAction</code></a> instance with the pattern "*/foo", that + is any element named as "foo". As its name indicates, the + <code>begin</code>() and <code>end</code>() methods of + <code>NOPAction</code> are empty. The <code>PrintMe</code> + application also registers an instance of <a + href="../xref/chapter10/implicit/PrintMeImplicitAction.html">PrintMeImplicitAction</a> + in its list of implicit actions. The + <code>PrintMeImplicitAction</code> is applicable for any element + which has a <span class="attr">printme</span> attribute set to + true. See the isApplicable method in + <code>PrintMeImplicitAction</code>. The <code>begin</code>() method + of <code>PrintMeImplicitAction</code> prints the name of the current + element on the console. </p> - <p>Refer to the - <em>logback-examples/src/main/java/joran/implicit</em> directory for - an example of an implicit action. - </p> - - <p>In that directory, you will find two actions classes, one xml - file and one class containing the setup of Joran.</p> - - <p>The <a href="../xref/chapter3/implicit/NOPAction.html"> - <code>NOPAction</code></a> class does nothing. It is used to set the - context of the <em>foo</em> element, using this line:</p> - - <p class="source">ruleStore.addRule(new Pattern("*/foo"), new NOPAction());</p> - - <p>After that, the implicit action, namely <a - href="../xref/chapter3/implicit/PrintMeImplicitAction.html"> - <code>PrintMeImplicitAction</code></a>, is added to the - <code>RuleStore</code>. This is done by simply adding a new instance - of the action to the <code>Joran interpreter</code></p> - - <p class="source">ji.addImplicitAction(new - PrintMeImplicitAction());</p> - - <p>When called, the <code>isApplicable()</code> method of - <code>PrintMeImplicitAction</code> checks the value of the - <em>printme</em> attribute. If the value is <code>true</code>, the - implicit action is applicable: its <code>begin()</code> method will - be called.</p> - - <p>The <em>implicit1.xml</em> file contains the following lines:</p> + <p>The XML document <em>implicit1.xml</em> is designed to illustrate + how implicit actions come into play.</p> <em>Example 3.<span class="autoEx"/>: Usage of implicit rules - (logback-examples/src/main/java/chapter3/implicit/implicit1.xml)</em> -<div class="source"><pre><foo> - + (logback-examples/src/main/java/chapter10/implicit/implicit1.xml)</em> + <p class="source"><foo> <xyz printme="true"> <abc printme="true"/> </xyz> @@ -511,29 +523,70 @@ <foo printme="true"/> -</foo></pre></div> +</foo></p> + + <p>Running</p> - <p>As you can see, the first element will be printed, since it has a - <em>printme</em> attribute, which bears the value - <code>true</code>.</p> + <p class="command">java chapter10.implicit.PrintMe src/main/java/chapter10/implicit/implicit1.xml</p> + <p>yields:</p> - <p>The second element will not be printed, because no <em>printme</em> attibute is present.</p> + <p class="console">Element [xyz] asked to be printed. +Element [abc] asked to be printed.</p> + + <p>Given that <code>NOPAction</code> instance is explicitly + associated with the "*/foo" pattern, the + <code>PrintMeImplicitAction</code> is never triggered for any of the + <foo> elements. For other elements, the + <code>isApplicable</code> method of + <code>PrintMeImplicitAction</code> is invoked. It will return true + only for elements having a <span class="attr">printme</span> + attribute set to true, namely the first <xyz> element (but not + the second) and the <abc> element. This explains the output shown + above (previous paragraph). + </p> + + <h3><a name="iaPractice" href="#iaPractice">Implicit actions in + practice</a></h3> + + <p>The respective Joran configurators of logback-classic and + logback-access include just two implicit actions, namely <a + href="../xref/ch/qos/logback/core/joran/action/NestedBasicPropertyIA.html"> + <code>NestedComplexPropertyIA</code></a> and <a + href="../xref/ch/qos/logback/core/joran/action/NestedComplexPropertyIA.html"> + <code>NestedComplexPropertyIA</code></a>. + </p> - <p>The last element will not be printed, although the required - attribute is present. This is because implicit rules are called - only if no explicit rules are defined. Since we added a - <code>NOPAction</code> with the <em>*/foo</em> pattern, it will be - used instead of the <code>PrintMeImplicitAction</code>.</p> + <p> + <code>NestedBasicPropertyIA</code> is applicable for any property + whose type, is a primitive type, or equivalent object type in the + <code>java.lang</code> package, an enumeration type, or any type + adhering to the "valueOf" convention. A class is said to adhere to + the "valueOf" convention if it contains a static method named + <code>valueOf</code>() taking a <code>java.lang.String</code> as + parameter and returning an instance of the type in question. + </p> + + <p> <code>NestedComplexPropertyIA</code> action is applicable in the + remaining cases where <code>NestedBasicPropertyIA</code> is not + applicable. In other words, <code>NestedComplexPropertyIA</code> is + a last resort, catch-all, implicit action. It will + </p> - <p>Running the example yields the following output:</p> + <p>For example, the <a + href="../xref/ch/qos/logback/core/joran/action/NestedComplexPropertyIA.html"> + <code>NestedComplexPropertyIA</code></a> extending <a + href="../xref/ch/qos/logback/core/joran/action/ImplicitAction.html"> + <code>ImplicitAction</code></a>, will instantiate the class + specified in a nested component and attach it to the parent + component by using setter method of the parent component and the + nested element's name. Under certain circumstances, a nested action + needs to be applied to an element say <a> and also to another + element <b> nested within <a>. The current implementation of + <code>NestedComponentIA</code> is capable of handling multiply + nested elements requiring intervention by the same implicit action. + </p> -<div class="source"><pre>Element <xyz> asked to be printed. -Element <abc> asked to be printed. -ERROR in ch.qos.logback.core.joran.spi.InterpretationContext@1c5c1 - no applicable action \ -for <xyz>, current pattern is [/foo/xyz]</pre></div> - <p>The last line was printed because of a call to - <code>StatusPrinter</code> at the end of the main class.</p> <a name="newRule"></a>

1 0

svn commit: r2136 - in logback/trunk: logback-examples/src/main/java/chapter10/calculator logback-site/src/site/pages/css logback-site/src/site/pages/manual
by noreply.ceki＠qos.ch 28 Jan '09

28 Jan '09

Author: ceki Date: Wed Jan 28 22:06:55 2009 New Revision: 2136 Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/AddAction.java logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator1.java logback/trunk/logback-examples/src/main/java/chapter10/calculator/LiteralAction.java logback/trunk/logback-examples/src/main/java/chapter10/calculator/MultiplyAction.java logback/trunk/logback-examples/src/main/java/chapter10/calculator/calculator1.xml logback/trunk/logback-site/src/site/pages/css/common.css logback/trunk/logback-site/src/site/pages/manual/onJoran.html Log: Continuing improving Joran documentation as mandated by LBSITE-25 Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/AddAction.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/calculator/AddAction.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/AddAction.java Wed Jan 28 22:06:55 2009 @@ -1,7 +1,7 @@ /** - * Logback: the reliable, fast and flexible logging library for Java. + * Logback: the generic, reliable, fast and flexible logging framework. * - * Copyright (C) 1999-2006, QOS.ch + * Copyright (C) 2000-2009, QOS.ch * * This library is free software, you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the Free @@ -10,8 +10,6 @@ package chapter10.calculator; - - import java.util.EmptyStackException; import org.xml.sax.Attributes; @@ -28,23 +26,23 @@ */ public class AddAction extends Action { - public void begin(InterpretationContext ec, String name, Attributes attributes) { - int first = fetchInteger(ec); - int second = fetchInteger(ec); + public void begin(InterpretationContext ic, String name, Attributes attributes) { + int first = fetchInteger(ic); + int second = fetchInteger(ic); // Push the result of the addition for the following actions. - ec.pushObject(new Integer(first + second)); + ic.pushObject(new Integer(first + second)); } /** * Pop the Integer object at the top of the stack. - * This code illustrates usage of Joran's error handling paradigm. + * This code also illustrates usage of Joran's error handling paradigm. */ - int fetchInteger(InterpretationContext ec) { + int fetchInteger(InterpretationContext ic) { int result = 0; try { - // Pop the object at the top of the exection context stack. - Object o1 = ec.popObject(); + // Pop the object at the top of the interpretation context's stack. + Object o1 = ic.popObject(); if (o1 instanceof Integer) { result = ((Integer) o1).intValue(); @@ -52,20 +50,17 @@ String errMsg = "Object [" + o1 + "] currently at the top of the stack is not an integer."; - ec.addError(errMsg); + ic.addError(errMsg); throw new IllegalArgumentException(errMsg); } } catch (EmptyStackException ese) { - ec.addError(("Expecting an integer on the execution stack.")); + ic.addError(("Expecting an integer on the execution stack.")); throw ese; } return result; } - public void end(InterpretationContext ec, String name) { + public void end(InterpretationContext ic, String name) { // Nothing to do here. - // In general, the end() method of actions associated with elements - // having no children do not need to perform any processing in their - // end() method. } } Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator1.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator1.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator1.java Wed Jan 28 22:06:55 2009 @@ -1,7 +1,7 @@ /** - * Logback: the reliable, fast and flexible logging library for Java. + * Logback: the generic, reliable, fast and flexible logging framework. * - * Copyright (C) 1999-2006, QOS.ch + * Copyright (C) 2000-2009, QOS.ch * * This library is free software, you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the Free @@ -16,7 +16,6 @@ import ch.qos.logback.core.Context; import ch.qos.logback.core.ContextBase; import ch.qos.logback.core.joran.action.Action; -import ch.qos.logback.core.joran.spi.JoranException; import ch.qos.logback.core.joran.spi.Pattern; import ch.qos.logback.core.util.StatusPrinter; import chapter10.SimpleConfigurator; @@ -25,18 +24,6 @@ * This examples illustrates collaboration between multiple actions through the * common execution context stack. * - * The first and only argument of this application must be the path to the XML - * file to interpret. There are sample XML files in the - * <em>examples/src/joran/calculator/</em> directory. - * - * For example, - * - * <pre> - * java joran.calculator.Calculator1 examples/src/joran/calculator/calculator1.xml - * </pre> - * - * Please refer to the comments in the source code for more information. - * * @author Ceki Güulcü */ public class Calculator1 { @@ -58,11 +45,8 @@ // link the configurator with its context simpleConfigurator.setContext(context); - try { - simpleConfigurator.doConfigure(args[0]); - } catch (JoranException e) { - // Print any errors that might have occured. - StatusPrinter.print(context); - } + simpleConfigurator.doConfigure(args[0]); + // Print any errors that might have occured. + StatusPrinter.print(context); } } Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/LiteralAction.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/calculator/LiteralAction.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/LiteralAction.java Wed Jan 28 22:06:55 2009 @@ -1,7 +1,7 @@ /** - * Logback: the reliable, fast and flexible logging library for Java. + * Logback: the generic, reliable, fast and flexible logging framework. * - * Copyright (C) 1999-2006, QOS.ch + * Copyright (C) 2000-2009, QOS.ch * * This library is free software, you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the Free @@ -17,37 +17,36 @@ import ch.qos.logback.core.util.OptionHelper; /** - * - * This action converts the value attribute of the associated element to - * an integer and pushes the resulting Integer object on top of the execution + * This action converts the value attribute of the associated element to an + * integer and pushes the resulting Integer object on top of the execution * context stack. - * - * It also illustrates usage of Joran's error handling paradigm. - * + * + * <p>It also illustrates usage of Joran's error reporting/handling paradigm. + * * @author Ceki Gülcü */ public class LiteralAction extends Action { public static String VALUE_ATR = "value"; - public void begin(InterpretationContext ec, String name, Attributes attributes) { + public void begin(InterpretationContext ic, String name, Attributes attributes) { String valueStr = attributes.getValue(VALUE_ATR); if (OptionHelper.isEmpty(valueStr)) { - ec.addError("The literal action requires a value attribute"); + ic.addError("The literal action requires a value attribute"); return; } try { Integer i = Integer.valueOf(valueStr); - ec.pushObject(i); + ic.pushObject(i); } catch (NumberFormatException nfe) { - ec.addError("The value [" + valueStr + "] could not be converted to an Integer", - nfe); + ic.addError("The value [" + valueStr + + "] could not be converted to an Integer", nfe); throw nfe; } } - public void end(InterpretationContext ec, String name) { + public void end(InterpretationContext ic, String name) { // Nothing to do here. // In general, the end() method of actions associated with elements // having no children do not need to perform any processing in their Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/MultiplyAction.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/calculator/MultiplyAction.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/MultiplyAction.java Wed Jan 28 22:06:55 2009 @@ -1,7 +1,7 @@ /** * Logback: the generic, reliable, fast and flexible logging framework. * - * Copyright (C) 1999-2006, QOS.ch + * Copyright (C) 2000-2009, QOS.ch * * This library is free software, you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the Free @@ -10,7 +10,6 @@ package chapter10.calculator; - import org.xml.sax.Attributes; import ch.qos.logback.core.joran.action.Action; @@ -18,53 +17,47 @@ import java.util.EmptyStackException; - /** - * - * This action multiplies the two integers at the top of the stack (they are removed) - * and pushes the result on top the stack. - * + * + * This action multiplies the two integers at the top of the stack (they are + * removed) and pushes the result on top the stack. + * * @author Ceki Gülcü */ public class MultiplyAction extends Action { - - - public void begin(InterpretationContext ec, String name, Attributes attributes) { - int first = fetchInteger(ec); - int second = fetchInteger(ec); - ec.pushObject(new Integer(first * second)); + + public void begin(InterpretationContext ic, String name, Attributes attributes) { + int first = fetchInteger(ic); + int second = fetchInteger(ic); + ic.pushObject(new Integer(first * second)); } /** - * Pop the Integer object at the top of the stack. - * This code illustrates usage of Joran's error handling paradigm. + * Pop the Integer object at the top of the stack. This code illustrates usage + * of Joran's error handling paradigm. */ - int fetchInteger(InterpretationContext ec) { + int fetchInteger(InterpretationContext ic) { int result = 0; try { - Object o1 = ec.popObject(); + Object o1 = ic.popObject(); if (o1 instanceof Integer) { result = ((Integer) o1).intValue(); } else { - String errMsg = - "Object [" + o1 - + "] currently at the top of the stack is not an integer."; - ec.addError(errMsg); + String errMsg = "Object [" + o1 + + "] currently at the top of the stack is not an integer."; + ic.addError(errMsg); throw new IllegalArgumentException(errMsg); } } catch (EmptyStackException ese) { - ec.addError("Expecting an integer on the execution stack."); + ic.addError("Expecting an integer on the execution stack."); throw ese; } return result; } - public void end(InterpretationContext ec, String name) { + public void end(InterpretationContext ic, String name) { // Nothing to do here. - // In general, the end() method of actions associated with elements - // having no children do not need to perform any processing in their - // end() method. } } Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/calculator1.xml ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/calculator/calculator1.xml (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/calculator1.xml Wed Jan 28 22:06:55 2009 @@ -1,6 +1,3 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<!DOCTYPE computation> - <computation name="total"> <literal value="3"/> </computation> Modified: logback/trunk/logback-site/src/site/pages/css/common.css ============================================================================== --- logback/trunk/logback-site/src/site/pages/css/common.css (original) +++ logback/trunk/logback-site/src/site/pages/css/common.css Wed Jan 28 22:06:55 2009 @@ -18,26 +18,26 @@ margin-top: 1em; } -.source { +.source, .command, .console { border-top: 1px solid #DDDDDD; border-bottom: 1px solid #DDDDDD; background:#eee; font-family: Courier, "MS Courier New", Prestige, monospace; - padding-bottom: 0.5ex; - padding-top: 0.5ex; padding-left: 1ex; white-space: pre; } -.command { - border-top: 1px solid #DDDDDD; - border-bottom: 1px solid #DDDDDD; - background:#eee; - font-family: Courier, "MS Courier New", Prestige, monospace; +.source { + padding-bottom: 0.5ex; + padding-top: 0.5ex; +} + +.command { padding-bottom: 0ex; padding-top: 0ex; - padding-left: 1ex; - white-space: pre; +} + +.console { } pre { Modified: logback/trunk/logback-site/src/site/pages/manual/onJoran.html ============================================================================== --- logback/trunk/logback-site/src/site/pages/manual/onJoran.html (original) +++ logback/trunk/logback-site/src/site/pages/manual/onJoran.html Wed Jan 28 22:06:55 2009 @@ -126,15 +126,21 @@ problems. </p> - + <h3>Non goals</h3> + + <p>Given its highly dynamic nature, the Joran API is not intended + to be used to parse very large XML documents with many thousands + of elements. + </p> + + <h3><a name="pattern" href="#pattern">Pattern</a></h3> <p>A Joran pattern is essentially a string. There are two kind of - patterns, <em>exact</em> and <em>wildcard</em>. The pattern - "a/b" can be used to match <code><b></code> element nested - within a top-level <code><a></code> element but not a - <code><c></code> element, even if nested within a - <code><b></code> element.</p> + patterns, <em>exact</em> and <em>wildcard</em>. The pattern "a/b" + can be used to match <code><b></code> element nested within a + top-level <code><a></code> element. The "a/b" will not match + any other element, hence the <em>exact</em> match designation.</p> <p>Wildcards can be used to match suffixes or prefixes. For example, the "*/a" pattern can be used to match any suffix ending @@ -145,13 +151,6 @@ <code><a></code> element. </p> - <p>When several rules match the current pattern, then exact - matches override suffix matches, and suffix matches overide prefix - matches. For exact details of implementation, please see the <a - href="../xref/ch/qos/logback/core/joran/spi/SimpleRuleStore.java">SimpleRuleStore</a> - class. - </p> - <h3><a name="action" href="#action">Actions</a></h3> <p>As mentioned above, Joran parsing rules consists of the @@ -190,9 +189,33 @@ <h3><a name="ruleStore" href="#ruleStore">RuleStore</a> </h3> + <p>As mentioned previously, the invocation of actions according to + matching patterns is a central concept in Joran. A rule is an + association of a pattern and an action. Rules are stored in a <a + href="../xref/ch/qos/logback/core/joran/spi/RuleStore.java">RuleStore</a>. + </p> + + <p>As mentioned above, Joran is built on top of the SAX API. As an + XML document is parsed, each element generates events corresponding + to the start, body and end of each element. When a joran + configurator receives these events, it will attempt to find in its + rule store an action corresponding to the <em>current + pattern</em>.. For example, the current pattern for the start, body + or end event of element <em>B</em> nested within a top-level + <em>A</em> element is "A/B". The current pattern is a data + structure maintained automatically by Joran as it receives and + processes SAX events. </p> + + <p>When several rules match the current pattern, then exact + matches override suffix matches, and suffix matches overide prefix + matches. For exact details of implementation, please see the <a + href="../xref/ch/qos/logback/core/joran/spi/SimpleRuleStore.java">SimpleRuleStore</a> + class. + </p> - <h2>Interpretation context</h2> + <h3><a name="interpretationContext" + href="#interpretationContext">Interpretation context</a></h3> <p>To allow various actions to collaborate, the invocation of begin and end methods include an interpretation context as the first @@ -242,8 +265,6 @@ if any, are printed</li> </ul> - - <p>The <em>hello.xml</em> file contains one <hello-world> element, without any other nested elements. See the <em>logback-examples/src/main/java/chapter10/helloWorld/</em> @@ -253,7 +274,14 @@ <p>Running the HelloWorld application with <em>hello.xml</em> file will print "Hello World" on the console.</p> - <p class="source">java chapter10.helloWorld.HelloWorld src/main/java/chapter10/helloWorld/hello.xml</p> + <p class="command">java chapter10.helloWorld.HelloWorld src/main/java/chapter10/helloWorld/hello.xml</p> + + <p>You are highly encourared to poke about this example, by adding + new rules on the rule store, modifying the XML document + (hello.xml) and adding new actions. + </p> + +  <h3><a name="calculator" href="#calculator">Collaborating actions</a></h3> @@ -266,15 +294,35 @@ <p>The <em>calculator1.xml</em> file contains a <code>computation</code> element, with a nested - <code>literal</code> element. + <code>literal</code> element. Here are its contents. </p> + <em>Example 10.<span class="autoEx"/>: First calculator example + (logback-examples/src/main/java/chapter10/calculator/calculator1.xml)</em> + + <em> </em> + <p class="source"><computation name="total"> + <literal value="3"/> +</computation></p> + <p>In the <a href="../xref/chapter3/calculator/Calculator1.html"> - <code>Calculator1</code></a> class, we declare various patterns - and actions, that will collaborate and calculate a result based on - the xml file. The simple <em>calculator1.xml</em> file only - creates a computation and declares a literal value. The resulting - parsing is pretty simple: + <code>Calculator1</code></a> application, we declare various + parsing rules (patterns and actions) collaborating together to + compute a result based on the contents of an XML document. + </p> + + <p> Running <code>Calculator1</code> application with + <em>calculator1.xml</em></p> + + <p class="command">java chapter10.calculator.Calculator1 src/main/java/chapter10/calculator/calculator1.xml</p> + + <p>will print:</p> + + <p class="console">The computation named [total] resulted in the value 3</p> + + + <p>Parsing the <em>calculator1.xml</em> document (listed above) + involves the following steps: </p> <ul> @@ -290,15 +338,17 @@ is called</li> </ul> - <p>What is interesting here is the way that the Actions - collaborate. The <code>LiteralAction</code> reads a literal value - and pushes it in the object stack maintained by the + <p>What is interesting here is the way actions collaborate. The + <code>LiteralAction</code> reads a literal value and pushes it in + the object stack maintained by the <code>InterpretationContext</code>. Once done, any other action can pop the value to read or modify it. Here, the <code>end()</code> method of the <code>ComputationAction1</code> class pops the value from the stack and prints it. </p> +  + <p>The <em>calculator2.xml</em> file is a bit more complex, but much more interesting.</p> @@ -544,14 +594,6 @@ <multiply/> </computation></pre></div> - - <h3>Non goals</h3> - - <p>The Joran API is not intended to be used to parse documents with - thousands of elements. - </p> - - <script src="templates/footer.js" type="text/javascript"></script> </div> </body>

1 0

svn commit: r2135 - in logback/trunk: logback-core/src/main/java/ch/qos/logback/core/joran/action logback-core/src/main/java/ch/qos/logback/core/joran/spi logback-examples/src/main/java/chapter10 logback-examples/src/main/java/chapter10/calculator logback-examples/src/main/java/chapter10/helloWorld logback-examples/src/main/java/chapter10/implicit logback-examples/src/main/java/chapter10/newRule logback-examples/src/main/java/chapter3 logback-site/src/site/pages/manual
by noreply.ceki＠qos.ch 27 Jan '09

27 Jan '09

Author: ceki Date: Tue Jan 27 21:10:55 2009 New Revision: 2135 Added: logback/trunk/logback-examples/src/main/java/chapter10/SimpleConfigurator.java - copied, changed from r2131, /logback/trunk/logback-examples/src/main/java/chapter3/SimpleConfigurator.java Removed: logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/readme.txt logback/trunk/logback-examples/src/main/java/chapter3/SimpleConfigurator.java Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/Action.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/Pattern.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/RuleStore.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/SimpleRuleStore.java logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator1.java logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator2.java logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/HelloWorld.java logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/HelloWorldAction.java logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/hello.xml logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMe.java logback/trunk/logback-examples/src/main/java/chapter10/newRule/NewRuleCalculator.java logback/trunk/logback-site/src/site/pages/manual/onJoran.html Log: ongoing work on the javadocs and on chapter 10 (onJoran) Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/Action.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/Action.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/Action.java Tue Jan 27 21:10:55 2009 @@ -43,10 +43,8 @@ public static final String ACTION_CLASS_ATTRIBUTE = "actionClass"; /** - * Called when the parser first encounters an element. - * - * The return value indicates whether child elements should be processed. If - * the returned value is 'false', then child elements are ignored. + * Called when the parser encounters an element matching a + * {@link ch.qos.logback.core.joran.spi.Pattern Pattern}. */ public abstract void begin(InterpretationContext ec, String name, Attributes attributes) throws ActionException; @@ -56,6 +54,10 @@ // NOP } + /* + * Called when the parser encounters an endElement event matching a + * {@link ch.qos.logback.core.joran.spi.Pattern Pattern}. + */ public abstract void end(InterpretationContext ec, String name) throws ActionException; Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/Pattern.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/Pattern.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/Pattern.java Tue Jan 27 21:10:55 2009 @@ -1,7 +1,7 @@ /** * Logback: the generic, reliable, fast and flexible logging framework. * - * Copyright (C) 2000-2008, QOS.ch + * Copyright (C) 2000-2009, QOS.ch * * This library is free software, you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the Free @@ -12,6 +12,14 @@ import java.util.ArrayList; +/** + * A pattern is used to designate XML elements in a document. + * + * <p>For more information see + * http://logback.qos.ch/manual/onJoran.html#pattern + * + * @author Ceki Gülcü + */ public class Pattern { // contains String instances Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/RuleStore.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/RuleStore.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/RuleStore.java Tue Jan 27 21:10:55 2009 @@ -1,24 +1,35 @@ /** - * LOGBack: the generic, reliable, fast and flexible logging framework. + * Logback: the generic, reliable, fast and flexible logging framework. * - * Copyright (C) 1999-2006, QOS.ch + * Copyright (C) 2000-2009, QOS.ch * * This library is free software, you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the Free * Software Foundation. */ - package ch.qos.logback.core.joran.spi; import java.util.List; import ch.qos.logback.core.joran.action.Action; - - +/** + * + * As its name indicates, a RuleStore contains 2-tuples consists of a Pattern + * and an Action. + * + * <p>As a joran configurator goes through the elements in a document, it asks + * the rule store whether there are rules matching the current pattern by + * invoking the {@link #matchActions(Pattern)} method. + * + * @author Ceki Gülcü + * + */ public interface RuleStore { - public void addRule(Pattern pattern, String actionClassStr) throws ClassNotFoundException; + public void addRule(Pattern pattern, String actionClassStr) + throws ClassNotFoundException; + public void addRule(Pattern pattern, Action action); - - public List matchActions(Pattern pattern); + + public List matchActions(Pattern currentPatern); } Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/SimpleRuleStore.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/SimpleRuleStore.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/SimpleRuleStore.java Tue Jan 27 21:10:55 2009 @@ -1,13 +1,12 @@ /** - * LOGBack: the generic, reliable, fast and flexible logging framework. + * Logback: the generic, reliable, fast and flexible logging framework. * - * Copyright (C) 1999-2006, QOS.ch + * Copyright (C) 2000-2009, QOS.ch * * This library is free software, you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the Free * Software Foundation. */ - package ch.qos.logback.core.joran.spi; import java.util.ArrayList; @@ -19,29 +18,32 @@ import ch.qos.logback.core.spi.ContextAwareBase; import ch.qos.logback.core.util.OptionHelper; - - +/** + * This class implements the {@link RuleStore} interface. It is the rule store + * implementation used by default in Joran. + * + * @author Ceki Gülcü + * + */ public class SimpleRuleStore extends ContextAwareBase implements RuleStore { // key: Pattern instance, value: ArrayList containing actions HashMap<Pattern, List<Action>> rules = new HashMap<Pattern, List<Action>>(); - -// public SimpleRuleStore() { -// } + + // public SimpleRuleStore() { + // } public SimpleRuleStore(Context context) { setContext(context); } - + /** - * Add a new rule, i.e. a pattern, action pair to the rule store. - * <p> - * Note that the added action's LoggerRepository will be set in the - * process. + * Add a new rule, i.e. a pattern, action pair to the rule store. <p> Note + * that the added action's LoggerRepository will be set in the process. */ public void addRule(Pattern pattern, Action action) { action.setContext(context); - + List<Action> a4p = rules.get(pattern); if (a4p == null) { @@ -54,16 +56,16 @@ public void addRule(Pattern pattern, String actionClassName) { Action action = null; - + try { - action = (Action) OptionHelper.instantiateByClassName( - actionClassName, Action.class, context); - } catch(Exception e) { - addError("Could not instantiate class ["+actionClassName+"]", e); + action = (Action) OptionHelper.instantiateByClassName(actionClassName, + Action.class, context); + } catch (Exception e) { + addError("Could not instantiate class [" + actionClassName + "]", e); + } + if (action != null) { + addRule(pattern, action); } - if(action != null) { - addRule(pattern, action); - } } // exact match has highest priority @@ -71,36 +73,34 @@ // tail match for */x/y has higher priority than match for */x // if no tail match, check for prefix match, i.e. matches for x/* // match for x/y/* has higher priority than matches for x/* - + public List matchActions(Pattern currentPattern) { - //System.out.println("pattern to search for:" + pattern + ", hashcode: " + pattern.hashCode()); - //System.out.println("rules:" + rules); List actionList; if ((actionList = rules.get(currentPattern)) != null) { return actionList; - } else if ( (actionList = tailMatch(currentPattern)) != null){ - return actionList; + } else if ((actionList = tailMatch(currentPattern)) != null) { + return actionList; } else if ((actionList = prefixMatch(currentPattern)) != null) { - //System.out.println(currentPattern + " prefixMatches "+actionList); + // System.out.println(currentPattern + " prefixMatches "+actionList); return actionList; } else { return null; } } - + List tailMatch(Pattern currentPattern) { int max = 0; Pattern longestMatchingPattern = null; - for (Pattern p: rules.keySet()) { + for (Pattern p : rules.keySet()) { if ((p.size() > 1) && p.get(0).equals("*")) { int r = currentPattern.getTailMatchLength(p); - //System.out.println("tailMatch " +r); + // System.out.println("tailMatch " +r); if (r > max) { - //System.out.println("New longest tailMatch "+p); + // System.out.println("New longest tailMatch "+p); max = r; longestMatchingPattern = p; } @@ -113,21 +113,21 @@ return null; } } - + List prefixMatch(Pattern currentPattern) { int max = 0; Pattern longestMatchingPattern = null; - for (Pattern p: rules.keySet()) { + for (Pattern p : rules.keySet()) { String last = p.peekLast(); - if("*".equals(last)) { + if ("*".equals(last)) { int r = currentPattern.getPrefixMatchLength(p); - - //System.out.println("r = "+ r + ", p= "+p); - + + // System.out.println("r = "+ r + ", p= "+p); + // to qualify the match length must equal p's size omitting the '*' - if ((r == p.size()-1) && (r > max)) { - //System.out.println("New longest prefixMatch "+p); + if ((r == p.size() - 1) && (r > max)) { + // System.out.println("New longest prefixMatch "+p); max = r; longestMatchingPattern = p; } @@ -135,23 +135,23 @@ } if (longestMatchingPattern != null) { - //System.out.println("prefixMatch will return" +rules.get(longestMatchingPattern)); + // System.out.println("prefixMatch will return" + // +rules.get(longestMatchingPattern)); return rules.get(longestMatchingPattern); } else { return null; } } - public String toString() { - final String TAB = " "; - - StringBuilder retValue = new StringBuilder(); - - retValue.append("SimpleRuleStore ( ") - .append("rules = ").append(this.rules).append(TAB) - .append(" )"); - - return retValue.toString(); + public String toString() { + final String TAB = " "; + + StringBuilder retValue = new StringBuilder(); + + retValue.append("SimpleRuleStore ( ").append("rules = ").append(this.rules) + .append(TAB).append(" )"); + + return retValue.toString(); } - + } Copied: logback/trunk/logback-examples/src/main/java/chapter10/SimpleConfigurator.java (from r2131, /logback/trunk/logback-examples/src/main/java/chapter3/SimpleConfigurator.java) ============================================================================== --- /logback/trunk/logback-examples/src/main/java/chapter3/SimpleConfigurator.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/SimpleConfigurator.java Tue Jan 27 21:10:55 2009 @@ -1,13 +1,13 @@ /** * Logback: the generic, reliable, fast and flexible logging framework. * - * Copyright (C) 1999-2006, QOS.ch + * Copyright (C) 2000-2009, QOS.ch * * This library is free software, you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the Free * Software Foundation. */ -package chapter3; +package chapter10; import java.util.List; import java.util.Map; @@ -19,6 +19,12 @@ import ch.qos.logback.core.joran.spi.Pattern; import ch.qos.logback.core.joran.spi.RuleStore; +/** + * A minimal configurator extending GenericConfigurator. + * + * @author Ceki Gücü + * + */ public class SimpleConfigurator extends GenericConfigurator { final Map<Pattern, Action> ruleMap; @@ -35,7 +41,6 @@ @Override protected void addInstanceRules(RuleStore rs) { - for (Pattern pattern : ruleMap.keySet()) { Action action = ruleMap.get(pattern); rs.addRule(pattern, action); Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator1.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator1.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator1.java Tue Jan 27 21:10:55 2009 @@ -19,7 +19,7 @@ import ch.qos.logback.core.joran.spi.JoranException; import ch.qos.logback.core.joran.spi.Pattern; import ch.qos.logback.core.util.StatusPrinter; -import chapter3.SimpleConfigurator; +import chapter10.SimpleConfigurator; /** * This examples illustrates collaboration between multiple actions through the Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator2.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator2.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator2.java Tue Jan 27 21:10:55 2009 @@ -18,7 +18,7 @@ import ch.qos.logback.core.joran.spi.JoranException; import ch.qos.logback.core.joran.spi.Pattern; import ch.qos.logback.core.util.StatusPrinter; -import chapter3.SimpleConfigurator; +import chapter10.SimpleConfigurator; /** Modified: logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/HelloWorld.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/HelloWorld.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/HelloWorld.java Tue Jan 27 21:10:55 2009 @@ -13,35 +13,24 @@ import java.util.HashMap; import java.util.Map; -import chapter3.SimpleConfigurator; import ch.qos.logback.core.Context; import ch.qos.logback.core.ContextBase; import ch.qos.logback.core.joran.action.Action; -import ch.qos.logback.core.joran.spi.JoranException; import ch.qos.logback.core.joran.spi.Pattern; import ch.qos.logback.core.util.StatusPrinter; - +import chapter10.SimpleConfigurator; /** - * + * * A hello world example using Joran. - * - * The first and only argument of this application must be the path to - * the XML file to interpret. - * - * For example, - * -<pre> - java joran.helloWorld.HelloWorld examples/src/joran/helloWorld/hello.xml -</pre> - * + * * @author Ceki Gulcu */ public class HelloWorld { public static void main(String[] args) throws Exception { Map<Pattern, Action> ruleMap = new HashMap<Pattern, Action>(); - // Associate "hello-world" pattern with HelloWorldAction + // Associate "hello-world" pattern with HelloWorldAction ruleMap.put(new Pattern("hello-world"), new HelloWorldAction()); // Joran needs to work within a context. @@ -50,11 +39,7 @@ // link the configurator with its context simpleConfigurator.setContext(context); - try { - simpleConfigurator.doConfigure(args[0]); - } catch (JoranException e) { - // Print any errors that might have occured. - StatusPrinter.print(context); - } - } + simpleConfigurator.doConfigure(args[0]); + StatusPrinter.print(context); + } } Modified: logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/HelloWorldAction.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/HelloWorldAction.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/HelloWorldAction.java Tue Jan 27 21:10:55 2009 @@ -10,18 +10,15 @@ package chapter10.helloWorld; - - import org.xml.sax.Attributes; import ch.qos.logback.core.joran.action.Action; import ch.qos.logback.core.joran.spi.InterpretationContext; - /** * A trivial action that writes "Hello world" on the console. * - * See the HelloWorld class for integrating with Joran. + * See the {@link HelloWorld} class for integration with Joran. * * @author Ceki Gülcü */ Modified: logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/hello.xml ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/hello.xml (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/hello.xml Tue Jan 27 21:10:55 2009 @@ -1,5 +1,2 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<!DOCTYPE hello-world> - -<hello-world> +<hello-world> </hello-world> Modified: logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMe.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMe.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMe.java Tue Jan 27 21:10:55 2009 @@ -14,7 +14,7 @@ import java.util.List; import java.util.Map; -import chapter3.SimpleConfigurator; +import chapter10.SimpleConfigurator; import ch.qos.logback.core.Context; import ch.qos.logback.core.ContextBase; import ch.qos.logback.core.joran.action.Action; Modified: logback/trunk/logback-examples/src/main/java/chapter10/newRule/NewRuleCalculator.java ============================================================================== --- logback/trunk/logback-examples/src/main/java/chapter10/newRule/NewRuleCalculator.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/newRule/NewRuleCalculator.java Tue Jan 27 21:10:55 2009 @@ -20,7 +20,7 @@ import ch.qos.logback.core.joran.spi.JoranException; import ch.qos.logback.core.joran.spi.Pattern; import ch.qos.logback.core.util.StatusPrinter; -import chapter3.SimpleConfigurator; +import chapter10.SimpleConfigurator; import chapter10.calculator.ComputationAction2; Modified: logback/trunk/logback-site/src/site/pages/manual/onJoran.html ============================================================================== --- logback/trunk/logback-site/src/site/pages/manual/onJoran.html (original) +++ logback/trunk/logback-site/src/site/pages/manual/onJoran.html Tue Jan 27 21:10:55 2009 @@ -11,9 +11,7 @@ </head> <body> - <script type="text/javascript"> - prefix='../'; - </script> + <script type="text/javascript">prefix='../'</script> <script src="../templates/header.js" type="text/javascript"></script> <div id="left"> <script src="../templates/left.js" type="text/javascript"></script> @@ -25,21 +23,23 @@ <h2>Joran in your own applications</h2> - <p>As we've seen, logback relies on Joran, a mature, flexible and - powerful configuration framework. Many of the capabilities offered - by logback modules are only possible on account of Joran. + <p>As apparent in previous chapters, logback relies on Joran, a + mature, flexible and powerful configuration framework. Many of the + capabilities offered by logback modules are only possible on + account of Joran. This chapter focuses on Joran, its basic design + and its salient features. </p> <p>Joran is actually a generic configuration system which can be used independently of logging. To emphaises this point, we should mention that the logback-core module does not have a notion of - loggers. In that spirit, many of the examples related to this - tutorial, have nothing to do with loggers, appenders or layouts. + loggers. In that spirit, most of the examples in this chapter have + nothing to do with loggers, appenders or layouts. </p> - <p class="red" style="text-decoration: line-through;">The examples - for this chapter can be found under - <em>LOGBACK_HOME/logback-examples/src/main/java/chapter3</em>. + <p>The examples presented in this chapter can be found under + <em>LOGBACK_HOME/logback-examples/src/main/java/chapter10</em> + folder. </p> <p>To install joran, simply <a href="../download.html">download</a> @@ -48,36 +48,45 @@ <h2>Historical perspective</h2> - <p>One of the most powerful features of the Java language is - reflection. Reflection makes it possible to configure software - systems declaratively. For example, many important properties of an - EJB are configured with the <em>ejb.xml</em> file. While EJBs are - written in Java, many of their properties are specified within the - <em>ejb.xml</em> file. Similarly, logback settings can be specified - in a configuration file, expressed in XML format. - </p> - - <p>In log4j, logback's predecessor, <code>DOMConfigurator</code> - which shipped with log4j version 1.2.x could also parse - configuration files written in XML. The - <code>DOMConfigurator</code> was written in a way that forced to - tweak it each time the structure of the configuration file - changed. The modified code had to be recompiled and - redeployed. Just as importantly, the code of the DOMConfigurator - consists of loops dealing with children elements containing many - interspersed if/else statements. One could not help but notice - that that particular code reeked of redundancy. The <a - href="http://jakarta.apache.org/commons/digester/">digester - project</a> has shown that it is possible to parse XML files using - pattern matching rules. At parse time, digester will apply the - rules that match previously stated patterns. Rule classes are - usually quite small and specialized. Consequently, they are - relatively easy to understand and to maintain. - </p> - - <p>Joran is heavily inspired by the commons-digester project but - uses a slightly different terminology. In commons-digester, a rule - can be seen as consisting of a pattern and a rule, as shown by the + <p>Reflection is a powerful feature of the Java language, making + it possible to configure software systems declaratively. For + example, many important properties of an EJB are configured with + the <em>ejb.xml</em> file. While EJBs are written in Java, many of + their properties are specified within the <em>ejb.xml</em> + file. Similarly, logback settings can be specified in a + configuration file, expressed in XML format. Annotations available + in JDK 1.5 and heavily used in EJB 3.0 replace many of directives + previously found in XML files. Joran also makes use of annonations + but at a much smaller extent. Due to the dynamic nature of logback + configuration data (compared to EJBs) Joran's use of annonations + is rather limited. + </p> + + <p>In log4j, logback's predecessor, the + <code>DOMConfigurator</code> class, which is part of log4j version + 1.2.x and later, could also parse configuration files written in + XML. <code>DOMConfigurator</code> was written in a way that forced + us, the developers, to tweak the code each time the structure of + the configuration file changed. The modified code had to be + recompiled and redeployed. Just as importantly, the code of the + <code>DOMConfigurator</code> consisted of loops dealing with + children elements containing many interspersed if/else + statements. One could not help but notice that that particular + code reeked of redundancy and duplication. The <a + href="http://jakarta.apache.org/commons/digester/">commons-digester + project</a> had shown us that it was possible to parse XML files + using pattern matching rules. At parse time, digester would apply + rules that matched designated patterns. Rule classes were usually + quite small and specialized. Consequently, they were relatively + easy to understand and maintain. + </p> + + <p>Armed with the <code>DOMConfigurator</code> experience, we + began developing <code>Joran</code>, a powerful configuration + framework to be used in logback. Joran was largely inspired by the + commons-digester project. Nevertheless, it uses a slightly + different terminology. In commons-digester, a rule can be seen as + consisting of a pattern and a rule, as shown by the <code>Digester.addRule(String pattern, Rule rule)</code> method. We find it unnecessarily confusing to have a rule to consist of itself, not recursively but with a different @@ -86,19 +95,10 @@ pattern. This relation between patterns and actions lies at the core of Joran. Quite remarkably, one can deal with quite complex requirements by using simple patterns, or more precisely with - exact matches and wildcard matches. For example, the pattern - <em>a/b</em> will match a <code><b></code> element nested - within an <code><a></code> element but not a - <code><c></code> element, even if nested within a - <code><b></code> element. It is also possible to match a - particular XML element, regardless of its nesting level, by using - the <em>*</em> wildcard character. For example, the pattern - <em>*/a</em> will match an <code><a></code> element at any - nesting position within the document. Other types of patterns, for - example <em>a/*</em>, are not currently supported by Joran. + exact matches and wildcard matches. </p> - <h2>SAX or DOM?</h2> + <h3>SAX or DOM?</h3> <p>Due to the event-based architecture of the SAX API, a tool based on SAX cannot easily deal with forward references, that is, @@ -118,19 +118,47 @@ order.</em> </p> - <p>Joran was first implemented in DOM. However, the author migrated - to SAX in order to benefit location information, available only with - the SAX API. Location information allows Joran to display the exact - line and column number where an error occured, which comes in quite - handy when hunting down problems. + <p>Joran was first implemented in DOM. However, the author + migrated to SAX in order to benefit from element location + information, available only with the SAX API. Location information + allows Joran to display the exact line and column number where an + error occured, which comes in very handy in indentifying parsing + problems. </p> - <h2>Actions</h2> + <h3><a name="pattern" href="#pattern">Pattern</a></h3> + + <p>A Joran pattern is essentially a string. There are two kind of + patterns, <em>exact</em> and <em>wildcard</em>. The pattern + "a/b" can be used to match <code><b></code> element nested + within a top-level <code><a></code> element but not a + <code><c></code> element, even if nested within a + <code><b></code> element.</p> + + <p>Wildcards can be used to match suffixes or prefixes. For + example, the "*/a" pattern can be used to match any suffix ending + with "a", that is any <code><a></code> element within an XML + document but not any elements nested within <code><a></code>. + The "a/*" pattern will match any element prefixed by + <code><a></code>, that is any element nested within an + <code><a></code> element. + </p> + + <p>When several rules match the current pattern, then exact + matches override suffix matches, and suffix matches overide prefix + matches. For exact details of implementation, please see the <a + href="../xref/ch/qos/logback/core/joran/spi/SimpleRuleStore.java">SimpleRuleStore</a> + class. + </p> + + <h3><a name="action" href="#action">Actions</a></h3> - <p>Actions extend the - <code>ch.qos.logback.core.joran.action.Action</code> class which - consists of the following abstract methods. + <p>As mentioned above, Joran parsing rules consists of the + association of patterns. Actions extend the <a + href="../xref/ch/qos/logback/core/joran/action/Action.html"><code>Action</code></a> + class, consisting of the following abstract methods. Other methods + have been omitted for berevity. </p> @@ -142,135 +170,143 @@ public abstract class Action { - /** - * Called when the parser first encounters an element. - */ - public abstract void begin(ExecutionContext ec, - String name, - Attributes attributes); - - /** - * Called when the parser encounters the element end. At - * this stage, we can assume that child elements, if any, - * have been processed. - */ - public abstract void end(ExecutionContext ec, String name); + /** + * Called when the parser encounters an element matching a + * {@link ch.qos.logback.core.joran.spi.Pattern Pattern}. + */ + public abstract void begin(InterpretationContext ec, String name, + Attributes attributes) throws ActionException; + + /* + * Called when the parser encounters an endElement event matching a + * {@link ch.qos.logback.core.joran.spi.Pattern Pattern}. + */ + public abstract void end(InterpretationContext ec, String name) + throws ActionException; }</p> <p>Thus, every action must implement the begin and end methods.</p> - <h2>Execution context</h2> + <h3><a name="ruleStore" href="#ruleStore">RuleStore</a> </h3> + + + + <h2>Interpretation context</h2> <p>To allow various actions to collaborate, the invocation of begin - and end methods include an execution context as the first - parameter. The execution context includes an object stack, an object - map, an error list and a reference to the Joran interpreter invoking - the action. Please see the - <code>ch.qos.logback.core.joran.spi.ExecutionContext</code> class - for the exact list of fields contained in the execution context. + and end methods include an interpretation context as the first + parameter. The interpretation context includes an object stack, an + object map, an error list and a reference to the Joran interpreter + invoking the action. Please see the <a + href="../xref/ch/qos/logback/core/joran/spi/InterpretationContext.html"><code>InterpretationContext</code></a> + class for the exact list of fields contained in the interpretation + context. </p> <p>Actions can collaborate together by fetching, pushing or popping objects from the common object stack, or by putting and fetching keyed objects on the common object map. Actions can report any error - conditions by adding error items on the execution context's + conditions by adding error items on the interpretation context's <code>StatusManager</code>. </p> - <a name="helloWorld"></a> - <h3>A hello world example</h3> + <h3><a name="helloWorld" href="#helloWorld">Hello world</a></h3> - <p>The <em>logback-examples/src/main/java/chapter3/helloWorld/</em> - directory includes a trivial action and Joran interpreter setup - which just displays <em>Hello World</em> when a <hello-world> - element is encountered in an XML file. It also includes the basic - steps which are necessary to set up and invoke a Joran interpreter. + <p>The first example in this chapter illustrates the minimal + plumbing required for using Joran. The example consists of a + trivial action called <a + href="../xref/chapter10/helloWorld/HelloWorldAction.html"> + <code>HelloWorldAction</code></a> which prints "Hello World" on the + console when it's <code>begin()</code> method is invoked. The + parsing of XML files is done by a configurator. For the purposes of + this chapter, we have developped a very simple configurator called + <a + href="../xref/chapter10/SimpleConfigurator.html"><code>SimpleConfigurator</code></a>. + The <a + href="../xref/chapter10/helloWorld/HelloWorld.html"><code>HelloWorld</code></a> + application brings all pieces together. </p> - <p>The <em>hello.xml</em> file contains only one element, without - any other nested elements. The <a - href="../xref/chapter3/helloWorld/HelloWorldAction.html"> - <code>HelloWorldAction</code></a> class is a trivial implementation: - it only prints "Hello World" in the console when it's - <code>begin()</code> method is called. - </p> - - <p> <a - href="../xref/chapter3/helloWorld/HelloWorld.html"><code>HelloWorld</code></a> - is a class that sets up the Joran interpreter, with the minimal - steps necessary: - </p> - - <ul> - <li>It creates a <code>RuleStore</code> and a <code>Context</code></li> - <li>It adds the <em>hello-world</em> pattern, with it's corresponding action</li> - <li>It creates a Joran interpreter, and passes the <code>RuleStore</code></li> - <li>It creates a SAX parser and parses the given file, specifying the newly created - Joran interpreter as the <code>ContentHandler</code></li> - </ul> - - <p>It's last step is to print the content of the - <code>Context</code>. Since Joran uses logback's powerfull - <code>Status</code> objects for error reporting, one can have a good - feedback on what happened during the parsing. - </p> + <ul> + <li>It creates a map of rules and a <code>Context</code></li> + <li>It creates a parsing rule by associating the + <em>hello-world</em> pattern with a corresponding + <code>HelloWorldAction</code> instance</li> + <li>It creates a <code>SimpleConfigutator</code>, passing it the + aforementioned rules map</li> + <li>it then invokes the <code>doConfigure</code> method of the + configurator, passing the designated XML file as parameter + </li> + <li>as a last step, the accumulated Status message in the context, + if any, are printed</li> + </ul> - <p>In this example, the parsing is rather simple. The - <em>hello-world</em> element will activate - <code>HelloWorldAction</code>'s <code>begin()</code> and - <code>end()</code> methods. In the first method, a simple call to - <code>System.out.println()</code> will be issued, displaying - <em>Hello World</em> in the console. - </p> - <a name="calculator"></a> - <h3>Collaborating actions</h3> + + <p>The <em>hello.xml</em> file contains one <hello-world> + element, without any other nested elements. See the + <em>logback-examples/src/main/java/chapter10/helloWorld/</em> + folder for exact contents. + </p> + + <p>Running the HelloWorld application with <em>hello.xml</em> file + will print "Hello World" on the console.</p> + + <p class="source">java chapter10.helloWorld.HelloWorld src/main/java/chapter10/helloWorld/hello.xml</p> - <p>The <em>logback-examples/src/main/java/joran/calculator/</em> - directory includes several actions which collaborate together - through the common object stack in order to accomplish simple - computations. - </p> + <h3><a name="calculator" href="#calculator">Collaborating + actions</a></h3> + + <p>The <em>logback-examples/src/main/java/joran/calculator/</em> + directory includes several actions which collaborate together + through the common object stack in order to accomplish simple + computations. + </p> - <p>The <em>calculator1.xml</em> file contains a <code>computation</code> - element, with a nested <code>literal</code> element. - </p> + <p>The <em>calculator1.xml</em> file contains a + <code>computation</code> element, with a nested + <code>literal</code> element. + </p> - <p>In the <a href="../xref/chapter3/calculator/Calculator1.html"> - <code>Calculator1</code></a> class, we declare various patterns and - actions, that will collaborate and calculate a result based on the - xml file. The simple <em>calculator1.xml</em> file only creates a - computation and declares a literal value. The resulting parsing is - pretty simple: - </p> + <p>In the <a href="../xref/chapter3/calculator/Calculator1.html"> + <code>Calculator1</code></a> class, we declare various patterns + and actions, that will collaborate and calculate a result based on + the xml file. The simple <em>calculator1.xml</em> file only + creates a computation and declares a literal value. The resulting + parsing is pretty simple: + </p> - <ul> - <li>The <a href="../xref/chapter3/calculator/ComputationAction1.html"> - <code>ComputationAction1</code></a> class' <code>begin()</code> method - is called</li> - <li>The <a href="../xref/chapter3/calculator/LiteralAction.html"> - <code>LiteralAction</code></a> class' <code>begin()</code> and <code>end()</code> - methods are called</li> - <li>The <a href="../xref/chapter3/calculator/ComputationAction1.html"> - <code>ComputationAction1</code></a> class' <code>end()</code> method - is called</li> - </ul> - <p>What is interesting here is the way that the Actions collaborate. - The <code>LiteralAction</code> reads a literal value and pushes it - in the object stack maintained by the - <code>ExecutionContext</code>. Once done, any other action can pop - the value to read or modify it. Here, the <code>end()</code> method - of the <code>ComputationAction1</code> class pops the value from the - stack and prints it. - </p> + <ul> + <li>The <a + href="../xref/chapter3/calculator/ComputationAction1.html"> + <code>ComputationAction1</code></a> class' <code>begin()</code> + method is called</li> + <li>The <a href="../xref/chapter3/calculator/LiteralAction.html"> + <code>LiteralAction</code></a> class' <code>begin()</code> and <code>end()</code> + methods are called</li> + <li>The <a href="../xref/chapter3/calculator/ComputationAction1.html"> + <code>ComputationAction1</code></a> class' <code>end()</code> method + is called</li> + </ul> + + <p>What is interesting here is the way that the Actions + collaborate. The <code>LiteralAction</code> reads a literal value + and pushes it in the object stack maintained by the + <code>InterpretationContext</code>. Once done, any other action + can pop the value to read or modify it. Here, the + <code>end()</code> method of the <code>ComputationAction1</code> + class pops the value from the stack and prints it. + </p> - <p>The <em>calculator2.xml</em> file is a bit more complex, but much - more interesting.</p> + <p>The <em>calculator2.xml</em> file is a bit more complex, but + much more interesting.</p> - <p>It contains the following elements:</p> + <p>It contains the following elements:</p> - <em>Example 3.<span class="autoEx"/>: Calculator configuration file (logback-examples/src/main/java/chapter3/calculator/calculator2.xml)</em> + <em>Example 3.<span class="autoEx"/>: Calculator configuration + file + (logback-examples/src/main/java/chapter3/calculator/calculator2.xml)</em> <div class="source"><pre><computation name="toto"> <literal value="7"/> <literal value="3"/> @@ -326,67 +362,7 @@ by one <code>begin()</code> will be consumed only by the matching <code>end()</code> method.</p> - <a name="newRule"></a> - - <h3>New-rule action</h3> - - <p>Joran includes an action which allows the Joran interpreter to - lean new rules on the fly while interpreting the XML file containing - the new rules. See the - <em>logback-examples/src/main/java/joran/newRule/</em> directory for - sample code. - </p> - - <p>In this package, the <a - href="../xref/chapter3/newRule/NewRuleCalculator.html"> - <code>NewRuleCalculator</code></a> class contains the same setup as - we have seen so far, but for one line:</p> - - <p class="source">ruleStore.addRule(new - Pattern("/computation/new-rule"), new NewRuleAction());</p> - - <p>By adding this line, we ask Joran to allow new rules to be learnt - at parsing time. It works pretty much like the other rules: it has a - <code>begin()</code> and <code>end()</code> method, and is called each time - the parser finds a <em>new-rule</em> element.</p> - - <p>When called, the <code>begin()</code> method looks for a - <em>pattern</em> and a <em>actionClass</em> attribute. The action - class is then instanciated and added to the <code>RuleStore</code>, - along with its corresponding pattern.</p> - - <p>Here is how new rules can be declared in an xml file:</p> - -<div class="source"><pre><new-rule pattern="*/computation/literal" -actionClass="chapter3.calculator.LiteralAction"/></pre></div> - - <p>Using new rule declarations, the preceding example, involving the - calculation, could be expressed this way:</p> - - <em>Example 3.<span class="autoEx"/>: Configuration file using new - rules on the fly - (logback-examples/src/main/java/chapter3/newrule/new-rule.xml)</em> - -<div class="source"><pre><computation name="toto"> - <new-rule pattern="*/computation/literal" - actionClass="chapter3.calculator.LiteralAction"/> - <new-rule pattern="*/computation/add" - actionClass="chapter3.calculator.AddAction"/> - <new-rule pattern="*/computation/multiply" - actionClass="chapter3.calculator.MultiplyAction"/> - - <computation> - <literal value="7"/> - <literal value="3"/> - <add/> - </computation> - - <literal value="3"/> - <multiply/> -</computation></pre></div> - - <a name="implicit"></a> - <h3>Implicit actions </h3> + <h3><a name="implicit" href="#implicit">Implicit actions</a></h3> <p>The rules defined thus far are called explicit rules because they require an explicit pattern, hence fixing the tag name of the @@ -503,12 +479,72 @@ <div class="source"><pre>Element <xyz> asked to be printed. Element <abc> asked to be printed. -ERROR in ch.qos.logback.core.joran.spi.ExecutionContext@1c5c1 - no applicable action \ +ERROR in ch.qos.logback.core.joran.spi.InterpretationContext@1c5c1 - no applicable action \ for <xyz>, current pattern is [/foo/xyz]</pre></div> <p>The last line was printed because of a call to <code>StatusPrinter</code> at the end of the main class.</p> + <a name="newRule"></a> + + <h3>New-rule action</h3> + + <p>Joran includes an action which allows the Joran interpreter to + lean new rules on the fly while interpreting the XML file containing + the new rules. See the + <em>logback-examples/src/main/java/joran/newRule/</em> directory for + sample code. + </p> + + <p>In this package, the <a + href="../xref/chapter3/newRule/NewRuleCalculator.html"> + <code>NewRuleCalculator</code></a> class contains the same setup as + we have seen so far, but for one line:</p> + + <p class="source">ruleStore.addRule(new + Pattern("/computation/new-rule"), new NewRuleAction());</p> + + <p>By adding this line, we ask Joran to allow new rules to be learnt + at parsing time. It works pretty much like the other rules: it has a + <code>begin()</code> and <code>end()</code> method, and is called each time + the parser finds a <em>new-rule</em> element.</p> + + <p>When called, the <code>begin()</code> method looks for a + <em>pattern</em> and a <em>actionClass</em> attribute. The action + class is then instanciated and added to the <code>RuleStore</code>, + along with its corresponding pattern.</p> + + <p>Here is how new rules can be declared in an xml file:</p> + + <p class="source"><new-rule pattern="*/computation/literal" +actionClass="chapter10.calculator.LiteralAction"/></p> + + <p>Using new rule declarations, the preceding example, involving the + calculation, could be expressed this way:</p> + + <em>Example 3.<span class="autoEx"/>: Configuration file using new + rules on the fly + (logback-examples/src/main/java/chapter3/newrule/new-rule.xml)</em> + +<div class="source"><pre><computation name="toto"> + <new-rule pattern="*/computation/literal" + actionClass="chapter3.calculator.LiteralAction"/> + <new-rule pattern="*/computation/add" + actionClass="chapter3.calculator.AddAction"/> + <new-rule pattern="*/computation/multiply" + actionClass="chapter3.calculator.MultiplyAction"/> + + <computation> + <literal value="7"/> + <literal value="3"/> + <add/> + </computation> + + <literal value="3"/> + <multiply/> +</computation></pre></div> + + <h3>Non goals</h3> <p>The Joran API is not intended to be used to parse documents with

1 0

svn commit: r2134 - in logback/trunk/logback-examples/src/main/java: chapter10 chapter10/calculator chapter10/helloWorld chapter10/implicit chapter10/newRule chapter3/calculator chapter3/helloWorld chapter3/implicit chapter3/newRule
by noreply.ceki＠qos.ch 26 Jan '09

26 Jan '09

Author: ceki Date: Mon Jan 26 17:57:29 2009 New Revision: 2134 Added: logback/trunk/logback-examples/src/main/java/chapter10/ logback/trunk/logback-examples/src/main/java/chapter10/calculator/ - copied from r2131, /logback/trunk/logback-examples/src/main/java/chapter3/calculator/ logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/ - copied from r2131, /logback/trunk/logback-examples/src/main/java/chapter3/helloWorld/ logback/trunk/logback-examples/src/main/java/chapter10/implicit/ - copied from r2131, /logback/trunk/logback-examples/src/main/java/chapter3/implicit/ logback/trunk/logback-examples/src/main/java/chapter10/newRule/ - copied from r2131, /logback/trunk/logback-examples/src/main/java/chapter3/newRule/ Removed: logback/trunk/logback-examples/src/main/java/chapter3/calculator/ logback/trunk/logback-examples/src/main/java/chapter3/helloWorld/ logback/trunk/logback-examples/src/main/java/chapter3/implicit/ logback/trunk/logback-examples/src/main/java/chapter3/newRule/ Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/AddAction.java logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator1.java logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator2.java logback/trunk/logback-examples/src/main/java/chapter10/calculator/ComputationAction1.java logback/trunk/logback-examples/src/main/java/chapter10/calculator/ComputationAction2.java logback/trunk/logback-examples/src/main/java/chapter10/calculator/LiteralAction.java logback/trunk/logback-examples/src/main/java/chapter10/calculator/MultiplyAction.java logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/HelloWorld.java logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/HelloWorldAction.java logback/trunk/logback-examples/src/main/java/chapter10/implicit/NOPAction.java logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMe.java logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMeImplicitAction.java logback/trunk/logback-examples/src/main/java/chapter10/newRule/NewRuleCalculator.java Log: Moving joran related examples to chapter 10 Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/AddAction.java ============================================================================== --- /logback/trunk/logback-examples/src/main/java/chapter3/calculator/AddAction.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/AddAction.java Mon Jan 26 17:57:29 2009 @@ -8,7 +8,7 @@ * Software Foundation. */ -package chapter3.calculator; +package chapter10.calculator; Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator1.java ============================================================================== --- /logback/trunk/logback-examples/src/main/java/chapter3/calculator/Calculator1.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator1.java Mon Jan 26 17:57:29 2009 @@ -8,7 +8,7 @@ * Software Foundation. */ -package chapter3.calculator; +package chapter10.calculator; import java.util.HashMap; import java.util.Map; Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator2.java ============================================================================== --- /logback/trunk/logback-examples/src/main/java/chapter3/calculator/Calculator2.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/Calculator2.java Mon Jan 26 17:57:29 2009 @@ -7,7 +7,7 @@ * the terms of the GNU Lesser General Public License as published by the Free * Software Foundation. */ -package chapter3.calculator; +package chapter10.calculator; import java.util.HashMap; import java.util.Map; Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/ComputationAction1.java ============================================================================== --- /logback/trunk/logback-examples/src/main/java/chapter3/calculator/ComputationAction1.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/ComputationAction1.java Mon Jan 26 17:57:29 2009 @@ -8,7 +8,7 @@ * Software Foundation. */ -package chapter3.calculator; +package chapter10.calculator; Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/ComputationAction2.java ============================================================================== --- /logback/trunk/logback-examples/src/main/java/chapter3/calculator/ComputationAction2.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/ComputationAction2.java Mon Jan 26 17:57:29 2009 @@ -8,7 +8,7 @@ * Software Foundation. */ -package chapter3.calculator; +package chapter10.calculator; import java.util.Stack; Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/LiteralAction.java ============================================================================== --- /logback/trunk/logback-examples/src/main/java/chapter3/calculator/LiteralAction.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/LiteralAction.java Mon Jan 26 17:57:29 2009 @@ -8,7 +8,7 @@ * Software Foundation. */ -package chapter3.calculator; +package chapter10.calculator; import org.xml.sax.Attributes; Modified: logback/trunk/logback-examples/src/main/java/chapter10/calculator/MultiplyAction.java ============================================================================== --- /logback/trunk/logback-examples/src/main/java/chapter3/calculator/MultiplyAction.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/calculator/MultiplyAction.java Mon Jan 26 17:57:29 2009 @@ -8,7 +8,7 @@ * Software Foundation. */ -package chapter3.calculator; +package chapter10.calculator; import org.xml.sax.Attributes; Modified: logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/HelloWorld.java ============================================================================== --- /logback/trunk/logback-examples/src/main/java/chapter3/helloWorld/HelloWorld.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/HelloWorld.java Mon Jan 26 17:57:29 2009 @@ -8,7 +8,7 @@ * Software Foundation. */ -package chapter3.helloWorld; +package chapter10.helloWorld; import java.util.HashMap; import java.util.Map; Modified: logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/HelloWorldAction.java ============================================================================== --- /logback/trunk/logback-examples/src/main/java/chapter3/helloWorld/HelloWorldAction.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/helloWorld/HelloWorldAction.java Mon Jan 26 17:57:29 2009 @@ -8,7 +8,7 @@ * Software Foundation. */ -package chapter3.helloWorld; +package chapter10.helloWorld; Modified: logback/trunk/logback-examples/src/main/java/chapter10/implicit/NOPAction.java ============================================================================== --- /logback/trunk/logback-examples/src/main/java/chapter3/implicit/NOPAction.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/implicit/NOPAction.java Mon Jan 26 17:57:29 2009 @@ -1,13 +1,13 @@ /** - * Logback: the reliable, fast and flexible logging library for Java. + * Logback: the generic, reliable, fast and flexible logging framework. * - * Copyright (C) 1999-2006, QOS.ch + * Copyright (C) 2000-2009, QOS.ch * * This library is free software, you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the Free * Software Foundation. */ -package chapter3.implicit; +package chapter10.implicit; import org.xml.sax.Attributes; @@ -15,7 +15,6 @@ import ch.qos.logback.core.joran.spi.InterpretationContext; - /** * No operation (NOP) action that does strictly nothing. * @@ -26,7 +25,6 @@ public void begin(InterpretationContext ec, String name, Attributes attributes) { } - public void end(InterpretationContext ec, String name) { } } Modified: logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMe.java ============================================================================== --- /logback/trunk/logback-examples/src/main/java/chapter3/implicit/PrintMe.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMe.java Mon Jan 26 17:57:29 2009 @@ -7,7 +7,7 @@ * the terms of the GNU Lesser General Public License as published by the Free * Software Foundation. */ -package chapter3.implicit; +package chapter10.implicit; import java.util.ArrayList; import java.util.HashMap; Modified: logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMeImplicitAction.java ============================================================================== --- /logback/trunk/logback-examples/src/main/java/chapter3/implicit/PrintMeImplicitAction.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/implicit/PrintMeImplicitAction.java Mon Jan 26 17:57:29 2009 @@ -8,7 +8,7 @@ * Software Foundation. */ -package chapter3.implicit; +package chapter10.implicit; import org.xml.sax.Attributes; Modified: logback/trunk/logback-examples/src/main/java/chapter10/newRule/NewRuleCalculator.java ============================================================================== --- /logback/trunk/logback-examples/src/main/java/chapter3/newRule/NewRuleCalculator.java (original) +++ logback/trunk/logback-examples/src/main/java/chapter10/newRule/NewRuleCalculator.java Mon Jan 26 17:57:29 2009 @@ -8,7 +8,7 @@ * Software Foundation. */ -package chapter3.newRule; +package chapter10.newRule; import java.util.HashMap; import java.util.Map; @@ -21,7 +21,7 @@ import ch.qos.logback.core.joran.spi.Pattern; import ch.qos.logback.core.util.StatusPrinter; import chapter3.SimpleConfigurator; -import chapter3.calculator.ComputationAction2; +import chapter10.calculator.ComputationAction2; /**

1 0

svn commit: r2133 - logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action
by noreply.ceki＠qos.ch 26 Jan '09

26 Jan '09

Author: ceki Date: Mon Jan 26 17:37:33 2009 New Revision: 2133 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/Action.java Log: - changes in comments Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/Action.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/Action.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/Action.java Mon Jan 26 17:37:33 2009 @@ -1,7 +1,7 @@ /** * Logback: the generic, reliable, fast and flexible logging framework for Java. * - * Copyright (C) 2000-2006, QOS.ch + * Copyright (C) 2000-2009, QOS.ch * * This library is free software, you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the Free @@ -20,9 +20,9 @@ /** * - * Most of the work for configuring log4j is done by Actions. + * Most of the work for configuring logback is done by Actions. * - * <p>Methods of an Action are invoked while an XML file is parsed through. + * <p>Action methods are invoked as the XML file is parsed. * * <p>This class is largely inspired from the relevant class in the * commons-digester project of the Apache Software Foundation.

1 0

svn commit: r2132 - in logback/trunk/logback-site/src/site/pages: . manual
by noreply.ceki＠qos.ch 25 Jan '09

25 Jan '09

Author: ceki Date: Sun Jan 25 19:33:24 2009 New Revision: 2132 Added: logback/trunk/logback-site/src/site/pages/manual/configuration.html - copied, changed from r2131, /logback/trunk/logback-site/src/site/pages/manual/joran.html logback/trunk/logback-site/src/site/pages/manual/onJoran.html - copied, changed from r2131, /logback/trunk/logback-site/src/site/pages/joran.html Removed: logback/trunk/logback-site/src/site/pages/joran.html logback/trunk/logback-site/src/site/pages/manual/joran.html Modified: logback/trunk/logback-site/src/site/pages/.htaccess logback/trunk/logback-site/src/site/pages/documentation.html logback/trunk/logback-site/src/site/pages/manual/.htaccess logback/trunk/logback-site/src/site/pages/manual/index.html logback/trunk/logback-site/src/site/pages/manual/menu.js Log: - rearranging the chapter on Joran (it is now part of the manual) Modified: logback/trunk/logback-site/src/site/pages/.htaccess ============================================================================== --- logback/trunk/logback-site/src/site/pages/.htaccess (original) +++ logback/trunk/logback-site/src/site/pages/.htaccess Sun Jan 25 19:33:24 2009 @@ -1 +1,2 @@ -Redirect jmxConfig.html http://logback.qos.ch/manual/jmxConfig.html \ No newline at end of file +Redirect jmxConfig.html http://logback.qos.ch/manual/jmxConfig.html +Redirect joran.html http://logback.qos.ch/manual/onJoran.html \ No newline at end of file Modified: logback/trunk/logback-site/src/site/pages/documentation.html ============================================================================== --- logback/trunk/logback-site/src/site/pages/documentation.html (original) +++ logback/trunk/logback-site/src/site/pages/documentation.html Sun Jan 25 19:33:24 2009 @@ -40,10 +40,6 @@ </li> <li> - <a href="joran.html">Using Joran in your applications</a> - </li> - - <li> <a href="demo.html">Walk-through logback-demo webApp</a> </li> <li> Modified: logback/trunk/logback-site/src/site/pages/manual/.htaccess ============================================================================== --- logback/trunk/logback-site/src/site/pages/manual/.htaccess (original) +++ logback/trunk/logback-site/src/site/pages/manual/.htaccess Sun Jan 25 19:33:24 2009 @@ -1 +1,2 @@ -Redirect contextSelector.html http://logback.qos.ch/manual/loggingSeparation.html \ No newline at end of file +Redirect contextSelector.html http://logback.qos.ch/manual/loggingSeparation.html +Redirect joran.html http://logback.qos.ch/manual/configuration.html \ No newline at end of file Copied: logback/trunk/logback-site/src/site/pages/manual/configuration.html (from r2131, /logback/trunk/logback-site/src/site/pages/manual/joran.html) ============================================================================== --- /logback/trunk/logback-site/src/site/pages/manual/joran.html (original) +++ logback/trunk/logback-site/src/site/pages/manual/configuration.html Sun Jan 25 19:33:24 2009 @@ -4,7 +4,7 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" /> - <title>Chapter3: Logback configuration & Joran</title> + <title>Chapter3: Logback configuration</title> <link rel="stylesheet" type="text/css" href="../css/common.css" /> <link rel="stylesheet" type="text/css" href="../css/screen.css" media="screen" /> @@ -21,7 +21,7 @@ </div> <div id="content" class="chapter"> - <h1>Chapter 3: Logback configuration & Joran</h1> + <h1>Chapter 3: Logback configuration</h1> <div class="quote"> <p><em>In symbols one observes an advantage in discovery which Modified: logback/trunk/logback-site/src/site/pages/manual/index.html ============================================================================== --- logback/trunk/logback-site/src/site/pages/manual/index.html (original) +++ logback/trunk/logback-site/src/site/pages/manual/index.html Sun Jan 25 19:33:24 2009 @@ -36,7 +36,7 @@ <li><p>logback configuration scripts in XML format</p></li> <li><p>appenders</p></li> <li><p>layouts</p></li> - <li><p>filter chains</p></li> + <li><p>filters</p></li> <li><p>mapped diagnostic contexts</p></li> <li><p>logback default initialization</p></li> <li><p>logback in Servlet Containers</p></li> @@ -81,7 +81,7 @@ <a href="architecture.html"><b>Chapter 2: Architecture</b></a> </p></li> <li><p> - <a href="joran.html"><b>Chapter 3: Logback configuration with Joran</b></a> + <a href="configuration.html"><b>Chapter 3: Configuration</b></a> </p></li> <li><p> @@ -107,6 +107,11 @@ <li><p> <a href="jmxConfigurator.html"><b>Chapter 9: JMX Configurator</b></a> </p></li> + + <li><p> + <a href="onJoran.html"><b>Chapter 10: Joran</b></a> + </p></li> + </ul> </div> Modified: logback/trunk/logback-site/src/site/pages/manual/menu.js ============================================================================== --- logback/trunk/logback-site/src/site/pages/manual/menu.js (original) +++ logback/trunk/logback-site/src/site/pages/manual/menu.js Sun Jan 25 19:33:24 2009 @@ -2,10 +2,11 @@ document.write('<p class="menu_header">Chapter Index</p>') document.write('<p class="menu"><a href="introduction.html"><b>Ch1: Introduction to logback</b></a></p>'); document.write('<p class="menu"><a href="architecture.html"><b>Ch2: Architecture</b></a>'); -document.write('<p class="menu"><a href="joran.html"><b>Ch3: Logback configuration with Joran</b></a>'); +document.write('<p class="menu"><a href="configuration.html"><b>Ch3: Configuration</b></a>'); document.write('<p class="menu"><a href="appenders.html"><b>Ch4: Appenders</b></a>'); document.write('<p class="menu"><a href="layouts.html"><b>Ch5: Layouts</b></a>'); document.write('<p class="menu"><a href="filters.html"><b>Ch6: Filter chains</b></a>'); document.write('<p class="menu"><a href="mdc.html"><b>Ch7: Mapped Diagnostic Contexts</b></a>'); document.write('<p class="menu"><a href="loggingSeparation.html"><b>Ch8: Logging Separation</b></a>'); document.write('<p class="menu"><a href="jmxConfig.html"><b>Ch9: JMX Configurator</b></a>'); +document.write('<p class="menu"><a href="onJoran.html"><b>Ch9: Joran</b></a>'); Copied: logback/trunk/logback-site/src/site/pages/manual/onJoran.html (from r2131, /logback/trunk/logback-site/src/site/pages/joran.html) ============================================================================== --- /logback/trunk/logback-site/src/site/pages/joran.html (original) +++ logback/trunk/logback-site/src/site/pages/manual/onJoran.html Sun Jan 25 19:33:24 2009 @@ -4,25 +4,30 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" /> - <title>Using Joran</title> - <link rel="stylesheet" type="text/css" href="css/common.css" /> - <link rel="stylesheet" type="text/css" href="css/screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="css/_print.css" media="print" /> + <title>Joran</title> + <link rel="stylesheet" type="text/css" href="../css/common.css" /> + <link rel="stylesheet" type="text/css" href="../css/screen.css" media="screen" /> + <link rel="stylesheet" type="text/css" href="../css/_print.css" media="print" /> </head> <body> - <script type="text/javascript">prefix='./'</script> - <script type="text/javascript" src="templates/header.js"></script> + <script type="text/javascript"> + prefix='../'; + </script> + <script src="../templates/header.js" type="text/javascript"></script> <div id="left"> - <script type="text/javascript" src="templates/left.js"></script> + <script src="../templates/left.js" type="text/javascript"></script> + </div> + <div id="right"> + <script src="menu.js" type="text/javascript"></script> </div> <div id="content"> - <h2>Using Joran in your own applications</h2> + <h2>Joran in your own applications</h2> <p>As we've seen, logback relies on Joran, a mature, flexible and powerful configuration framework. Many of the capabilities offered - by logback modules are possible with the help of Joran. + by logback modules are only possible on account of Joran. </p> <p>Joran is actually a generic configuration system which can be

1 0