You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by kk...@apache.org on 2011/11/22 19:17:23 UTC

svn commit: r1205119 - in /tomcat/tc6.0.x/trunk: java/org/apache/catalina/valves/AccessLogValve.java java/org/apache/catalina/valves/ExtendedAccessLogValve.java webapps/docs/config/valve.xml

Author: kkolinko
Date: Tue Nov 22 18:17:22 2011
New Revision: 1205119

URL: http://svn.apache.org/viewvc?rev=1205119&view=rev
Log:
CTR: docs
Further minor corrections for access log valve docs

Modified:
    tomcat/tc6.0.x/trunk/java/org/apache/catalina/valves/AccessLogValve.java
    tomcat/tc6.0.x/trunk/java/org/apache/catalina/valves/ExtendedAccessLogValve.java
    tomcat/tc6.0.x/trunk/webapps/docs/config/valve.xml

Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/valves/AccessLogValve.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/valves/AccessLogValve.java?rev=1205119&r1=1205118&r2=1205119&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/valves/AccessLogValve.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/valves/AccessLogValve.java Tue Nov 22 18:17:22 2011
@@ -57,7 +57,8 @@ import org.apache.tomcat.util.buf.B2CCon
  * <p>Implementation of the <b>Valve</b> interface that generates a web server
  * access log with the detailed line contents matching a configurable pattern.
  * The syntax of the available patterns is similar to that supported by the
- * Apache <code>mod_log_config</code> module.  As an additional feature,
+ * <a href="http://httpd.apache.org/">Apache HTTP Server</a>
+ * <code>mod_log_config</code> module.  As an additional feature,
  * automatic rollover of log files when the date changes is also supported.</p>
  *
  * <p>Patterns for the logged message may include constant text or any of the
@@ -131,7 +132,13 @@ import org.apache.tomcat.util.buf.B2CCon
  * Conditional logging is also supported. This can be done with the
  * <code>condition</code> property.
  * If the value returned from ServletRequest.getAttribute(condition)
- * yields a non-null value. The logging will be skipped.
+ * yields a non-null value, the logging will be skipped.
+ * </p>
+ *
+ * <p>
+ * For extended attributes coming from a getAttribute() call,
+ * it is you responsibility to ensure there are no newline or
+ * control characters.
  * </p>
  *
  * @author Craig R. McClanahan

Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/valves/ExtendedAccessLogValve.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/valves/ExtendedAccessLogValve.java?rev=1205119&r1=1205118&r2=1205119&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/valves/ExtendedAccessLogValve.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/valves/ExtendedAccessLogValve.java Tue Nov 22 18:17:22 2011
@@ -72,14 +72,14 @@ import org.apache.juli.logging.LogFactor
  *                             certain POST parameters.
  * </li>
  * <li>For any of the x-H(...) the following method will be called from the
- *                HttpServletRequestObject </li>
+ *                HttpServletRequest object </li>
  * <li><code>x-H(authType)</code>: getAuthType </li>
  * <li><code>x-H(characterEncoding)</code>: getCharacterEncoding </li>
  * <li><code>x-H(contentLength)</code>: getContentLength </li>
  * <li><code>x-H(locale)</code>:  getLocale</li>
  * <li><code>x-H(protocol)</code>: getProtocol </li>
  * <li><code>x-H(remoteUser)</code>:  getRemoteUser</li>
- * <li><code>x-H(requestedSessionId)</code>: getGequestedSessionId</li>
+ * <li><code>x-H(requestedSessionId)</code>: getRequestedSessionId</li>
  * <li><code>x-H(requestedSessionIdFromCookie)</code>:
  *                  isRequestedSessionIdFromCookie </li>
  * <li><code>x-H(requestedSessionIdValid)</code>:
@@ -96,7 +96,7 @@ import org.apache.juli.logging.LogFactor
  * </p>
  *
  * <p>
- * For UNIX users, another field called <code>checkExists</code>is also
+ * For UNIX users, another field called <code>checkExists</code> is also
  * available. If set to true, the log file's existence will be checked before
  * each logging. This way an external log rotator can move the file
  * somewhere and Tomcat will start with a new file.
@@ -105,14 +105,14 @@ import org.apache.juli.logging.LogFactor
  * <p>
  * For JMX junkies, a public method called <code>rotate</code> has
  * been made available to allow you to tell this instance to move
- * the existing log file to somewhere else start writing a new log file.
+ * the existing log file to somewhere else and start writing a new log file.
  * </p>
  *
  * <p>
  * Conditional logging is also supported. This can be done with the
  * <code>condition</code> property.
  * If the value returned from ServletRequest.getAttribute(condition)
- * yields a non-null value. The logging will be skipped.
+ * yields a non-null value, the logging will be skipped.
  * </p>
  *
  * <p>

Modified: tomcat/tc6.0.x/trunk/webapps/docs/config/valve.xml
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/config/valve.xml?rev=1205119&r1=1205118&r2=1205119&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/webapps/docs/config/valve.xml (original)
+++ tomcat/tc6.0.x/trunk/webapps/docs/config/valve.xml Tue Nov 22 18:17:22 2011
@@ -208,7 +208,9 @@
     <p>
     There is also support to write information from the cookie, incoming
     header, the Session or something else in the ServletRequest.
-    It is modeled after the apache syntax:
+    It is modeled after the
+    <a href="http://httpd.apache.org/">Apache HTTP Server</a> log configuration
+    syntax:</p>
     <ul>
     <li><b><code>%{xxx}i</code></b> for incoming headers</li>
     <li><b><code>%{xxx}o</code></b> for outgoing response headers</li>
@@ -216,7 +218,6 @@
     <li><b><code>%{xxx}r</code></b> xxx is an attribute in the ServletRequest</li>
     <li><b><code>%{xxx}s</code></b> xxx is an attribute in the HttpSession</li>
     </ul>
-    </p>
 
 
     <p>The shorthand pattern name <code>common</code> (which is also the



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org