Author: markt Date: Tue Jun 14 13:46:24 2011 New Revision: 1135572 URL: http://svn.apache.org/viewvc?rev=1135572&view=rev Log: CTR: Docs / Javadoc Fix https://issues.apache.org/bugzilla/show_bug.cgi?id=51346 Make clear the circumstances in which the RequestDumperValve will consume the request's InputStream. Based on a patch by pid.
Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/valves/RequestDumperValve.java tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml tomcat/tc6.0.x/trunk/webapps/docs/config/valve.xml Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/valves/RequestDumperValve.java URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/valves/RequestDumperValve.java?rev=1135572&r1=1135571&r2=1135572&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/java/org/apache/catalina/valves/RequestDumperValve.java (original) +++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/valves/RequestDumperValve.java Tue Jun 14 13:46:24 2011 @@ -37,6 +37,11 @@ import org.apache.juli.logging.Log; * (after processing). It is especially useful in debugging problems * related to headers and cookies.</p> * + * <p><b>WARNING: Using this valve has side-effects.</b> The output from this + * valve includes any parameters associated with the request. Therefore, the + * InputStream is consumed for requests made with the method POST and + * content-type application/x-www-form-urlencoded.</p> + * * <p>This Valve may be attached to any Container, depending on the granularity * of the logging you wish to perform.</p> * Modified: tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml?rev=1135572&r1=1135571&r2=1135572&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml (original) +++ tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml Tue Jun 14 13:46:24 2011 @@ -210,6 +210,11 @@ Update Maven repository information in the documentation to reflect current usage. (markt) </fix> + <fix> + <bug>51346</bug>: Update the documentation web application to make clear + the circumstances in which the RequestDumperValve will consume the + request's InputStream. Based on a patch by pid. (markt) + </fix> </changelog> </subsection> <subsection name="Other"> 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=1135572&r1=1135571&r2=1135572&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/webapps/docs/config/valve.xml (original) +++ tomcat/tc6.0.x/trunk/webapps/docs/config/valve.xml Tue Jun 14 13:46:24 2011 @@ -353,7 +353,9 @@ output from this valve includes any parameters included with the request. The parameters will be decoded using the default platform encoding. Any subsequent calls to <code>request.setCharacterEncoding()</code> within - the web application will have no effect.</p> + the web application will have no effect. NOTE: Since all parameters are + included in the output, the InputStream is consumed for requests made with + the method POST and content-type application/x-www-form-urlencoded.</p> </subsection> --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org