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

svn commit: r755 - logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action
by noreply.ceki＠qos.ch 24 Oct '06

24 Oct '06

Author: ceki Date: Tue Oct 24 15:18:02 2006 New Revision: 755 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedComponentIA.java Log: - fixed bug where the pattern "a/b/*" incorrectly matched "a/other". - also fixed bug whereby if there was no object at the top of the stack, NestedComponentIA and NestedSimplePropertyIA would barf with an EmptryStackException Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedComponentIA.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedComponentIA.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedComponentIA.java Tue Oct 24 15:18:02 2006 @@ -48,6 +48,11 @@ //LogLog.debug("in NestComponentIA.isApplicable <" + pattern + ">"); String nestedElementTagName = pattern.peekLast(); + // calling ec.peekObject with an empty stack will throw an exception + if(ec.isEmpty()) { + return false; + } + Object o = ec.peekObject(); PropertySetter parentBean = new PropertySetter(o);

1 0

svn commit: r754 - in logback/trunk/logback-core/src: main/java/ch/qos/logback/core/joran/action main/java/ch/qos/logback/core/joran/spi test/java/ch/qos/logback/core/joran/replay test/java/ch/qos/logback/core/joran/spi
by noreply.ceki＠qos.ch 24 Oct '06

24 Oct '06

Author: ceki Date: Tue Oct 24 15:16:58 2006 New Revision: 754 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedSimplePropertyIA.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/InterpretationContext.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/SimpleRuleStore.java logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/replay/FruitConfigurationTest.java logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/spi/PatternTest.java logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/spi/SimpleStoreTest.java Log: - fixed bug where the pattern "a/b/*" incorrectly matched "a/other". - also fixed bug whereby if there was no object at the top of the stack, NestedComponentIA and NestedSimplePropertyIA would barf with an EmptryStackException Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedSimplePropertyIA.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedSimplePropertyIA.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedSimplePropertyIA.java Tue Oct 24 15:16:58 2006 @@ -45,6 +45,11 @@ //LogLog.debug("in NestComponentIA.isApplicable <" + pattern + ">"); String nestedElementTagName = pattern.peekLast(); + // no point in attempting if there is no parent object + if(ec.isEmpty()) { + return false; + } + Object o = ec.peekObject(); PropertySetter parentBean = new PropertySetter(o); Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/InterpretationContext.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/InterpretationContext.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/spi/InterpretationContext.java Tue Oct 24 15:16:58 2006 @@ -71,6 +71,10 @@ return objectStack; } + public boolean isEmpty() { + return objectStack.isEmpty(); + } + public Object peekObject() { return objectStack.peek(); } 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 Oct 24 15:16:58 2006 @@ -154,7 +154,8 @@ String l = (String) this.components.get(i); String r = (String) p.components.get(i); - if (l.equals(r) || "*".equals(l) || "*".equals(r)) { + //if (l.equals(r) || "*".equals(l) || "*".equals(r)) { + if (l.equals(r)) { match++; } else { break; 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 Oct 24 15:16:58 2006 @@ -82,6 +82,7 @@ } else if ( (actionList = tailMatch(currentPattern)) != null){ return actionList; } else if ((actionList = prefixMatch(currentPattern)) != null) { + //System.out.println(currentPattern + " prefixMatches "+actionList); return actionList; } else { return null; @@ -121,9 +122,11 @@ String last = p.peekLast(); if("*".equals(last)) { int r = currentPattern.getPrefixMatchLength(p); - - //System.out.println("prefixMatch " +r); - if (r > max) { + + //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); max = r; longestMatchingPattern = p; Modified: logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/replay/FruitConfigurationTest.java ============================================================================== --- logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/replay/FruitConfigurationTest.java (original) +++ logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/replay/FruitConfigurationTest.java Tue Oct 24 15:16:58 2006 @@ -8,6 +8,7 @@ import junit.framework.TestSuite; import ch.qos.logback.core.joran.action.Action; import ch.qos.logback.core.joran.action.NOPAction; +import ch.qos.logback.core.joran.spi.JoranException; import ch.qos.logback.core.joran.spi.Pattern; import ch.qos.logback.core.util.Constants; import ch.qos.logback.core.util.StatusPrinter; @@ -30,19 +31,24 @@ public List<FruitShell> doFirstPart(String filename) throws Exception { - HashMap<Pattern, Action> rulesMap = new HashMap<Pattern, Action>(); - rulesMap.put(new Pattern("group/fruitShell"), new FruitShellAction()); - rulesMap.put(new Pattern("group/fruitShell/fruit"), new FruitFactoryAction()); - rulesMap.put(new Pattern("group/fruitShell/fruit/*"), new NOPAction()); - SimpleConfigurator simpleConfigurator = new SimpleConfigurator(rulesMap); - - simpleConfigurator.setContext(fruitContext); - - simpleConfigurator.doConfigure(Constants.TEST_DIR_PREFIX + "input/joran/" + filename); - - StatusPrinter.print(fruitContext); - return fruitContext.getFruitShellList(); - + try { + HashMap<Pattern, Action> rulesMap = new HashMap<Pattern, Action>(); + rulesMap.put(new Pattern("group/fruitShell"), new FruitShellAction()); + rulesMap.put(new Pattern("group/fruitShell/fruit"), + new FruitFactoryAction()); + rulesMap.put(new Pattern("group/fruitShell/fruit/*"), new NOPAction()); + SimpleConfigurator simpleConfigurator = new SimpleConfigurator(rulesMap); + + simpleConfigurator.setContext(fruitContext); + + simpleConfigurator.doConfigure(Constants.TEST_DIR_PREFIX + "input/joran/" + + filename); + + return fruitContext.getFruitShellList(); + } catch (Exception je) { + StatusPrinter.print(fruitContext); + throw je; + } } public void test1() throws Exception { @@ -69,7 +75,7 @@ Fruit fruit0 = fs0.fruitFactory.buildFruit(); assertTrue(fruit0 instanceof Fruit); assertEquals("blue", fruit0.getName()); - + FruitShell fs1 = fsList.get(1); assertNotNull(fs1); assertEquals("fs1", fs1.getName()); @@ -78,7 +84,7 @@ assertEquals("orange", fruit1.getName()); assertEquals(1.2, ((WeightytFruit) fruit1).getWeight()); } - + public void testWithSubst() throws Exception { List<FruitShell> fsList = doFirstPart("fruitWithSubst.xml"); assertNotNull(fsList); @@ -90,13 +96,13 @@ int oldCount = FruitFactory.count; Fruit fruit0 = fs0.fruitFactory.buildFruit(); assertTrue(fruit0 instanceof WeightytFruit); - assertEquals("orange-"+oldCount, fruit0.getName()); + assertEquals("orange-" + oldCount, fruit0.getName()); assertEquals(1.2, ((WeightytFruit) fruit0).getWeight()); } - + public static Test suite() { TestSuite suite = new TestSuite(); - //suite.addTest(new FruitConfigurationTest("testWithSubst")); + // suite.addTest(new FruitConfigurationTest("testWithSubst")); suite.addTestSuite(FruitConfigurationTest.class); return suite; } Modified: logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/spi/PatternTest.java ============================================================================== --- logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/spi/PatternTest.java (original) +++ logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/spi/PatternTest.java Tue Oct 24 15:16:58 2006 @@ -132,7 +132,7 @@ { Pattern p = new Pattern("/a/b"); Pattern rulePattern = new Pattern("/a/*"); - assertEquals(2, p.getPrefixMatchLength(rulePattern)); + assertEquals(1, p.getPrefixMatchLength(rulePattern)); } { @@ -144,7 +144,7 @@ { Pattern p = new Pattern("/a/b"); Pattern rulePattern = new Pattern("/*"); - assertEquals(1, p.getPrefixMatchLength(rulePattern)); + assertEquals(0, p.getPrefixMatchLength(rulePattern)); } } Modified: logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/spi/SimpleStoreTest.java ============================================================================== --- logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/spi/SimpleStoreTest.java (original) +++ logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/spi/SimpleStoreTest.java Tue Oct 24 15:16:58 2006 @@ -72,14 +72,13 @@ // jp.parse(doc); } - public void test2() throws Exception { + public void testTail1() throws Exception { SimpleRuleStore srs = new SimpleRuleStore(new ContextBase()); srs.addRule(new Pattern("*/b"), new XAction()); List r = srs.matchActions(new Pattern("a/b")); assertNotNull(r); - // System.out.println(r); assertEquals(1, r.size()); if (!(r.get(0) instanceof XAction)) { @@ -87,7 +86,22 @@ } } - public void test3() throws Exception { + + public void testTail2() throws Exception { + SimpleRuleStore srs = new SimpleRuleStore(new ContextBase()); + srs.addRule(new Pattern("*/c"), new XAction()); + + List r = srs.matchActions(new Pattern("a/b/c")); + assertNotNull(r); + + assertEquals(1, r.size()); + + if (!(r.get(0) instanceof XAction)) { + fail("Wrong type"); + } + } + + public void testTail3() throws Exception { SimpleRuleStore srs = new SimpleRuleStore(new ContextBase()); srs.addRule(new Pattern("*/b"), new XAction()); srs.addRule(new Pattern("*/a/b"), new YAction()); @@ -103,7 +117,7 @@ } } - public void test4() throws Exception { + public void testTail4() throws Exception { SimpleRuleStore srs = new SimpleRuleStore(new ContextBase()); srs.addRule(new Pattern("*/b"), new XAction()); srs.addRule(new Pattern("*/a/b"), new YAction()); @@ -127,16 +141,55 @@ List r = srs.matchActions(new Pattern("a/b")); assertNotNull(r); + assertEquals(1, r.size()); + assertTrue(r.get(0) instanceof YAction); + } + + public void testDeepSuffix() throws Exception { + SimpleRuleStore srs = new SimpleRuleStore(new ContextBase()); + srs.addRule(new Pattern("a"), new XAction(1)); + srs.addRule(new Pattern("a/b/*"), new XAction(2)); + + List r = srs.matchActions(new Pattern("a/other")); + assertNull(r); + } + + public void testPrefixSuffixInteraction1() throws Exception { + SimpleRuleStore srs = new SimpleRuleStore(new ContextBase()); + srs.addRule(new Pattern("a"), new ZAction()); + srs.addRule(new Pattern("a/*"), new YAction()); + srs.addRule(new Pattern("*/a/b"), new XAction(3)); + + List r = srs.matchActions(new Pattern("a/b")); + assertNotNull(r); assertEquals(1, r.size()); + + assertTrue(r.get(0) instanceof XAction); + XAction xaction = (XAction) r.get(0); + assertEquals(3, xaction.id); + } - if (!(r.get(0) instanceof YAction)) { - fail("Wrong type"); - } + public void testPrefixSuffixInteraction2() throws Exception { + SimpleRuleStore srs = new SimpleRuleStore(new ContextBase()); + srs.addRule(new Pattern("testGroup"), new XAction()); + srs.addRule(new Pattern("testGroup/testShell"), new YAction()); + srs.addRule(new Pattern("testGroup/testShell/test"), new ZAction()); + srs.addRule(new Pattern("testGroup/testShell/test/*"), new XAction(9)); + + List r = srs.matchActions(new Pattern("testGroup/testShell/toto")); + System.out.println(r); + assertNull(r); } - class XAction extends Action { + int id = 0; + XAction() { + } + XAction(int id) { + this.id = id; + } + public void begin(InterpretationContext ec, String name, Attributes attributes) { } @@ -145,6 +198,10 @@ public void finish(InterpretationContext ec) { } + + public String toString() { + return "XAction("+id+")"; + } } class YAction extends Action { @@ -168,4 +225,5 @@ public void finish(InterpretationContext ec) { } } + }

1 0

svn commit: r753 - in logback/trunk/logback-core/src/main/java/ch/qos/logback/core: joran/action util
by noreply.seb＠qos.ch 24 Oct '06

24 Oct '06

Author: seb Date: Tue Oct 24 14:08:05 2006 New Revision: 753 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedComponentIA.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util/PropertySetter.java Log: - added getObj() to PropertySetter Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedComponentIA.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedComponentIA.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/joran/action/NestedComponentIA.java Tue Oct 24 14:08:05 2006 @@ -122,14 +122,22 @@ return; } +// PropertySetter nestedBean = new PropertySetter(actionData.nestedComponent); + +// FIXME +// nestedBean.setComponent( +// "parent", actionData.parentBean.getObj()); + if (actionData.nestedComponent instanceof LifeCycle) { ((LifeCycle) actionData.nestedComponent).start(); } + + Object o = ec.peekObject(); if (o != actionData.nestedComponent) { - addWarn( + addError( "The object on the top the of the stack is not the component pushed earlier."); } else { //getLogger().debug("Removing component from the object stack"); Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util/PropertySetter.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util/PropertySetter.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util/PropertySetter.java Tue Oct 24 14:08:05 2006 @@ -395,4 +395,8 @@ return null; } + + public Object getObj() { + return obj; + } }

1 0

svn commit: r752 - logback/trunk/logback-site/src/site/resources
by noreply.ceki＠qos.ch 24 Oct '06

24 Oct '06

Author: ceki Date: Tue Oct 24 08:11:42 2006 New Revision: 752 Modified: logback/trunk/logback-site/src/site/resources/10reasons.ppt Log: ongoinmg work Modified: logback/trunk/logback-site/src/site/resources/10reasons.ppt ============================================================================== Binary files. No diff available.

1 0

svn commit: r751 - logback/trunk/logback-site/src/site/resources
by noreply.ceki＠qos.ch 24 Oct '06

24 Oct '06

Author: ceki Date: Tue Oct 24 08:01:13 2006 New Revision: 751 Added: logback/trunk/logback-site/src/site/resources/slf4j-slides.vsd (contents, props changed) Modified: logback/trunk/logback-site/src/site/resources/10reasons.ppt Log: ongoinmg work Modified: logback/trunk/logback-site/src/site/resources/10reasons.ppt ============================================================================== Binary files. No diff available. Added: logback/trunk/logback-site/src/site/resources/slf4j-slides.vsd ============================================================================== Binary file. No diff available.

1 0

svn commit: r750 - in logback/trunk/logback-site/src/site: resources xdocTemplates
by noreply.ceki＠qos.ch 23 Oct '06

23 Oct '06

Author: ceki Date: Mon Oct 23 23:08:53 2006 New Revision: 750 Modified: logback/trunk/logback-site/src/site/resources/10reasons.ppt logback/trunk/logback-site/src/site/xdocTemplates/index.xml Log: ongoing work Modified: logback/trunk/logback-site/src/site/resources/10reasons.ppt ============================================================================== Binary files. No diff available. Modified: logback/trunk/logback-site/src/site/xdocTemplates/index.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/index.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/index.xml Mon Oct 23 23:08:53 2006 @@ -16,11 +16,11 @@ </p> <p>On the 5th of December, Ceki Gülcü will be presenting - (in French) top 10 reasons for migrating your projects to - logback. Issues such as migration strategy, new APIs, SLF4J and - Joran will be discussed. Emphasis will be given to practical - aspects and a live demo rather than relatively theoretical - considerations. + (in French) top <a href="10reasons.ppt"><b>10 reasons for + migrating</b></a> your projects to logback. Issues such as + migration strategy, new APIs, SLF4J and Joran will be + discussed. Emphasis will be given to practical aspects and a live + demo rather than relatively theoretical considerations. </p> <p>This <a href=" http://tinyurl.com/yjcq33">free-entry event</a>

1 0

svn commit: r749 - logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/replay
by noreply.seb＠qos.ch 23 Oct '06

23 Oct '06

Author: seb Date: Mon Oct 23 22:06:43 2006 New Revision: 749 Modified: logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/replay/FruitConfigurationTest.java Log: bug fix Modified: logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/replay/FruitConfigurationTest.java ============================================================================== --- logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/replay/FruitConfigurationTest.java (original) +++ logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/replay/FruitConfigurationTest.java Mon Oct 23 22:06:43 2006 @@ -87,16 +87,17 @@ FruitShell fs0 = fsList.get(0); assertNotNull(fs0); assertEquals("fs0", fs0.getName()); + int oldCount = FruitFactory.count; Fruit fruit0 = fs0.fruitFactory.buildFruit(); assertTrue(fruit0 instanceof WeightytFruit); - assertEquals("orange-0", fruit0.getName()); + assertEquals("orange-"+oldCount, fruit0.getName()); assertEquals(1.2, ((WeightytFruit) fruit0).getWeight()); } public static Test suite() { TestSuite suite = new TestSuite(); - suite.addTest(new FruitConfigurationTest("testWithSubst")); - //suite.addTestSuite(FruitConfigurationTest.class); + //suite.addTest(new FruitConfigurationTest("testWithSubst")); + suite.addTestSuite(FruitConfigurationTest.class); return suite; } }

1 0

svn commit: r748 - logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling
by noreply.seb＠qos.ch 23 Oct '06

23 Oct '06

Author: seb Date: Mon Oct 23 20:56:22 2006 New Revision: 748 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/FixedWindowRollingPolicy.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingFileAppender.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingPolicyBase.java Log: fooling around Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/FixedWindowRollingPolicy.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/FixedWindowRollingPolicy.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/FixedWindowRollingPolicy.java Mon Oct 23 20:56:22 2006 @@ -67,7 +67,6 @@ public FixedWindowRollingPolicy() { minIndex = 1; maxIndex = 7; - activeFileName = null; } public void start() { Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingFileAppender.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingFileAppender.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingFileAppender.java Mon Oct 23 20:56:22 2006 @@ -60,7 +60,7 @@ * @since 1.3 * */ public class RollingFileAppender extends FileAppender { - File activeFile; + File activeFileCache; TriggeringPolicy triggeringPolicy; RollingPolicy rollingPolicy; @@ -80,12 +80,11 @@ if (rollingPolicy != null) { String afn = rollingPolicy.getActiveFileName(); - activeFile = new File(afn); + // the activeFile variable is used by the triggeringPolicy.isTriggeringEvent method + activeFileCache = new File(afn); addInfo("Active log file name: "+afn); setFile(afn); - - // the activeFile variable is used by the triggeringPolicy.isTriggeringEvent method - activeFile = new File(afn); + super.start(); } else { addWarn("No RollingPolicy was set for the RollingFileAppender named "+ getName()); @@ -132,7 +131,7 @@ addInfo("Active file name is now ["+ fileName+"]."); // the activeFile variable is used by the triggeringPolicy.isTriggeringEvent method - activeFile = new File(fileName); + ////activeFile = new File(fileName); try { // This will also close the file. This is OK since multiple @@ -151,7 +150,7 @@ protected void subAppend(Object event) { // The roll-over check must precede actual writing. This is the // only correct behavior for time driven triggers. - if (triggeringPolicy.isTriggeringEvent(activeFile, event)) { + if (triggeringPolicy.isTriggeringEvent(activeFileCache, event)) { rollover(); } Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingPolicyBase.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingPolicyBase.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingPolicyBase.java Mon Oct 23 20:56:22 2006 @@ -26,7 +26,7 @@ protected int compressionMode = Compress.NONE; protected FileNamePattern fileNamePattern; protected String fileNamePatternStr; - protected String activeFileName; + protected String activeFileName = null; private boolean started;

1 0

svn commit: r747 - logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling
by noreply.ceki＠qos.ch 23 Oct '06

23 Oct '06

Author: ceki Date: Mon Oct 23 20:54:28 2006 New Revision: 747 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingPolicyBase.java logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/TimeBasedRollingPolicy.java Log: Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingPolicyBase.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingPolicyBase.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/RollingPolicyBase.java Mon Oct 23 20:54:28 2006 @@ -78,5 +78,9 @@ public void stop() { started = false; } + + public String getActiveFileName() { + return activeFileName; + } } Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/TimeBasedRollingPolicy.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/TimeBasedRollingPolicy.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/rolling/TimeBasedRollingPolicy.java Mon Oct 23 20:54:28 2006 @@ -255,6 +255,7 @@ * as computed by the <b>FileNamePattern</b> option. * */ + @Override public String getActiveFileName() { if (activeFileName == null) { return activeFileNamePattern.convertDate(lastCheck);

1 0

svn commit: r746 - in logback/trunk: logback-classic/examples/src/chapter5 logback-site/src/site/resources/manual logback-site/src/site/resources/manual/images logback-site/src/site/resources/manual/images/chapter5 logback-site/src/site/xdocTemplates/manual
by noreply.seb＠qos.ch 23 Oct '06

23 Oct '06

Author: seb Date: Mon Oct 23 20:06:31 2006 New Revision: 746 Added: logback/trunk/logback-classic/examples/src/chapter5/MySampleLayout.java logback/trunk/logback-classic/examples/src/chapter5/MySampleLayout2.java logback/trunk/logback-classic/examples/src/chapter5/SampleLogging.java logback/trunk/logback-classic/examples/src/chapter5/sampleLayoutConfig.xml logback/trunk/logback-classic/examples/src/chapter5/sampleLayoutConfig2.xml logback/trunk/logback-site/src/site/resources/manual/ logback/trunk/logback-site/src/site/resources/manual/images/ logback/trunk/logback-site/src/site/resources/manual/images/chapter5/ (props changed) logback/trunk/logback-site/src/site/resources/manual/images/chapter5/htmlLayout1.gif (contents, props changed) Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml Log: Work in progress Added: logback/trunk/logback-classic/examples/src/chapter5/MySampleLayout.java ============================================================================== --- (empty file) +++ logback/trunk/logback-classic/examples/src/chapter5/MySampleLayout.java Mon Oct 23 20:06:31 2006 @@ -0,0 +1,27 @@ +package chapter5; + +import ch.qos.logback.classic.ClassicLayout; +import ch.qos.logback.classic.spi.LoggingEvent; +import ch.qos.logback.core.LayoutBase; + +public class MySampleLayout extends LayoutBase implements ClassicLayout { + + public String doLayout(LoggingEvent event) { + StringBuffer sbuf = new StringBuffer(128); + sbuf.append(event.getTimeStamp() - LoggingEvent.getStartTime()); + sbuf.append(" "); + sbuf.append(event.getLevel()); + sbuf.append(" ["); + sbuf.append(event.getThreadName()); + sbuf.append("] "); + sbuf.append(event.getLoggerRemoteView().getName()); + sbuf.append(" - "); + sbuf.append(event.getFormattedMessage()); + sbuf.append(LINE_SEP); + return sbuf.toString(); + } + + public String doLayout(Object event) { + return doLayout((LoggingEvent)event); + } +} \ No newline at end of file Added: logback/trunk/logback-classic/examples/src/chapter5/MySampleLayout2.java ============================================================================== --- (empty file) +++ logback/trunk/logback-classic/examples/src/chapter5/MySampleLayout2.java Mon Oct 23 20:06:31 2006 @@ -0,0 +1,45 @@ +package chapter5; + +import ch.qos.logback.classic.ClassicLayout; +import ch.qos.logback.classic.spi.LoggingEvent; +import ch.qos.logback.core.LayoutBase; + +public class MySampleLayout2 extends LayoutBase implements ClassicLayout { + + String prefix = null; + boolean printThreadName = true; + + public void setPrefix(String prefix) { + this.prefix = prefix; + } + + public void setPrintThreadName(String printThreadName) { + this.printThreadName = printThreadName.equals("true"); + } + + public String doLayout(LoggingEvent event) { + StringBuffer sbuf = new StringBuffer(128); + if (prefix != null) { + sbuf.append(prefix + ": "); + } + sbuf.append(event.getTimeStamp() - LoggingEvent.getStartTime()); + sbuf.append(" "); + sbuf.append(event.getLevel()); + if (printThreadName) { + sbuf.append(" ["); + sbuf.append(event.getThreadName()); + sbuf.append("] "); + } else { + sbuf.append(" "); + } + sbuf.append(event.getLoggerRemoteView().getName()); + sbuf.append(" - "); + sbuf.append(event.getFormattedMessage()); + sbuf.append(LINE_SEP); + return sbuf.toString(); + } + + public String doLayout(Object event) { + return doLayout((LoggingEvent) event); + } +} \ No newline at end of file Added: logback/trunk/logback-classic/examples/src/chapter5/SampleLogging.java ============================================================================== --- (empty file) +++ logback/trunk/logback-classic/examples/src/chapter5/SampleLogging.java Mon Oct 23 20:06:31 2006 @@ -0,0 +1,31 @@ +package chapter5; + +import org.slf4j.LoggerFactory; + +import ch.qos.logback.classic.Logger; +import ch.qos.logback.classic.LoggerContext; +import ch.qos.logback.classic.joran.JoranConfigurator; +import ch.qos.logback.core.joran.spi.JoranException; +import ch.qos.logback.core.util.StatusPrinter; + +public class SampleLogging { + + public static void main(String[] args) { + Logger logger = (Logger) LoggerFactory + .getLogger(SampleLogging.class); + LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory(); + + try { + JoranConfigurator configurator = new JoranConfigurator(); + configurator.setContext(lc); + configurator.doConfigure(args[0]); + } catch (JoranException je) { + StatusPrinter.print(lc); + } + + logger.debug("Everything's going well"); + + logger.error("... not quite"); + } + +} Added: logback/trunk/logback-classic/examples/src/chapter5/sampleLayoutConfig.xml ============================================================================== --- (empty file) +++ logback/trunk/logback-classic/examples/src/chapter5/sampleLayoutConfig.xml Mon Oct 23 20:06:31 2006 @@ -0,0 +1,12 @@ +<configuration> + + <appender name="STDOUT" + class="ch.qos.logback.core.ConsoleAppender"> + <layout class="chapter5.MySampleLayout" /> + </appender> + + <root> + <level value="debug" /> + <appender-ref ref="STDOUT" /> + </root> +</configuration> \ No newline at end of file Added: logback/trunk/logback-classic/examples/src/chapter5/sampleLayoutConfig2.xml ============================================================================== --- (empty file) +++ logback/trunk/logback-classic/examples/src/chapter5/sampleLayoutConfig2.xml Mon Oct 23 20:06:31 2006 @@ -0,0 +1,15 @@ +<configuration> + + <appender name="STDOUT" + class="ch.qos.logback.core.ConsoleAppender"> + <layout class="chapter5.MySampleLayout2"> + <prefix>MyContext</prefix> + <printThreadName>false</printThreadName> + </layout> + </appender> + + <root> + <level value="debug" /> + <appender-ref ref="STDOUT" /> + </root> +</configuration> \ No newline at end of file Added: logback/trunk/logback-site/src/site/resources/manual/images/chapter5/htmlLayout1.gif ============================================================================== Binary file. No diff available. Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml Mon Oct 23 20:06:31 2006 @@ -66,11 +66,12 @@ }</pre></div> <p> This interface is rather simple and yet is sufficent for - many formatting needs. + many formatting needs. The Texan developer from Texas, + who you might know from Joseph Heller's <em>Catch-22</em>, + might exclaim: + it just takes two methods to implement a layout!!? </p> -  - <h2>Logback classic</h2> <p> @@ -91,6 +92,125 @@ }</pre></div> + <h3>Writing your own Layout</h3> + <p> + Let us implement a simple and functional layout for the + classic module which prints the time elapsed since the start + of the application, the level of the logging event, the + caller thread between brackets, its logger name, a dash followed + by the event message and a new line. + </p> + <p>Sample output might look like:</p> + <div class="source">10489 DEBUG [main] com.marsupial.Pouch - Hello world.</div> + + <p>Here is a possible implementation, authored by the Texan developer:</p> + <em>Example 5.0: Sample implementation of a Layout + (examples/chapter5/MySampleLayout.java)</em> + <div class="source"><pre>package chapter5; + +import ch.qos.logback.classic.ClassicLayout; +import ch.qos.logback.classic.spi.LoggingEvent; +import ch.qos.logback.core.LayoutBase; + +public class MySampleLayout extends LayoutBase implements ClassicLayout { + + public String doLayout(LoggingEvent event) { + StringBuffer sbuf = new StringBuffer(128); + sbuf.append(event.getTimeStamp() - LoggingEvent.getStartTime()); + sbuf.append(" "); + sbuf.append(event.getLevel()); + sbuf.append(" ["); + sbuf.append(event.getThreadName()); + sbuf.append("] "); + sbuf.append(event.getLoggerRemoteView().getName()); + sbuf.append(" - "); + sbuf.append(event.getFormattedMessage()); + sbuf.append(LINE_SEP); + return sbuf.toString(); + } + + public String doLayout(Object event) { + return doLayout((LoggingEvent)event); + } +}</pre></div> + + <p> + Note that + <code>MySampleLayout</code> + extends <code>LayoutBase</code>. + This class manages trivial components of a <code>Layout</code> + such as started or stopped status, header, footer and + content type access or logging context awareness. It allows + the developer to concentrate on the formatting she expects + from her <code>Layout</code>. + </p> + + <p><code>MySampleLayout</code> implements the <code>ClassicLayout</code> + interface, since it is intented to be used with the classic module. + Therefore, it offers a trivial implementation of the + <code>doLayout(Object event)</code> method, that only casts the event + in the right type and passes it to the method where the actual formatting + takes place.</p> + + <p>The marginally more interesting <code>doLayout(LoggingEvent event)</code> + method begins by instantiating a StringBuffer. It proceeds by adding various + fields of the event parameter. The Texan from Texas was careful to print + the formatted form of the message and not its object form. + This allows for logging requests which are passed object arrays to + build the message in its proper form. + </p> + <p> + In the previous listing of the <code>Layout</code> class, + we had omitted the class static <code>LINE_SEP</code> + field which is simply assigned the value returned by + <code>System.getProperty("line.separator")</code> + method. After adding system dependent line separator + character(s), the format method returns the string buffer as + a String. + </p> + <p> + The format method ignores any eventual exceptions contained + in the event, leaving the task of handling throwables to the + containing appender. + </p> + + <p>Custom layouts are configured as any other layout, as shown below:</p> + + <em>Example 5.0: Configuration of MySampleLayout + (examples/chapter5/sampleLayoutConfig.xml)</em> +<div class="source"><pre><configuration> + + <appender name="STDOUT" + class="ch.qos.logback.core.ConsoleAppender"> + <b><layout class="chapter5.MySampleLayout" /></b> + </appender> + + <root> + <level value="debug" /> + <appender-ref ref="STDOUT" /> + </root> +</configuration></pre></div> + + <p>The sample application <code>chapter5.SampleLogging</code> configures logback with the + configuration script supplied as parameter and then logs a debug message, + followed by an error message. + See <em>examples/chapter5/SampleLogging.java</em> for precise details.</p> + + <p>Executing the command <em>java chapter5.SampleLogging chapter5/sampleLayoutConfig.xml</em> + will produce the following output:</p> + +<div class="source"><pre>0 DEBUG [main] chapter5.SampleLogging - Everything's going well +0 ERROR [main] chapter5.SampleLogging - ... not quite</pre></div> + + <p>That was simple enough. + The skeptic Pyrrho of Elea, who insists that nothing is certain except + perhaps uncertainty itself, which is by no means certain either, + might ask: how about a layout with options? + The reader shall find a slightly modified version of our + custom layout in <code>MySampleLayout2.java</code>. She will discover that adding an option + to a layout is as simple as declaring a setter method for the option. + See also <em>chapter5/sampleLayoutConfig2.xml</em> for a configuration example.</p> + <h3>PatternLayout</h3> <p> @@ -953,11 +1073,19 @@ displayed when <em>the expression passed to the evaluator is <b>false</b>.</em></p> <h3>HTMLLayout</h3> - <p>HTMLLayout outputs events in an HTML table. Each row of the table corresponds to an event.</p> + <p>HTMLLayout outputs events in an HTML table. Each row of the table corresponds to a + logging event.</p> + + <p>Here is a sample of the output that can be obtained using <code>HTMLLayout</code> + along with the default CSS stylesheet:</p> + <img src="images/chapter5/htmlLayout1.gif" alt="HTML Layout Sample Image"/> + <p> The content of the table columns are specified using a conversion pattern. See <code>PatternLayout</code> for documentation on - the available patterns. + the available patterns. This ensure that the user has full access to the creation + of the html table. One can choose to display any (or all) data that <code>PatternLayout</code> + can provide. </p> <p>One notable point about the use of <code>PatternLayout</code> with <code>HTMLLayout</code> is that conversion specifiers should not be separated by a space. Each specifier found in the @@ -1003,12 +1131,13 @@ </layout></pre></div> <p> - The HTMLLayout is often used in conjunction with - SMTPAppender, to send a nicely formatted html email. Of + The <code>HTMLLayout</code> is often used in conjunction with + <code>SMTPAppender</code>, to send a nicely formatted html email. Of course, it can be used with any other Appender. </p> <p> - When one wants to use the HTMLLayout with a SMTPAppender, + When one wants to use the <code>HTMLLayout</code> with a + <code>SMTPAppender</code>, the following configuration is typically used. </p> <div class="source"><pre><configuration> @@ -1035,6 +1164,31 @@ IThrowableRenderer. It could be omitted, but is showed for educationnal purposes. </p> + <p>When <code>HTMLLayout</code> is used with any <code>FileAppender</code>, + one can specify the html page's title, simply by adding an element to the configuration, + as shown above:</p> + +<div class="source"><pre><configuration> + <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> + <ActiveFileName>lastLogEntries.html</ActiveFileName> + <FileNamePattern>lastLogEntries.%d{yyyy-MM-dd}.log</FileNamePattern> + </rollingPolicy> + + <layout class="ch.qos.logback.classic.html.HTMLLayout"> + <cssBuilder class="ch.qos.logback.core.helpers.CssBuilder"> + <param name="url" value="path_to_StyleFile.css" /> + </cssBuilder> + <Pattern>%relative%thread%mdc%level%logger%msg</Pattern> + <b><Title>Last Logging Events</Title></b> + </layout> + </appender> + + <root> + <level value="debug" /> + <appender-ref ref="FILE" /> + </root> +</configuration></pre></div> <h2>Logback access</h2> <p>Just like <code>ClassicLayout</code> represents the <code>Layout</code> interface @@ -1051,6 +1205,12 @@ modules classic and access address pretty different needs, but offer the same power and flexibility to the user.</p> + <h3>Writing your own Layout</h3> + <p>Writing a custom <code>Layout</code> for logback access works almost exactly the + same as writing such a component for the classic module.</p> + <p>The only exceptions comes from the fact that layouts in access module imlement + the <code>AccessLayout</code> interface instead <code>ClassicLayout</code>.</p> + <h3>PatternLayout</h3> <p>Access' <code>PatternLayout</code> work the exact same way as it's classic counterpart. </p>

1 0