various edits

ceki · ceki · commit 63d0bb7303c3 · 2013-03-20T13:39:16.000+01:00
diff --git a/logback-access/src/main/java/ch/qos/logback/access/spi/AccessEvent.java b/logback-access/src/main/java/ch/qos/logback/access/spi/AccessEvent.java
@@ -393,8 +393,7 @@ public String getRequestContent() {
       }
       requestContent = buf.toString();
     } else {
-
-      // retreive the byte array placed by TeeFilter
+      // retrieve the byte array placed by TeeFilter
       byte[] inputBuffer = (byte[]) httpRequest
           .getAttribute(AccessConstants.LB_INPUT_BUFFER);
 
diff --git a/logback-examples/src/main/java/chapters/appenders/CountingConsoleAppender.java b/logback-examples/src/main/java/chapters/appenders/CountingConsoleAppender.java
@@ -38,7 +38,7 @@ public int getLimit() {
   @Override
   public void start() {
     if (this.encoder == null) {
-      addError("No layout set for the appender named ["+ name +"].");
+      addError("No encoder set for the appender named ["+ name +"].");
       return;
     }
     
@@ -53,13 +53,13 @@ public void append(ILoggingEvent event) {
     if (counter >= limit) {
       return;
     }
-    // output the events as formatted by our layout
+    // output the events as formatted by the wrapped layout
     try {
       this.encoder.doEncode(event);
     } catch (IOException e) {
     }
 
-    // prepare for next event
+   // prepare for next event
     counter++;
   }
 
@@ -70,6 +70,4 @@ public PatternLayoutEncoder getEncoder() {
   public void setEncoder(PatternLayoutEncoder encoder) {
     this.encoder = encoder;
   }
-  
-  
 }
diff --git a/logback-site/src/site/pages/manual/appenders.html b/logback-site/src/site/pages/manual/appenders.html
@@ -3620,8 +3620,11 @@ <h3><a name="WriteYourOwnAppender"
     <p>The <code>CountingConsoleAppender</code>, which we list next,
     appends a limited number of incoming events on the console. It
     shuts down after the limit is reached.  It uses a
-    <code>Layout</code> to format the events and accepts a parameter.
-    Thus, a few more methods are needed.
+    <code>PatternLayoutEncoder</code> to format the events and accepts
+    a parameter named <code>limit</code>. Therefore, a few more
+    methods beyond <code>append(Object eventObject)</code> are
+    needed. As shown below, these parameters are handles
+    auto-magically by logback's various configuration mechanisms.
     </p>
     
     <em>Example 4.<span class="autoExec"/>:
@@ -3654,7 +3657,7 @@ <h3><a name="WriteYourOwnAppender"
   @Override
   public void start() {
     if (this.encoder == null) {
-      addError("No layout set for the appender named ["+ name +"].");
+      addError("No encoder set for the appender named ["+ name +"].");
       return;
     }
     
@@ -3686,24 +3689,23 @@ <h3><a name="WriteYourOwnAppender"
   public void setEncoder(PatternLayoutEncoder encoder) {
     this.encoder = encoder;
   }
-  
-  
 }</pre>
 
 		<p>The <code>start()</code> method checks for the presence of a
-		<code>Layout</code>.  In case the layout is not set, the appender
-		fails to start with an error message.
+		<code>PatternLayoutEncoder</code>.  In case the encoder is not
+		set, the appender fails to start and emits an error message.
 		</p>
 		
 		<p>This custom appender illustrates two points:</p>
 		
 		<ul>
 
       <li>All properties that follow the setter/getter JavaBeans
-      conventions are handled transparently. The <code>start()</code>
-      method, which is called automatically during logback
-      configuration, has the responsibility of verifying that the
-      various properties of the appender are coherent.
+      conventions are handled transparently by logback
+      configurators. The <code>start()</code> method, which is called
+      automatically during logback configuration, has the
+      responsibility of verifying that the various properties of the
+      appender are set and are coherent.
 			</li>
 
 			<li>The <code>AppenderBase.doAppend()</code> method invokes the
diff --git a/logback-site/src/site/pages/news.html b/logback-site/src/site/pages/news.html
@@ -57,6 +57,11 @@ <h3>, 2013 - Release of version 1.0.11</h3>
     href="http://jira.qos.ch/browse/LOGBACK-805">LOGBACK-805</a>
     reported by Daris Cooper who also provided a corrective patch.</p>
 
+    <p>In logback-access, more correct determination of whether
+    contents of an <code>HttpServletRequest</code> are URL encoded or
+    not. This <a href="https://github.com/qos-ch/logback/pull/71">bug
+    fix</a> was submitted by David Schneider.</p>
+
     <hr width="80%" align="center" />
 
     <h3>15th of March, 2013 - Release of version 1.0.10</h3>

Original file line number	Diff line number	Diff line change
`@@ -393,8 +393,7 @@ public String getRequestContent() {`
`393`	`393`	`}`
`394`	`394`	`requestContent = buf.toString();`
`395`	`395`	`} else {`
`396`		`-`
`397`		`- // retreive the byte array placed by TeeFilter`
	`396`	`+ // retrieve the byte array placed by TeeFilter`
`398`	`397`	`byte[] inputBuffer = (byte[]) httpRequest`
`399`	`398`	`.getAttribute(AccessConstants.LB_INPUT_BUFFER);`
`400`	`399`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public int getLimit() {`
`38`	`38`	`@Override`
`39`	`39`	`public void start() {`
`40`	`40`	`if (this.encoder == null) {`
`41`		`- addError("No layout set for the appender named ["+ name +"].");`
	`41`	`+ addError("No encoder set for the appender named ["+ name +"].");`
`42`	`42`	`return;`
`43`	`43`	`}`
`44`	`44`
`@@ -53,13 +53,13 @@ public void append(ILoggingEvent event) {`
`53`	`53`	`if (counter >= limit) {`
`54`	`54`	`return;`
`55`	`55`	`}`
`56`		`- // output the events as formatted by our layout`
	`56`	`+ // output the events as formatted by the wrapped layout`
`57`	`57`	`try {`
`58`	`58`	`this.encoder.doEncode(event);`
`59`	`59`	`} catch (IOException e) {`
`60`	`60`	`}`
`61`	`61`
`62`		`- // prepare for next event`
	`62`	`+ // prepare for next event`
`63`	`63`	`counter++;`
`64`	`64`	`}`
`65`	`65`
`@@ -70,6 +70,4 @@ public PatternLayoutEncoder getEncoder() {`
`70`	`70`	`public void setEncoder(PatternLayoutEncoder encoder) {`
`71`	`71`	`this.encoder = encoder;`
`72`	`72`	`}`
`73`		`-`
`74`		`-`
`75`	`73`	`}`