This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 10.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/10.0.x by this push:
new d083b65 Correct docs for common Connector properties
d083b65 is described below
commit d083b65ccc09a100b255a6d06e6981acacb2b87a
Author: Mark Thomas <[email protected]>
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 | 64 +++++++++++++++++++++++++++------------
webapps/docs/config/http.xml | 72 ++++++++++++++++++++++----------------------
3 files changed, 86 insertions(+), 55 deletions(-)
diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
index 73b61bf..4463d53 100644
--- a/webapps/docs/changelog.xml
+++ b/webapps/docs/changelog.xml
@@ -116,6 +116,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 81c825a..c59c7bd 100644
--- a/webapps/docs/config/ajp.xml
+++ b/webapps/docs/config/ajp.xml
@@ -84,16 +84,10 @@
<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 name="allowBackslash" required="false">
+ <p>If this is <code>true</code> the '\' character will be permitted as a
+ path delimiter.</p>
+ <p>If not specified, the default value of <code>false</code> will be
used.</p>
</attribute>
<attribute name="allowTrace" required="false">
@@ -107,6 +101,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
@@ -127,11 +130,21 @@
If not specified the default value is <code>reject</code>.</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="enforceEncodingInGetWriter" required="false">
+ <p>If this is <code>true</code> then
+ a call to <code>Response.getWriter()</code> if no character encoding
+ has been specified will result in subsequent calls to
+ <code>Response.getCharacterEncoding()</code> returning
+ <code>ISO-8859-1</code> and the <code>Content-Type</code> response header
+ will include a <code>charset=ISO-8859-1</code> component.
(SRV.15.2.22.1)</p>
+ <p>If not specified, the default specification compliant value of
+ <code>true</code> will be used.</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="maxParameterCount" required="false">
@@ -332,6 +345,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>
@@ -428,10 +453,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 6a7c2f7..2245b65 100644
--- a/webapps/docs/config/http.xml
+++ b/webapps/docs/config/http.xml
@@ -97,31 +97,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
@@ -162,11 +137,10 @@
<code>true</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 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">
@@ -460,6 +434,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
@@ -505,18 +504,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: [email protected]
For additional commands, e-mail: [email protected]
