February 2009 - logback-dev

[JIRA] Commented: (LBCLASSIC-22) feature request: XMLLayout (cfr. log4j)
by Thorbjoern Ravn Andersen (JIRA) 05 Feb '09

05 Feb '09

[ http://jira.qos.ch/browse/LBCLASSIC-22?page=com.atlassian.jira.plugin.syste… ] Thorbjoern Ravn Andersen commented on LBCLASSIC-22: --------------------------------------------------- I do not understand the "as found in our repository" sentence. You added the file yesteday after I uploaded a revised patch, so the file was not there (unless I missed something). The time field was added to make the XML output readable to a human looking at the file, as nobody I know can understand timestamps in his head. This also includes the careful formatting of the output with line breaks. My character transformation is a clean design working well without the disambiguity of the CDATA (is a <tag> a real tag or a part of a CDATA stream) and as an added benefit generates 7-bit clean output. I have produced a neat implementation conforming to logback conventions and tested it with Chainsaw. You haven't even made a single comment on this issue even though its been in here for 14 months, decided to disregard my work and just grab the log4j implementation, add the MDC lines and calling it FIXED. I would have appreciated discussing this on logback-dev before the fact and not in comments after the fact. As it is now I see no reason my name is in the @authors tag in the file, and I would appreciate it if you removed it. > feature request: XMLLayout (cfr. log4j) > --------------------------------------- > > Key: LBCLASSIC-22 > URL: http://jira.qos.ch/browse/LBCLASSIC-22 > Project: logback-classic > Issue Type: Improvement > Components: Other > Affects Versions: unspecified > Environment: Operating System: Linux > Platform: PC > Reporter: dirk > Assignee: Ceki Gulcu > Priority: Minor > Fix For: 0.9.15 > > Attachments: XMLLayout.jar, XMLLayout.java > > > see Summary -- 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

[JIRA] Resolved: (LBCLASSIC-22) feature request: XMLLayout (cfr. log4j)
by Ceki Gulcu (JIRA) 05 Feb '09

05 Feb '09

[ http://jira.qos.ch/browse/LBCLASSIC-22?page=com.atlassian.jira.plugin.syste… ] Ceki Gulcu resolved LBCLASSIC-22. --------------------------------- Fix Version/s: 0.9.15 Resolution: Fixed I am marking this issue as resolved since the XMLLayout as found in our repository seems to work fine. It differs from the code Thorbjoern in that it does not output a "time" attribute. I wonder why it was introduced. Moreover, XMLLayout in our svn repo handles locationInformaion without creating new *CallerConverter instances. It also relies on character transformation very similar (if not identical) to those in the original XMLLayaout as found in log4j. Your comments are welcome. > feature request: XMLLayout (cfr. log4j) > --------------------------------------- > > Key: LBCLASSIC-22 > URL: http://jira.qos.ch/browse/LBCLASSIC-22 > Project: logback-classic > Issue Type: Improvement > Components: Other > Affects Versions: unspecified > Environment: Operating System: Linux > Platform: PC > Reporter: dirk > Assignee: Ceki Gulcu > Priority: Minor > Fix For: 0.9.15 > > Attachments: XMLLayout.jar, XMLLayout.java > > > see Summary -- 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

svn commit: r2145 - in logback/trunk: logback-core/src/main/java/ch/qos/logback/core/helpers logback-site/src/site/pages logback-site/src/site/pages/manual
by noreply.ceki＠qos.ch 05 Feb '09

05 Feb '09

Author: ceki Date: Thu Feb 5 22:25:21 2009 New Revision: 2145 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/helpers/Transform.java logback/trunk/logback-site/src/site/pages/faq.html logback/trunk/logback-site/src/site/pages/manual/appenders.html logback/trunk/logback-site/src/site/pages/manual/layouts.html logback/trunk/logback-site/src/site/pages/news.html Log: Added documentation and news about XMLLayout. This fixes LBCLASSIC-22 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/helpers/Transform.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/helpers/Transform.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/helpers/Transform.java Thu Feb 5 22:25:21 2009 @@ -75,7 +75,7 @@ * @param str * The String that is inserted into an existing CDATA Section. */ - public static void appendEscapingCDATA(StringBuffer output, String str) { + public static void appendEscapingCDATA(StringBuilder output, String str) { if (str == null) { return; } Modified: logback/trunk/logback-site/src/site/pages/faq.html ============================================================================== --- logback/trunk/logback-site/src/site/pages/faq.html (original) +++ logback/trunk/logback-site/src/site/pages/faq.html Thu Feb 5 22:25:21 2009 @@ -117,7 +117,7 @@ </dt> <dd> <p>This question is answered in the <a - href="manual/joran.html#auto_configuration">relevant + href="manual/configuration.html#auto_configuration">relevant section</a> of the logback manual. </p> <hr/> @@ -181,7 +181,7 @@ </dt> <dd> <p>Yes, it is. Using <a - href="manual/joran.html#variableSubstitution">variable + href="manual/configuration.html#variableSubstitution">variable substitution</a>, it is possible to have a single configuration file to output logs to different destinations depending on each JEE application. Here is a sample @@ -251,9 +251,9 @@ <p>Making use of <a - href="manual/joran.html#variableSubstitution">variable + href="manual/configuration.html#variableSubstitution">variable substitution</a> as well as <a - href="manual/joran.html#defaultValuesForVariables">default + href="manual/configuration.html#defaultValuesForVariables">default values for variables</a>, if the <span class="variable">root-level</span> system property is set to <code>OFF</code>, then all logging will be turned Modified: logback/trunk/logback-site/src/site/pages/manual/appenders.html ============================================================================== --- logback/trunk/logback-site/src/site/pages/manual/appenders.html (original) +++ logback/trunk/logback-site/src/site/pages/manual/appenders.html Thu Feb 5 22:25:21 2009 @@ -2860,9 +2860,10 @@ Then, we simply declare the given element. The action class will be called and our connection source will be bound to a JNDI context. </p> + <p> This is a very powerfull possibility of Joran. If you'd like to read more about Joran, please - visit our <a href="../joran.html">introduction to Joran</a>. + see the <a href="onJoran.html">chapter to Joran</a>. </p> --> @@ -3199,7 +3200,7 @@ differentiation, within the nested appender (FileAppender above), the key passed to the discriminator, "userid" in the above example, becomes a <a - href="joran.html#variableSubstitution">variable</a>. Consequently, + href="configuration.html#variableSubstitution">variable</a>. Consequently, this variable can be used to differentiate the actual resource used by a given nested appender. </p> Modified: logback/trunk/logback-site/src/site/pages/manual/layouts.html ============================================================================== --- logback/trunk/logback-site/src/site/pages/manual/layouts.html (original) +++ logback/trunk/logback-site/src/site/pages/manual/layouts.html Thu Feb 5 22:25:21 2009 @@ -254,9 +254,9 @@ needed to enable the configuration of an option. Note that the <code>PrintThreadName</code> option is boolean and not <code>String</code>. Configuration of logback components was - covered in detail in <a href="joran.html">"Chapter 3: Logback - configuration with Joran"</a>. Here is the configuration file - tailor-made for use with <code>MySampleLayout2</code>. + covered in detail in <a href="configuration.html">"Chapter 3: + Logback configuration"</a>. Here is the configuration + file tailor-made for use with <code>MySampleLayout2</code>. </p> @@ -1171,7 +1171,7 @@ Example 5.2: Sample usage of EventEvaluators (logback-examples/src/main/java/chapter5/callerEvaluatorConfig.xml) </em> - <div class="source"><pre><configuration> + <p class="source"><configuration> <b><evaluator name="DISP_CALLER_EVAL"> <Expression>logger.getName().contains("chapter5") &amp;&amp; \ message.contains("who calls thee")</Expression> @@ -1187,7 +1187,7 @@ <root level="debug"> <appender-ref ref="STDOUT" /> </root> -</configuration></pre></div> +</configuration></p> <p>Due to XML encoding rules, the & character cannot be written as is, and needs to be escaped as &amp;.</p> @@ -1201,7 +1201,7 @@ (logback-examples/src/main/java/chapter5/CallerEvaluatorExample.java)</a> </em> </p> - <div class="source"><pre>package chapter5; + <p class="source">package chapter5; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -1233,7 +1233,7 @@ } } } -}</pre></div> +}</p> <p> The <em>CallerEvaluatorExample</em> application does nothing particularly fancy. Five logging requests are issued, the third one being @@ -1466,8 +1466,8 @@ <p>should yield:</p> -<div class="source">0 [main] DEBUG - Everything's going well -3 [main] <span class="red">ERROR</span> - maybe not quite... </div> + <p class="source">0 [main] DEBUG - Everything's going well +3 [main] <span class="red">ERROR</span> - maybe not quite... </p> <p>Please note that the string "ERROR" is highlighted in red, @@ -1482,15 +1482,13 @@ - <h2> - <a name="ClassicHTMLLayout" href="#ClassicHTMLLayout">Generating logs in HTML format</a> - </h2> + <h3> + <a name="ClassicHTMLLayout" href="#ClassicHTMLLayout">HTMLLayout</a> + </h3> - <p>Logback provides a special <a - href="../xref/ch/qos/logback/core/Layout.html"><code>Layout</code></a>, - namely <a - href="../xref/ch/qos/logback/classic/html/HTMLLayout.html"> - <code>HTMLLayout</code></a>, to generate logs directly in HTML + <p><a + href="../xref/ch/qos/logback/classic/html/HTMLLayout.html"><code>HTMLLayout</code></a> + (as included in logback-classic) generates logs in HTML format. <code>HTMLLayout</code> outputs logging events in an HTML table where each row of the table corresponds to a logging event.</p> @@ -1538,7 +1536,7 @@ <p>Launching the <code>TrivialMain</code> application listed below will create the file <em>test.html</em> on your local drive.</p> -<div class="source">import org.slf4j.Logger; + <p class="source">import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class TrivialMain { @@ -1553,7 +1551,7 @@ } logger.error("Finish off with fireworks", new Exception("Just testing")); } -}</div> +}</p> <p>The contents of <em>test.html</em> should be similar to: </p> @@ -1636,7 +1634,7 @@ shown in the sample configuration below. </p> -<div class="source"><pre><configuration> + <p class="source"><configuration> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <ActiveFileName>lastLogEntries.html</ActiveFileName> @@ -1655,20 +1653,62 @@ <root level="debug"> <appender-ref ref="FILE" /> </root> -</configuration></pre></div> +</configuration></p> + + <h3><a name="log4jXMLLayout" href="#log4jXMLLayout">Log4j XMLLayout</a></h3> + + + <p><a + href="../xref/ch/qos/logback/classic/log4j/XMLLayout.html">XMLLayout</a> + (part of logback-classic) generates output in a log4j.dtd + compliant format. It can be used to inter-operate with tools such + as <a + href="http://logging.apache.org/chainsaw/index.html">Chainsaw</a> + and <a href="http://vigilog.sourceforge.net/">Vigilog</a> capable + of processing files generated by <a + href="http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/xml/XMLLayout.…">log4j's + XMLLayout</a>. + </p> + + <p>As the original XMLLayout in log4j version 1.2.15, XMLLayout in + logback-classic admits two boolean properties, <span + class="option">LocationInfo</span> and <span + class="option">Properties</span>. Setting <span + class="option">LocationInfo</span> to true enables the inclusion + of location info (caller data) in the each event. Setting <span + class="option">Properties</span> to true enables the inclusion of + MDC information. Both options are set to false by default. + </p> + + <p>Here is a sample configuration</p> + + <p class="source"><configuration> + <appender name="FILE" class="ch.qos.logback.core.FileAppender"> + <File>test.xml</File> + <layout class="ch.qos.logback.classic.log4j.XMLLayout"> + <LocationInfo>true</LocationInfo> + </layout> + </appender> + + <root level="debug"> + <appender-ref ref="FILE" /> + </root> +</configuration> </p> + <h2>Logback access</h2> <p>Most logback-access layouts are mere adaptations of logback-classic layouts. Logback-classic and logback-access modules address different needs, but in general offer comparable - power and flexibility.</p> + functionality.</p> <h3>Writing your own Layout</h3> <p>Writing a custom <code>Layout</code> for logback access is nearly identical as its sibling<code>Layout</code> in logback-classic.</p> + <a name="AccessPatternLayout"></a> <h3>PatternLayout</h3> Modified: logback/trunk/logback-site/src/site/pages/news.html ============================================================================== --- logback/trunk/logback-site/src/site/pages/news.html (original) +++ logback/trunk/logback-site/src/site/pages/news.html Thu Feb 5 22:25:21 2009 @@ -28,7 +28,8 @@ <hr width="80%" align="center" /> - <h3>TARGET DATE: 26th of January 2009 - Release of version 0.9.15</h3> + <h3>TARGET DATE: 6th of February 2009 - Release of version + 0.9.15</h3> <p>When the reset() method in <code>LoggerContext</code> is called, registered turbo filters are first stopped before being @@ -39,7 +40,7 @@ <p>Added a servlet for viewing internal status messages as an HTML table. Two separate implementations are available; one for <a - href="manual/joran.html#viewingStatusMessages">logback-classic</a> + href="manual/configuration.html#viewingStatusMessages">logback-classic</a> and the other for <a href="access.html#viewingStatusMessages">logback-access</a>.</p> @@ -56,6 +57,14 @@ related to loss of MDC information in deferred logging events. </p> + <p>Added <em>log4j.dtd</em> compatible <a + href="manual/layouts.html#log4jXMLLayout"><code>XMLLayout</code></a> + as requested in <a + href="http://jira.qos.ch/browse/LBCLASSIC-22">LBCLASSIC-22</a>. + </p> + + <p>New chapter <a href="manual/onJoran.html">on Joran</a>.</p> + <h3>29th of December 2008 - Release of version 0.9.14</h3> <p>Corrected a serious dead-lock problem occuring during @@ -252,9 +261,9 @@ </p> <p>Logback now supports <a - href="manual/joran.html#contextName">setting the logger context + href="manual/configuration.html#contextName">setting the logger context name</a> as well as inserting variables <a - href="manual/joran.html#insertFromJNDI">stored in JNDI</a> as + href="manual/configuration.html#insertFromJNDI">stored in JNDI</a> as properties. </p> @@ -633,8 +642,9 @@ logback's configuration framework. A file can contain an <em>include</em> element that has a <em>file</em> or <em>url</em> attribute pointing to a configuration file. See the <a - href="manual/joran.html#Include">chapter about configuration</a> - in the logback's online manual for more information. + href="manual/configuration.html#Include">chapter about + configuration</a> in the logback's online manual for more + information. </p> <p>Corrected bug 53 reported by Wilkins Poe. There is now a <a

1 0

svn commit: r2144 - logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/log4j
by noreply.ceki＠qos.ch 05 Feb '09

05 Feb '09

Author: ceki Date: Thu Feb 5 22:04:07 2009 New Revision: 2144 Added: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/log4j/package.html Log: added a package.html file for c.q.l.classic.log4j package Added: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/log4j/package.html ============================================================================== --- (empty file) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/log4j/package.html Thu Feb 5 22:04:07 2009 @@ -0,0 +1,13 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> + +<html> + <head> + <title></title> + </head> + + <body> + + <p>Contains support for log4j output formats.</p> + + </body> +</html> \ No newline at end of file

1 0

svn commit: r2143 - logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/log4j
by noreply.ceki＠qos.ch 05 Feb '09

05 Feb '09

Author: ceki Date: Thu Feb 5 17:32:22 2009 New Revision: 2143 Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/log4j/XMLLayout.java Log: - added support for MDC properties in XMLLayout as found in LBCLASSIC-22 contribution Modified: logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/log4j/XMLLayout.java ============================================================================== --- logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/log4j/XMLLayout.java (original) +++ logback/trunk/logback-classic/src/main/java/ch/qos/logback/classic/log4j/XMLLayout.java Thu Feb 5 17:32:22 2009 @@ -9,6 +9,10 @@ */ package ch.qos.logback.classic.log4j; +import java.util.Map; +import java.util.Set; +import java.util.Map.Entry; + import ch.qos.logback.classic.spi.CallerData; import ch.qos.logback.classic.spi.LoggingEvent; import ch.qos.logback.classic.spi.ThrowableDataPoint; @@ -33,8 +37,14 @@ private final int DEFAULT_SIZE = 256; private final int UPPER_LIMIT = 2048; - private StringBuffer buf = new StringBuffer(DEFAULT_SIZE); + private StringBuilder buf = new StringBuilder(DEFAULT_SIZE); private boolean locationInfo = false; + private boolean properties = false; + + @Override + public void start() { + super.start(); + } /** * The <b>LocationInfo</b> option takes a boolean value. By default, it is @@ -57,19 +67,36 @@ return locationInfo; } - /** No options to activate. */ - public void activateOptions() { + /** + * Sets whether MDC key-value pairs should be output, default false. + * + * @param flag + * new value. + * @since 1.2.15 + */ + public void setProperties(final boolean flag) { + properties = flag; + } + + /** + * Gets whether MDC key-value pairs should be output. + * + * @return true if MDC key-value pairs are output. + * @since 1.2.15 + */ + public boolean getProperties() { + return properties; } /** * Formats a {@link LoggingEvent} in conformity with the log4j.dtd. */ public String doLayout(LoggingEvent event) { - + // Reset working buffer. If the buffer is too large, then we need a new // one in order to avoid the penalty of creating a large array. if (buf.capacity() > UPPER_LIMIT) { - buf = new StringBuffer(DEFAULT_SIZE); + buf = new StringBuilder(DEFAULT_SIZE); } else { buf.setLength(0); } @@ -78,7 +105,8 @@ buf.append("<log4j:event logger=\""); buf.append(event.getLoggerRemoteView().getName()); - buf.append("\" timestamp=\""); + buf.append("\"\r\n"); + buf.append(" timestamp=\""); buf.append(event.getTimeStamp()); buf.append("\" level=\""); buf.append(event.getLevel()); @@ -86,7 +114,7 @@ buf.append(event.getThreadName()); buf.append("\">\r\n"); - buf.append("<log4j:message><![CDATA["); + buf.append(" <log4j:message><![CDATA["); // Append the rendered message. Also make sure to escape any // existing CDATA sections. Transform.appendEscapingCDATA(buf, event.getFormattedMessage()); @@ -94,13 +122,13 @@ // logback does not support NDC // String ndc = event.getNDC(); - + ThrowableProxy tp = event.getThrowableProxy(); - + if (tp != null) { - buf.append("<log4j:throwable><![CDATA["); + buf.append(" <log4j:throwable><![CDATA["); ThrowableDataPoint[] tdpArray = tp.getThrowableDataPointArray(); - for (ThrowableDataPoint tdp: tdpArray) { + for (ThrowableDataPoint tdp : tdpArray) { buf.append(tdp.toString()); buf.append("\r\n"); } @@ -110,10 +138,11 @@ if (locationInfo) { CallerData[] callerDataArray = event.getCallerData(); if (callerDataArray != null && callerDataArray.length > 0) { - CallerData immediateCallerData = callerDataArray[0]; - buf.append("<log4j:locationInfo class=\""); + CallerData immediateCallerData = callerDataArray[0]; + buf.append(" <log4j:locationInfo class=\""); buf.append(immediateCallerData.getClassName()); - buf.append("\" method=\""); + buf.append("\"\r\n"); + buf.append(" method=\""); buf.append(Transform.escapeTags(immediateCallerData.getMethodName())); buf.append("\" file=\""); buf.append(immediateCallerData.getFileName()); @@ -123,9 +152,34 @@ } } - buf.append("</log4j:event>\r\n\r\n"); + /* + * <log4j:properties> <log4j:data name="name" value="value"/> + * </log4j:properties> + */ + if (this.getProperties()) { + Map<String, String> propertyMap = event.getMDCPropertyMap(); + + if ((propertyMap != null) && (propertyMap.size() != 0)) { + Set<Entry<String, String>> entrySet = propertyMap.entrySet(); + buf.append(" <log4j:properties>"); + for (Entry<String, String> entry : entrySet) { + buf.append("\r\n <log4j:data"); + buf.append(" name='" + Transform.escapeTags(entry.getKey()) + "'"); + buf.append(" value='" + Transform.escapeTags(entry.getValue()) + "'"); + buf.append(" />"); + } + buf.append("\r\n </log4j:properties>"); + } + } + + buf.append("\r\n</log4j:event>\r\n\r\n"); return buf.toString(); } + @Override + public String getContentType() { + return "text/xml"; + } + }

1 0

svn repository replication
by Ceki Gulcu 04 Feb '09

04 Feb '09

Hello all, I am looking for a volunteer to mirror the logback svn repository using svnsync as explained in [1]. This mirror would be used to ease the load on our server (which is not very heavy) but most importantly act as a backup in case our server crashes. Any volunteers? [1] http://tinyurl.com/7b24qu -- Ceki Gülcü Logback: The reliable, generic, fast and flexible logging framework for Java. http://logback.qos.ch

1 0

[JIRA] Created: (LBCORE-65) Better documentation on Joran
by Ceki Gulcu (JIRA) 04 Feb '09

04 Feb '09

Better documentation on Joran ----------------------------- Key: LBCORE-65 URL: http://jira.qos.ch/browse/LBCORE-65 Project: logback-core Issue Type: Task Components: Joran Affects Versions: 0.9.10 Reporter: Ceki Gulcu Assignee: Ceki Gulcu Joran should be better documented -- 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 3

svn commit: r2141 - in logback/trunk: logback-core/src/main/java/ch/qos/logback/core/util logback-core/src/test/java/ch/qos/logback/core/joran/spi logback-examples logback-site/src/site/pages/manual
by noreply.ceki＠qos.ch 04 Feb '09

04 Feb '09

Author: ceki Date: Wed Feb 4 22:00:48 2009 New Revision: 2141 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util/FileSize.java logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/spi/PropertySetterTest.java logback/trunk/logback-examples/ (props changed) logback/trunk/logback-site/src/site/pages/manual/onJoran.html Log: Ongoing work on Joran documentation LBSITE-25 Modified: logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util/FileSize.java ============================================================================== --- logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util/FileSize.java (original) +++ logback/trunk/logback-core/src/main/java/ch/qos/logback/core/util/FileSize.java Wed Feb 4 22:00:48 2009 @@ -12,6 +12,19 @@ import java.util.regex.Matcher; import java.util.regex.Pattern; +/** + * Instances of this class represent the size of a file. Internally, the size is + * stored as long.> + * + * <p>The {@link #valueOf} method can convert strings such as "3 kb", "5 mb", into + * FileSize instances. The recognized unit specifications for file size are the + * "kb", "mb", and "gb". The unit name may be followed by an "s". Thus, "2 kbs" + * and "2 kb" are equivalent. In the absence of a time unit specification, byte + * is assumed. + * + * @author Ceki Gülcü + * + */ public class FileSize { private final static String LENGTH_PART = "([0-9]+)"; @@ -27,7 +40,6 @@ static final long MB_COEFFICIENT = 1024 * KB_COEFFICIENT; static final long GB_COEFFICIENT = 1024 * MB_COEFFICIENT; - final long size; FileSize(long size) { @@ -55,7 +67,7 @@ coefficient = MB_COEFFICIENT; } else if (unitStr.equalsIgnoreCase("gb")) { coefficient = GB_COEFFICIENT; - } else { + } else { throw new IllegalStateException("Unexpected " + unitStr); } return new FileSize(lenValue * coefficient); Modified: logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/spi/PropertySetterTest.java ============================================================================== --- logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/spi/PropertySetterTest.java (original) +++ logback/trunk/logback-core/src/test/java/ch/qos/logback/core/joran/spi/PropertySetterTest.java Wed Feb 4 22:00:48 2009 @@ -136,7 +136,7 @@ setter.setContext(context); setter.addBasicProperty("adjective", "nice"); setter.addBasicProperty("adjective", "big"); - + assertEquals(2, house.adjectiveList.size()); assertEquals("nice", house.adjectiveList.get(0)); assertEquals("big", house.adjectiveList.get(1)); @@ -216,6 +216,24 @@ defaultComponentRegistry); assertEquals(SwimmingPoolImpl.class, classViaImplicitRules); } + + @Test + public void testDefaultClassAnnotationForLists() { + House house = new House(); + PropertySetter setter = new PropertySetter(house); + Method relevantMethod = setter.getRelevantMethod("LargeSwimmingPool", + AggregationType.AS_COMPLEX_PROPERTY_COLLECTION); + assertNotNull(relevantMethod); + Class spClass = setter.getDefaultClassNameByAnnonation("LargeSwimmingPool", + relevantMethod); + assertEquals(LargeSwimmingPoolImpl.class, spClass); + + Class classViaImplicitRules = setter.getClassNameViaImplicitRules( + "LargeSwimmingPool", AggregationType.AS_COMPLEX_PROPERTY_COLLECTION, + defaultComponentRegistry); + assertEquals(LargeSwimmingPoolImpl.class, classViaImplicitRules); + + } } class House { @@ -232,6 +250,7 @@ List<String> adjectiveList = new ArrayList<String>(); List<Window> windowList = new ArrayList<Window>(); + List<SwimmingPool> largePoolList = new ArrayList<SwimmingPool>(); public String getCamelCase() { return camelCase; @@ -273,6 +292,11 @@ this.open = open; } + @DefaultClass(LargeSwimmingPoolImpl.class) + public void addLargeSwimmingPool(SwimmingPool pool) { + this.pool = pool; + } + @DefaultClass(SwimmingPoolImpl.class) public void setSwimmingPool(SwimmingPool pool) { this.pool = pool; @@ -341,6 +365,12 @@ int depth; } +class LargeSwimmingPoolImpl implements SwimmingPool { + int length; + int width; + int depth; +} + enum HouseColor { WHITE, BLUE } 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 Feb 4 22:00:48 2009 @@ -566,26 +566,37 @@ <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 + adhering to the "valueOf" convention. Such properties are said to + be <em>basic</em> or <em>simple</em>. 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. + parameter and returning an instance of the type in question. At + present time, <a + href="../xref/ch/qos/logback/classic/Level.html"><code>Level</code></a>, + <a + href="../xref/ch/qos/logback/core/util/Duration.html"><code>Duration</code></a> + and <a + href="../xref/ch/qos/logback/core/util/FileSize.html"><code>FileSize</code></a> + classes follow this convention.. </p> <p><code>NestedComplexPropertyIA</code> action is applicable, in the remaining cases where <code>NestedBasicPropertyIA</code> is not applicable <em>and</em> if the object at the top of the object stack has a setter or adder method for a property name equal to the - current element name. This strategy allows <a + current element name. Note that such properties can in turn contain + other components. Thus, such properties are said to be + <em>complex</em>. In presence of a complex property, <a href="../xref/ch/qos/logback/core/joran/action/NestedComplexPropertyIA.html"> - <code>NestedComplexPropertyIA</code></a> to instantiate the + <code>NestedComplexPropertyIA</code></a> will instantiate the appropriate class for the nested component and attach it to the parent component (at the top of the object stack) by using the setter/adder method of the parent component and the nested element's - name. The class to instantiate is specified by the <span - class="attr">class</span> attribute of the nested element. However, - the class name can be deduced implicitly, if any of the following is - true: + name. The corresponding class is specified by the <span + class="attr">class</span> attribute of the (nested) current + element. However, if the <span class="attr">class</span> attribute + is missing, the class name can be deduced implicitly, if any of the + following is true: </p> <ol> @@ -601,7 +612,8 @@ </ol> <p>In logback-classic, there are just two rules mapping (parent - class/property name) couples to a default class.</p> + class/property name) couples to a default class. These are listed in + the table below.</p> <table class="bodyTable"> <tr> @@ -635,6 +647,14 @@ <code>addDefaultNestedComponentRegistryRules</code> method for the latest rules. </p> + + <h4>Collection of properties</h4> + + + <p>Note that in addition to single simple properties or single + complex properties, logback's implicit actions support collectons of + properties, be they simple or complex. Instead of a setter method, + the property is specified by an "adder" method.</p> <h3><a name="newRule" href="#newRule">New rules on the fly</a></h3> @@ -707,7 +727,7 @@ href="#calculator">original calculator example</a>.</p> - <script src="templates/footer.js" type="text/javascript"></script> + <script src="../templates/footer.js" type="text/javascript"></script> </div> </body> </html>

1 0

[JIRA] Created: (LBSITE-24) Document default component class mapping rules
by Ceki Gulcu (JIRA) 04 Feb '09

04 Feb '09

Document default component class mapping rules ---------------------------------------------- Key: LBSITE-24 URL: http://jira.qos.ch/browse/LBSITE-24 Project: logback-site Issue Type: Task Components: Documentation Affects Versions: 0.9.15 Reporter: Ceki Gulcu Assignee: Ceki Gulcu In relation with LBCLASSIC-103, there should be documentation about default component class mapping rules. -- 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 2

[JIRA] Created: (LBCORE-66) Document the valueOf convention
by Ceki Gulcu (JIRA) 04 Feb '09

04 Feb '09

Document the valueOf convention ------------------------------- Key: LBCORE-66 URL: http://jira.qos.ch/browse/LBCORE-66 Project: logback-core Issue Type: Sub-task Components: Joran Reporter: Ceki Gulcu Assignee: Logback dev list Joran now assumes that any class which has a static valueOf method taking a String as an argument can be built from a string. Level, Duration and FileSize classes follow this convention. -- 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 2