You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2022/03/15 21:15:09 UTC

[tomcat] branch 9.0.x updated: Correct docs for common Connector properties

This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/9.0.x by this push:
     new 8fa2667  Correct docs for common Connector properties
8fa2667 is described below

commit 8fa2667f132c96bb8f81744b98d2dc13d5ce98d7
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Tue Mar 15 21:06:02 2022 +0000

    Correct docs for common Connector properties
---
 webapps/docs/changelog.xml   |  5 +++
 webapps/docs/config/ajp.xml  | 51 ++++++++++++++++++-------------
 webapps/docs/config/http.xml | 72 ++++++++++++++++++++++----------------------
 3 files changed, 71 insertions(+), 57 deletions(-)

diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
index 816ee53..ea5fc14 100644
--- a/webapps/docs/changelog.xml
+++ b/webapps/docs/changelog.xml
@@ -111,6 +111,11 @@
         <bug>65952</bug>: Align <code>--add-opens</code> configuration for jsvc
         with the current Tomcat scripts. (markt)
       </fix>
+      <fix>
+        Correct the AJP and HTTP/1.1 Connector configuration pages in the
+        documentation web application to show which attributes are applicable to
+        all Connectors and which are implementation specific. (markt)
+      </fix>
     </changelog>
   </subsection>
   <subsection name="Other">
diff --git a/webapps/docs/config/ajp.xml b/webapps/docs/config/ajp.xml
index 87e83a4..be5cd0f 100644
--- a/webapps/docs/config/ajp.xml
+++ b/webapps/docs/config/ajp.xml
@@ -81,18 +81,6 @@
 
   <attributes>
 
-    <attribute name="ajpFlush" required="false">
-      <p>A boolean value which can be used to enable or disable sending
-      AJP flush messages to the fronting proxy whenever an explicit
-      flush happens. The default value is <code>true</code>.<br/>
-      An AJP flush message is a SEND_BODY_CHUNK packet with no body content.
-      Proxy implementations like mod_jk or mod_proxy_ajp will flush the
-      data buffered in the web server to the client when they receive
-      such a packet. Setting this to <code>false</code> can reduce
-      AJP packet traffic but might delay sending packets to the client.
-      At the end of the response, AJP does always flush to the client.</p>
-    </attribute>
-
     <attribute name="allowTrace" required="false">
       <p>A boolean value which can be used to enable or disable the TRACE
       HTTP method. If not specified, this attribute is set to false.</p>
@@ -104,6 +92,15 @@
       30000 (30 seconds).</p>
     </attribute>
 
+    <attribute name="discardFacades" required="false">
+      <p>A boolean value which can be used to enable or disable the recycling
+      of the facade objects that isolate the container internal request
+      processing objects. If set to <code>true</code> the facades will be
+      set for garbage collection after every request, otherwise they will be
+      reused. This setting has no effect when the security manager is enabled.
+      If not specified, this attribute is set to <code>true</code>.</p>
+    </attribute>
+
     <attribute name="enableLookups" required="false">
       <p>Set to <code>true</code> if you want calls to
       <code>request.getRemoteHost()</code> to perform DNS lookups in
@@ -128,11 +125,10 @@
       set.</p>
     </attribute>
 
-    <attribute name="maxHeaderCount" required="false">
-      <p>The maximum number of headers in a request that are allowed by the
-      container. A request that contains more headers than the specified limit
-      will be rejected. A value of less than 0 means no limit.
-      If not specified, a default of 100 is used.</p>
+    <attribute name="maxCookieCount" required="false">
+      <p>The maximum number of cookies that are permitted for a request. A value
+      of less than zero means no limit. If not specified, a default value of 200
+      will be used.</p>
     </attribute>
 
     <attribute name="maxParameterCount" required="false">
@@ -339,6 +335,18 @@
       configured with <code>::</code>.</p>
     </attribute>
 
+    <attribute name="ajpFlush" required="false">
+      <p>A boolean value which can be used to enable or disable sending
+      AJP flush messages to the fronting proxy whenever an explicit
+      flush happens. The default value is <code>true</code>.<br/>
+      An AJP flush message is a SEND_BODY_CHUNK packet with no body content.
+      Proxy implementations like mod_jk or mod_proxy_ajp will flush the
+      data buffered in the web server to the client when they receive
+      such a packet. Setting this to <code>false</code> can reduce
+      AJP packet traffic but might delay sending packets to the client.
+      At the end of the response, AJP does always flush to the client.</p>
+    </attribute>
+
     <attribute name="allowedRequestAttributesPattern" required="false">
       <p>The AJP protocol passes some information from the reverse proxy to the
       AJP connector using request attributes. These attributes are:</p>
@@ -435,10 +443,11 @@
       maxConnections feature and connections will not be counted.</p>
     </attribute>
 
-    <attribute name="maxCookieCount" required="false">
-      <p>The maximum number of cookies that are permitted for a request. A value
-      of less than zero means no limit. If not specified, a default value of 200
-      will be used.</p>
+    <attribute name="maxHeaderCount" required="false">
+      <p>The maximum number of headers in a request that are allowed by the
+      container. A request that contains more headers than the specified limit
+      will be rejected. A value of less than 0 means no limit.
+      If not specified, a default of 100 is used.</p>
     </attribute>
 
     <attribute name="maxThreads" required="false">
diff --git a/webapps/docs/config/http.xml b/webapps/docs/config/http.xml
index 06b27cb..c79a5dc 100644
--- a/webapps/docs/config/http.xml
+++ b/webapps/docs/config/http.xml
@@ -88,31 +88,6 @@
       30000 (30 seconds).</p>
     </attribute>
 
-    <attribute name="continueResponseTiming" required="false">
-      <p>When to respond with a <code>100</code> intermediate response code to a
-      request containing an <code>Expect: 100-continue</code> header.
-      The following values may used:
-      <ul>
-      <li><code>immediately</code> - an intermediate 100 status response
-      will be returned as soon as practical</li>
-      <li><code>onRead</code> - an intermediate 100 status
-      response will be returned only when the Servlet reads the request body,
-      allowing the servlet to inspect the headers and possibly respond
-      before the user agent sends a possibly large request body.</li>
-      </ul>
-      </p>
-    </attribute>
-
-    <attribute name="defaultSSLHostConfigName" required="false">
-      <p>The name of the default <strong>SSLHostConfig</strong> that will be
-      used for secure connections (if this connector is configured for secure
-      connections) if the client connection does not provide SNI or if the SNI
-      is provided but does not match any configured
-      <strong>SSLHostConfig</strong>. If not specified the default value of
-      <code>_default_</code> will be used. Provided values are always converted
-      to lower case.</p>
-    </attribute>
-
     <attribute name="discardFacades" required="false">
       <p>A boolean value which can be used to enable or disable the recycling
       of the facade objects that isolate the container internal request
@@ -148,11 +123,10 @@
       set.</p>
     </attribute>
 
-    <attribute name="maxHeaderCount" required="false">
-      <p>The maximum number of headers in a request that are allowed by the
-      container. A request that contains more headers than the specified limit
-      will be rejected. A value of less than 0 means no limit.
-      If not specified, a default of 100 is used.</p>
+    <attribute name="maxCookieCount" required="false">
+      <p>The maximum number of cookies that are permitted for a request. A value
+      of less than zero means no limit. If not specified, a default value of 200
+      will be used.</p>
     </attribute>
 
     <attribute name="maxParameterCount" required="false">
@@ -456,6 +430,31 @@
       </p>
     </attribute>
 
+    <attribute name="continueResponseTiming" required="false">
+      <p>When to respond with a <code>100</code> intermediate response code to a
+      request containing an <code>Expect: 100-continue</code> header.
+      The following values may used:
+      <ul>
+      <li><code>immediately</code> - an intermediate 100 status response
+      will be returned as soon as practical</li>
+      <li><code>onRead</code> - an intermediate 100 status
+      response will be returned only when the Servlet reads the request body,
+      allowing the servlet to inspect the headers and possibly respond
+      before the user agent sends a possibly large request body.</li>
+      </ul>
+      </p>
+    </attribute>
+
+    <attribute name="defaultSSLHostConfigName" required="false">
+      <p>The name of the default <strong>SSLHostConfig</strong> that will be
+      used for secure connections (if this connector is configured for secure
+      connections) if the client connection does not provide SNI or if the SNI
+      is provided but does not match any configured
+      <strong>SSLHostConfig</strong>. If not specified the default value of
+      <code>_default_</code> will be used. Provided values are always converted
+      to lower case.</p>
+    </attribute>
+
     <attribute name="disableUploadTimeout" required="false">
       <p>This flag allows the servlet container to use a different, usually
       longer connection timeout during data upload. If not specified, this
@@ -501,18 +500,19 @@
       maxConnections feature and connections will not be counted.</p>
     </attribute>
 
-    <attribute name="maxCookieCount" required="false">
-      <p>The maximum number of cookies that are permitted for a request. A value
-      of less than zero means no limit. If not specified, a default value of 200
-      will be used.</p>
-    </attribute>
-
     <attribute name="maxExtensionSize" required="false">
       <p>Limits the total length of chunk extensions in chunked HTTP requests.
       If the value is <code>-1</code>, no limit will be imposed. If not
       specified, the default value of <code>8192</code> will be used.</p>
     </attribute>
 
+    <attribute name="maxHeaderCount" required="false">
+      <p>The maximum number of headers in a request that are allowed by the
+      container. A request that contains more headers than the specified limit
+      will be rejected. A value of less than 0 means no limit.
+      If not specified, a default of 100 is used.</p>
+    </attribute>
+
     <attribute name="maxHttpHeaderSize" required="false">
       <p>The maximum size of the request and response HTTP header, specified
       in bytes. If not specified, this attribute is set to 8192 (8 KB).</p>

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