You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by re...@apache.org on 2004/10/16 11:15:37 UTC
cvs commit: jakarta-tomcat-catalina/webapps/docs/config http.xml ajp.xml
remm 2004/10/16 02:15:37
Modified: webapps/docs/config http.xml ajp.xml
Log:
- Update connector docs with most of the current attributes.
- The common attributes are those which are present on the Connector class. The others depend on the protocol.
Revision Changes Path
1.18 +58 -44 jakarta-tomcat-catalina/webapps/docs/config/http.xml
Index: http.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-catalina/webapps/docs/config/http.xml,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- http.xml 1 Oct 2004 23:52:32 -0000 1.17
+++ http.xml 16 Oct 2004 09:15:37 -0000 1.18
@@ -57,18 +57,19 @@
<attributes>
- <attribute name="address" required="false">
- <p>For servers with more than one IP address, this attribute
- specifies which address will be used for listening on the specified
- port. By default, this port will be used on all IP addresses
- associated with the server.</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>
</attribute>
+ <attribute name="emptySessionPath" required="false">
+ <p>If set to <code>true</code>, all paths for session cookies will be set
+ to <code>/</code>. This can be useful for portlet specification implementations,
+ but will greatly affect performance if many applications are accessed on a given
+ server by the client.
+ If not specified, this attribute is set to <code>false</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
@@ -85,6 +86,27 @@
If not specified, this attribute is set to 2097152 (2 megabytes).</p>
</attribute>
+ <attribute name="protocol" required="false">
+ <p>This attribute value must be <code>HTTP/1.1</code> to use the HTTP
+ handler, which is the default.</p>
+ </attribute>
+
+ <attribute name="proxyName" required="false">
+ <p>If this <strong>Connector</strong> is being used in a proxy
+ configuration, configure this attribute to specify the server name
+ to be returned for calls to <code>request.getServerName()</code>.
+ See <a href="#Proxy Support">Proxy Support</a> for more
+ information.</p>
+ </attribute>
+
+ <attribute name="proxyPort" required="false">
+ <p>If this <strong>Connector</strong> is being used in a proxy
+ configuration, configure this attribute to specify the server port
+ to be returned for calls to <code>request.getServerPort()</code>.
+ See <a href="#Proxy Support">Proxy Support</a> for more
+ information.</p>
+ </attribute>
+
<attribute name="redirectPort" required="false">
<p>If this <strong>Connector</strong> is supporting non-SSL
requests, and a request is received for which a matching
@@ -124,6 +146,12 @@
</p>
</attribute>
+ <attribute name="xpoweredBy" required="false">
+ <p>Set this attribute to <code>true</code> to cause Tomcat to advertise
+ support for the Srevlet specification using the header recommended in the
+ specification. The default value is <code>false</code>.</p>
+ </attribute>
+
</attributes>
</subsection>
@@ -145,6 +173,13 @@
value is 10.</p>
</attribute>
+ <attribute name="address" required="false">
+ <p>For servers with more than one IP address, this attribute
+ specifies which address will be used for listening on the specified
+ port. By default, this port will be used on all IP addresses
+ associated with the server.</p>
+ </attribute>
+
<attribute name="bufferSize" required="false">
<p>The size (in bytes) of the buffer to be provided for input
streams created by this connector. By default, buffers of
@@ -240,27 +275,6 @@
to a particular port number on a particular IP address.</p>
</attribute>
- <attribute name="protocol" required="false">
- <p>This attribute value must be <code>HTTP/1.1</code> to use the HTTP
- handler, which is the default.</p>
- </attribute>
-
- <attribute name="proxyName" required="false">
- <p>If this <strong>Connector</strong> is being used in a proxy
- configuration, configure this attribute to specify the server name
- to be returned for calls to <code>request.getServerName()</code>.
- See <a href="#Proxy Support">Proxy Support</a> for more
- information.</p>
- </attribute>
-
- <attribute name="proxyPort" required="false">
- <p>If this <strong>Connector</strong> is being used in a proxy
- configuration, configure this attribute to specify the server port
- to be returned for calls to <code>request.getServerPort()</code>.
- See <a href="#Proxy Support">Proxy Support</a> for more
- information.</p>
- </attribute>
-
<attribute name="restrictedUserAgents" required="false">
<p>The value is a comma separated list of regular expressions matching
user-agents of HTTP clients for which HTTP/1.1 or HTTP/1.0 keep alive
@@ -269,12 +283,28 @@
The default value is an empty String (regexp matching disabled).</p>
</attribute>
+ <attribute name="server" required="false">
+ <p>The Server header for the http response.
+ Unless your paranoid, you won't need this feature.
+ </p>
+ </attribute>
+
<attribute name="socketBuffer" required="false">
<p>The size (in bytes) of the buffer to be provided for socket
output buffering. -1 can be specified to disable the use of a buffer.
By default, a buffers of 9000 bytes will be used.</p>
</attribute>
+ <attribute name="strategy" required="false">
+ <p>The thread pooling strategy which will be used. The default strategy does
+ not use a master thread, but a more conventional strategy using a
+ master listener thread can be used by setting "ms" as this attribute's value.
+ The master strategy will work significantly better using the threadPriority
+ attribute, which will apply only to the thread which listens on the server socket.
+ This is set to <code>lf</code> by default.
+ </p>
+ </attribute>
+
<attribute name="tcpNoDelay" required="false">
<p>If set to <code>true</code>, the TCP_NO_DELAY option will be
set on the server socket, which improves performance under most
@@ -286,22 +316,6 @@
The default value is <code>java.lang.Thread#NORM_PRIORITY</code>.
See the JavaDoc for the java.lang.Thread class for more details on
what this priority means.
- </p>
- </attribute>
-
- <attribute name="server" required="false">
- <p>The Server header for the http response.
- Unless your paranoid, you won't need this feature.
- </p>
- </attribute>
-
- <attribute name="strategy" required="false">
- <p>The thread pooling strategy which will be used. The default strategy does
- not use a master thread, but a more conventional strategy using a
- master listener thread can be used by setting "ms" as this attribute's value.
- The master strategy will work significantly better using the threadPriority
- attribute, which will apply only to the thread which listens on the server socket.
- This is set to <code>lf</code> by default.
</p>
</attribute>
1.10 +102 -17 jakarta-tomcat-catalina/webapps/docs/config/ajp.xml
Index: ajp.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-catalina/webapps/docs/config/ajp.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- ajp.xml 23 Sep 2004 06:55:25 -0000 1.9
+++ ajp.xml 16 Oct 2004 09:15:37 -0000 1.10
@@ -51,18 +51,19 @@
<attributes>
- <attribute name="address" required="false">
- <p>For servers with more than one IP address, this attribute
- specifies which address will be used for listening on the specified
- port. By default, this port will be used on all IP addresses
- associated with the server.</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>
</attribute>
+ <attribute name="emptySessionPath" required="false">
+ <p>If set to <code>true</code>, all paths for session cookies will be set
+ to <code>/</code>. This can be useful for portlet specification implementations,
+ but will greatly affect performance if many applications are accessed on a given
+ server by the client.
+ If not specified, this attribute is set to <code>false</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
@@ -73,12 +74,33 @@
</attribute>
<attribute name="maxPostSize" required="false">
- <p>The maximum size in bytes of the POST which will be handled by
- the container FORM URL parameter parsing. The feature can be disbled by
- setting this attribute to a value inferior or equal to 0.
+ <p>The maximum size in bytes of the POST which will be handled by
+ the container FORM URL parameter parsing. The feature can be disbled by
+ setting this attribute to a value inferior or equal to 0.
If not specified, this attribute is set to 2097152 (2 megabytes).</p>
</attribute>
+ <attribute name="protocol" required="false">
+ <p>This attribute value must be <code>AJP/1.3</code> to use the AJP
+ handler.</p>
+ </attribute>
+
+ <attribute name="proxyName" required="false">
+ <p>If this <strong>Connector</strong> is being used in a proxy
+ configuration, configure this attribute to specify the server name
+ to be returned for calls to <code>request.getServerName()</code>.
+ See <a href="#Proxy Support">Proxy Support</a> for more
+ information.</p>
+ </attribute>
+
+ <attribute name="proxyPort" required="false">
+ <p>If this <strong>Connector</strong> is being used in a proxy
+ configuration, configure this attribute to specify the server port
+ to be returned for calls to <code>request.getServerPort()</code>.
+ See <a href="#Proxy Support">Proxy Support</a> for more
+ information.</p>
+ </attribute>
+
<attribute name="redirectPort" required="false">
<p>If this <strong>Connector</strong> is supporting non-SSL
requests, and a request is received for which a matching
@@ -91,7 +113,8 @@
<p>Set this attribute to the name of the protocol you wish to have
returned by calls to <code>request.getScheme()</code>. For
example, you would set this attribute to "<code>https</code>"
- for an SSL Connector. The default value is "<code>http</code>".</p>
+ for an SSL Connector. The default value is "<code>http</code>".
+ See <a href="#SSL Support">SSL Support</a> for more information.</p>
</attribute>
<attribute name="secure" required="false">
@@ -109,14 +132,20 @@
<attribute name="useBodyEncodingForURI" required="false">
<p>This specifies if the encoding specified in contentType should be used
- for URI query parameters, instead of using the URIEncoding. This
- setting is present for compatibility with Tomcat 4.1.x, where the
- encoding specified in the contentType, or explicitely set using
+ for URI query parameters, instead of using the URIEncoding. This
+ setting is present for compatibility with Tomcat 4.1.x, where the
+ encoding specified in the contentType, or explicitely set using
Request.setCharacterEncoding method was also used for the parameters from
the URL. The default value is <code>false</code>.
</p>
</attribute>
+ <attribute name="xpoweredBy" required="false">
+ <p>Set this attribute to <code>true</code> to cause Tomcat to advertise
+ support for the Srevlet specification using the header recommended in the
+ specification. The default value is <code>false</code>.</p>
+ </attribute>
+
</attributes>
</subsection>
@@ -134,9 +163,65 @@
<attributes>
- <attribute name="protocol" required="true">
- <p>This attribute value must be <code>AJP/1.3</code> to use the AJP
- handler.</p>
+ <attribute name="address" required="false">
+ <p>For servers with more than one IP address, this attribute
+ specifies which address will be used for listening on the specified
+ port. By default, this port will be used on all IP addresses
+ associated with the server.</p>
+ </attribute>
+
+ <attribute name="backlog" required="false">
+ <p>The maximum queue length for incoming connection requests when
+ all possible request processing threads are in use. Any requests
+ received when the queue is full will be refused. The default
+ value is 10.</p>
+ </attribute>
+
+ <attribute name="maxSpareThreads" required="false">
+ <p>The maximum number of unused request processing threads that
+ will be allowed to exist until the thread pool starts stopping the
+ unnecessary threads. The default value is 50.</p>
+ </attribute>
+
+ <attribute name="maxThreads" required="false">
+ <p>The maximum number of request processing threads to be created
+ by this <strong>Connector</strong>, which therefore determines the
+ maximum number of simultaneous requests that can be handled. If
+ not specified, this attribute is set to 200.</p>
+ </attribute>
+
+ <attribute name="minSpareThreads" required="false">
+ <p>The number of request processing threads that will be created
+ when this <strong>Connector</strong> is first started. The connector
+ will also make sure it has the specified number of idle processing
+ threads available. This attribute should be set to a value smaller
+ than that set for <code>maxThreads</code>. The default value is 4.</p>
+ </attribute>
+
+ <attribute name="port" required="true">
+ <p>The TCP port number on which this <strong>Connector</strong>
+ will create a server socket and await incoming connections. Your
+ operating system will allow only one server application to listen
+ to a particular port number on a particular IP address.</p>
+ </attribute>
+
+ <attribute name="tcpNoDelay" required="false">
+ <p>If set to <code>true</code>, the TCP_NO_DELAY option will be
+ set on the server socket, which improves performance under most
+ circumstances. This is set to <code>true</code> by default.</p>
+ </attribute>
+
+ <attribute name="soTimeout" required="false">
+ <p>The number of milliseconds this <strong>Connector</strong> will wait,
+ after accepting a connection, for the request URI line to be
+ presented. The default value is 60000 (i.e. 60 seconds).</p>
+ </attribute>
+
+ <attribute name="tomcatAuthentication" required="false">
+ <p>If set to <code>true</code>, the authetication will be done in Tomcat.
+ Otherwise, the authenticated principal will be propagated from the native
+ webaserver and used for authorization in Tomcat.
+ The default value is <code>true</code>.</p>
</attribute>
</attributes>
---------------------------------------------------------------------
To unsubscribe, e-mail: tomcat-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: tomcat-dev-help@jakarta.apache.org