Fix https://issues.apache.org/bugzilla/show_bug.cgi?id=49617

Correct the ExpiresFilter documentation after changes to the submitted patch

git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@966304 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/java/org/apache/catalina/filters/ExpiresFilter.java b/java/org/apache/catalina/filters/ExpiresFilter.java
index bf63918..39de57e 100644 (file)
--- a/java/org/apache/catalina/filters/ExpiresFilter.java
+++ b/java/org/apache/catalina/filters/ExpiresFilter.java
@@ -110,43 +110,7 @@ import org.apache.juli.logging.LogFactory;
  * </web-app>
  * </pre></code>
  * 
- * <h2>Configuration Parameters</h2><h3>
- * <tt>ExpiresActive</tt></h3>
- * <p>
- * This directive enables or disables the generation of the <tt>Expires</tt> and
- * <tt>Cache-Control</tt> headers by this <tt>ExpiresFilter</tt>. If set to
- * <tt>Off</tt>, the headers will not be generated for any HTTP response. If set
- * to <tt>On</tt> or <tt>true</tt>, the headers will be added to served HTTP
- * responses according to the criteria defined by the
- * <tt>ExpiresByType &lt;content-type&gt;</tt> and <tt>ExpiresDefault</tt>
- * directives. Note that this directive does not guarantee that an
- * <tt>Expires</tt> or <tt>Cache-Control</tt> header will be generated. If the
- * criteria aren&#x27;t met, no header will be sent, and the effect will be as
- * though this directive wasn&#x27;t even specified.
- * </p>
- * <p>
- * This parameter is optional, default value is <tt>true</tt>.
- * </p>
- * <p>
- * <i>Enable filter</i>
- * </p>
- * 
- * <code><pre>
- * &lt;init-param&gt;
- *    &lt;!-- supports case insensitive &#x27;On&#x27; or &#x27;true&#x27; --&gt;
- *    &lt;param-name&gt;ExpiresActive&lt;/param-name&gt;&lt;param-value&gt;On&lt;/param-value&gt;
- * &lt;/init-param&gt;
- * </pre></code>
- * <p>
- * <i>Disable filter</i>
- * </p>
- * 
- * <code><pre>
- * &lt;init-param&gt;
- *    &lt;!-- supports anything different from case insensitive &#x27;On&#x27; and &#x27;true&#x27; --&gt;
- *    &lt;param-name&gt;ExpiresActive&lt;/param-name&gt;&lt;param-value&gt;Off&lt;/param-value&gt;
- * &lt;/init-param&gt;
- * </pre></code>
+ * <h2>Configuration Parameters</h2>
  * 
  * <h3>
  * <tt>ExpiresByType &lt;content-type&gt;</tt></h3>
@@ -316,7 +280,7 @@ import org.apache.juli.logging.LogFactory;
  * <tt>max-age</tt> directive of the <tt>Cache-Control</tt> header),</li>
  * <li>the response status code is not excluded by the directive
  * <tt>ExpiresExcludedResponseStatusCodes</tt>,</li>
- * <li>The <tt>Content-Type</tt> of the response matches one of the types
+ * <li>the <tt>Content-Type</tt> of the response matches one of the types
  * defined the in <tt>ExpiresByType</tt> directives or the
  * <tt>ExpiresDefault</tt> directive is defined.</li>
  * </ol>
@@ -412,7 +376,6 @@ import org.apache.juli.logging.LogFactory;
  * <code><pre>
  * Mar 26, 2010 2:01:41 PM org.apache.catalina.filters.ExpiresFilter init
  * FINE: Filter initialized with configuration ExpiresFilter[
- *    active=true, 
  *    excludedResponseStatusCode=[304], 
  *    default=null, 
  *    byType={

diff --git a/test/org/apache/catalina/filters/TestExpiresFilter.java b/test/org/apache/catalina/filters/TestExpiresFilter.java
index 1e8daba..17e3988 100644 (file)
--- a/test/org/apache/catalina/filters/TestExpiresFilter.java
+++ b/test/org/apache/catalina/filters/TestExpiresFilter.java
@@ -59,7 +59,6 @@ public class TestExpiresFilter extends TomcatBaseTest {
                 "modification plus 5 hours 3 minutes");
         filterDef.addInitParameter("ExpiresByType image/jpg", "A10000");
         filterDef.addInitParameter("ExpiresByType video/mpeg", "M20000");
-        filterDef.addInitParameter("ExpiresActive", "Off");
         filterDef.addInitParameter("ExpiresExcludedResponseStatusCodes",
                 "304, 503");
 

diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
index 71fa152..fdbaefe 100644 (file)
--- a/webapps/docs/changelog.xml
+++ b/webapps/docs/changelog.xml
@@ -66,8 +66,8 @@
         disabled by default. Based on a patch by Yair Lenga. (markt)
       </add>
       <add>
-        <bug>48998</bug>: Add the ExpiresFilter, a port of the httpd mod_expires
-        module. Patch provided by Cyrille Le Clerc. (markt)
+        <bug>48998</bug>, <bug>49617</bug>: Add the ExpiresFilter, a port of the
+        httpd mod_expires module. Patch provided by Cyrille Le Clerc. (markt)
       </add>
       <fix>
         <bug>49030</bug>: When initializing/starting/stopping connectors and

diff --git a/webapps/docs/config/filter.xml b/webapps/docs/config/filter.xml
index b00a2fc..5cc11d8 100644 (file)
--- a/webapps/docs/config/filter.xml
+++ b/webapps/docs/config/filter.xml
@@ -319,7 +319,7 @@ The expiry time can be fine-tuned by adding several '
     <tt>max-age</tt> directive of the <tt>Cache-Control</tt> header),</li>
     <li>the response status code is not excluded by the directive
     <tt>ExpiresExcludedResponseStatusCodes</tt>,</li>
-    <li>The <tt>Content-Type</tt> of the response matches one of the types
+    <li>the <tt>Content-Type</tt> of the response matches one of the types
     defined the in <tt>ExpiresByType</tt> directives or the
     <tt>ExpiresDefault</tt> directive is defined.</li>
     </ol>
@@ -446,8 +446,7 @@ The expiry time can be fine-tuned by adding several &#x27;
 &lt;/init-param&gt;
          </source>
          <p>
-         Note that this directive only has effect if <tt>ExpiresActive On</tt> has
-         been specified. It overrides, for the specified MIME type <i>only</i>, any
+         It overrides, for the specified MIME type <i>only</i>, any
          expiration date set by the <tt>ExpiresDefault</tt> directive.
          </p>
          <p>
@@ -483,13 +482,12 @@ The expiry time can be fine-tuned by adding several &#x27;
 org.apache.catalina.filters.ExpiresFilter.level = FINE
     </source>
     <p>
-    Sample of initialization log message :
+    Sample of initialization log message:
     </p>
     
     <source>
 Mar 26, 2010 2:01:41 PM org.apache.catalina.filters.ExpiresFilter init
 FINE: Filter initialized with configuration ExpiresFilter[
- active=true, 
  excludedResponseStatusCode=[304], 
  default=null, 
  byType={
@@ -499,7 +497,7 @@ FINE: Filter initialized with configuration ExpiresFilter[
     </source>
     <p>
     Sample of per-request log message where <tt>ExpiresFilter</tt> adds an
-    expiration date
+    expiration date:
     </p>
     
     <source>
@@ -508,7 +506,7 @@ FINE: Request "/tomcat.gif" with response status "200" content-type "image/gif",
     </source>
     <p>
     Sample of per-request log message where <tt>ExpiresFilter</tt> does not add
-    an expiration date
+    an expiration date:
     </p>
     
     <source>