markt 2005/05/26 14:12:21
Modified: webapps/tomcat-docs/config connectors.xml coyote.xml
http11.xml jk.xml jk2.xml project.xml webapp.xml
webapps/tomcat-docs tomcat-docs.xsl
Added: webapps/tomcat-docs/config ajp13.xml coyotejk.xml
Log:
Improve the TC4 connector documentation
- separate web server side connectors and tomcat side connectors for JK/AJP
- seperate current and deprecated connectors
- fix various typos
Revision Changes Path
1.5 +36 -24
jakarta-tomcat-4.0/webapps/tomcat-docs/config/connectors.xml
Index: connectors.xml
===================================================================
RCS file:
/home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/connectors.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- connectors.xml 14 Apr 2005 19:02:52 -0000 1.4
+++ connectors.xml 26 May 2005 21:12:20 -0000 1.5
@@ -61,9 +61,10 @@
<tr><th colspan="4">HTTP Connectors for Tomcat 4.x</th></tr>
<tr><th>Client</th><th>Protocol</th><th>Tomcat
className</th><th>Notes</th></tr>
-<tr><td>Ancient browser</td><td>HTTP/1.0</td>
- <td>org.apache.catalina.connector.http10.HttpConnector</td>
- <td>Deprecated<br/>See <a href="http11.html"> HTTP/1.1</a></td>
+<tr><td>Modern browser</td><td>HTTP/1.1</td>
+ <td>org.apache.coyote.tomcat4.CoyoteConnector</td>
+ <td>Current practice<br/>See <a href="coyote.html"> Coyote HTTP/1.1</a>
+ </td>
</tr>
<tr><td>Modern browser</td><td>HTTP/1.1</td>
@@ -71,15 +72,33 @@
<td>Deprecated<br/>See <a href="http11.html"> HTTP/1.1</a></td>
</tr>
-<tr><td>Modern browser</td><td>HTTP/1.1</td>
- <td>org.apache.coyote.tomcat4.CoyoteConnector</td>
- <td>Current practice<br/>See <a href="coyote.html"> Coyote HTTP/1.1</a>
- </td>
+<tr><td>Ancient browser</td><td>HTTP/1.0</td>
+ <td>org.apache.catalina.connector.http10.HttpConnector</td>
+ <td>Deprecated<br/>See <a href="http11.html"> HTTP/1.1</a></td>
</tr>
+
<tr><th colspan="4">Web Server Connectors</th></tr>
-<tr><th>Web Server Side</th><th>Protocol</th><th>Tomcat
Site</th><th>Notes</th></tr>
+<tr><th>Web Server Side</th><th>Protocol</th><th>Tomcat
Side</th><th>Notes</th></tr>
+
+<tr>
+ <td>JK</td><td>AJP/1.3</td>
+ <td>CoyoteConnector with JkCoyoteHandler</td>
+ <td>Current<br/>mod_jk supports load balancing.
+ Enabled by default in 4.1; works in 4.0. See <a href="jk.html">JK</a>
+ and <a href="coyotejk.html">Coyote JK</a>.
+ </td>
+</tr>
+
+<tr>
+ <td>mod_proxy with AJP enabled</td><td>AJP/1.3</td>
+ <td>CoyoteConnector with JkCoyoteHandler</td>
+ <td>Current<br/>Available for Apache httpd 2.x and included by default
with
+ 2.2. See <a
href="http://httpd.apache.org/docs-2.1/mod/mod_proxy_ajp.html";>
+ mod_proxy_ajp</a> and <a href="coyotejk.html">Coyote JK</a>
+ </td>
+</tr>
<tr>
<td>mod_jserv</td><td>AJP/1.2</td>
@@ -89,19 +108,19 @@
</tr>
<tr>
- <td>mod_jk</td><td>AJP/1.3</td>
+ <td>JK2</td><td>AJP/1.3</td>
<td>CoyoteConnector with JkCoyoteHandler</td>
- <td>Current<br/>mod_jk supports load balancing.
- Enabled by default in 4.1; works in 4.0. See <a
href="jk.html">Coyote JK</a>
+ <td>Deprecated<br/>Enabled by default in 4.1.
+ mod_jk2 supports in-process JVM and load balancing.
+ See <a href="jk2.html">JK2</a>
</td>
</tr>
<tr>
- <td>mod_jk2</td><td>AJP/1.3</td>
- <td>CoyoteConnector with JkCoyoteHandler</td>
- <td>Deprecated<br/>Enabled by default in 4.1.
- mod_jk2 supports in-process JVM and load balancing.
- See <a href="jk.html">Coyote JK</a>
+ <td>JK or JK2</td><td>AJP/1.3</td>
+ <td>org.apache.ajp.tomcat4.Ajp13Connector</td>
+ <td>Deprecated<br/>
+ See <a href="ajp13.html">AJP/1.3</a>
</td>
</tr>
@@ -110,18 +129,11 @@
<td>WarpConnector</td>
<td>Deprecated<br/>Not for Win32; no in-process nor load balancing;
works in 4.x.
- Use <a href="http://apr.apache.org/";>APR</a>.
+ Uses <a href="http://apr.apache.org/";>APR</a>.
Supported Apache-2.0 and Apache-1.3).
See <a href="webapp.html">Webapp</a>
</td>
</tr>
-<tr>
- <td>mod_proxy with AJP enabled</td><td>AJP/1.3</td>
- <td>CoyoteConnector with JkCoyoteHandler</td>
- <td>Current<br/>Available for Apache httd 2.x and included by default
with
- 2.2. See <a href="jk.html">Coyote JK</a>
- </td>
-</tr>
</table>
</section>
<section name="Why a Tomcat connector with a native Web Server?">
1.11 +2 -2 jakarta-tomcat-4.0/webapps/tomcat-docs/config/coyote.xml
Index: coyote.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/coyote.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- coyote.xml 14 Apr 2005 19:02:52 -0000 1.10
+++ coyote.xml 26 May 2005 21:12:20 -0000 1.11
@@ -27,8 +27,8 @@
request processing and create the response.</p>
<p>If you wish to configure the <strong>Connector</strong> that is used
- for connections to web servers using the AJP protocol (such as the
- <code>JK</code> connector), see <a href="jk.html">here</a> instead.</p>
+ for connections to web servers using the AJP protocol see the
+ <a href="coyotejk.html">Coyote JK</a> Conector instead.</p>
<p>At server startup time, this <strong>Connector</strong> will create a
number of request processing threads (based on the value configured for
1.8 +1 -1 jakarta-tomcat-4.0/webapps/tomcat-docs/config/http11.xml
Index: http11.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/http11.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- http11.xml 21 Feb 2005 22:54:23 -0000 1.7
+++ http11.xml 26 May 2005 21:12:20 -0000 1.8
@@ -17,7 +17,7 @@
<section name="Introduction">
<p><b>IMPORTANT NOTE: The HTTP/1.1 connector is now deprecated. Use
- the Coyote HTTP/1.1 connector instead.</b></p>
+ the <a href="coyote.html">Coyote HTTP/1.1 Connector</a> instead.</b></p>
<p><b>IMPORTANT NOTE: This connector MUST NOT be used in conjunction
with any <a href="context.html">Context</a> element that has the
1.13 +17 -151 jakarta-tomcat-4.0/webapps/tomcat-docs/config/jk.xml
Index: jk.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/jk.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- jk.xml 14 Apr 2005 19:02:52 -0000 1.12
+++ jk.xml 26 May 2005 21:12:20 -0000 1.13
@@ -15,154 +15,19 @@
<section name="Introduction">
-
- <p>The <strong>JK Connector</strong> element represents a
- <strong>Connector</strong> component that communicates with a web
- connector via the <code>JK</code> protocol (also known as the AJP
protocol).
- This is used for cases where you wish to invisibly integrate Tomcat 4 into
- an existing (or new) Apache installation, and you want Apache to handle
- the static content contained in the web application, and/or utilize
- Apache's SSL processing. In many application environments, this will
- result in better overall performance than running your applications under
- Tomcat stand-alone using the <a href="coyote.html">Coyote HTTP/1.1
- Connector</a>. However, the only way to know for sure whether it will
- provide better performance for <strong>your</strong> application is to try
- it both ways.</p>
-
- <p>This connector supports load balancing when used in conjunction with
- the <code>jvmRoute</code> attribute of the
- <a href="engine.html">Engine</a>.</p>
-
-</section>
-
-
-<section name="Attributes">
-
- <subsection name="Common Attributes">
-
- <p>All implementations of <strong>Connector</strong>
- support the following attributes:</p>
-
- <attributes>
-
- <attribute name="className" required="true">
- <p>Java class name of the implementation to use. This class must
- implement the <code>org.apache.catalina.Connector</code> interface.
- You must specify the standard value defined below.</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
- order to return the actual host name of the remote client. Set
- to <code>false</code> to skip the DNS lookup and return the IP
- address in String form instead (thereby improving performance).
- By default, DNS lookups are disabled.</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
- <code><security-constraint></code> requires SSL transport,
- Catalina will automatically redirect the request to the port
- number specified here.</p>
- </attribute>
-
- <attribute name="scheme" required="false">
- <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>
- </attribute>
-
- <attribute name="secure" required="false">
- <p>Set this attribute to <code>true</code> if you wish to have
- calls to <code>request.isSecure()</code> to return <code>true</code>
- for requests received by this Connector (you would want this on an
- SSL Connector). The default value is <code>false</code>.</p>
- </attribute>
-
- </attributes>
-
- </subsection>
-
- <subsection name="Standard Implementation">
-
- <p>The standard implementation of <strong>JK Connector</strong> is
- <strong>org.apache.ajp.tomcat4.Ajp13Connector</strong>.</p>
-
- <p><strong>This implementation supports the JK 1.3 and 1.4 protocols (also
known as AJP 1.3 and 1.4).</strong></p>
-
- <p>It supports the following additional attributes (in addition to the
- common attributes listed above):</p>
-
- <attributes>
-
- <attribute name="acceptCount" 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="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="debug" required="false">
- <p>The debugging detail level of log messages generated by this
- component, with higher numbers creating more detailed output.
- If not specified, this attribute is set to zero (0).</p>
- </attribute>
-
- <attribute name="maxProcessors" 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 20.</p>
- <p><b>NOTE:</b>For Apache 1.3 on Unix there is a 1 to 1 mapping
- between httpd processes and Ajp13Processors. You must configure
- maxProcessors to be greater than or equal to the maximum number
- of httpd processes your Apache web server spawns.</p>
- </attribute>
-
- <attribute name="minProcessors" required="false">
- <p>The number of request processing threads that will be created
- when this <strong>Connector</strong> is first started. This
- attribute should be set to a value smaller than that set for
- <code>maxProcessors</code>. The default value is 5.</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="tomcatAuthentication" required="false">
- <p>This flag, which value defaults to <code>true</code>, indicates
- whether or not authentication will be handled by Tomcat or the native
- web server. If the attribute value is <code>true</code>, any pricipal
- authenticated by the native web server will be ignored, and Tomcat
will
- take care of the authentication. If the attribute value
- is <code>false</code>, Tomcat will not attempt to authenticate
- a principal if the native web server has already authenticated one.</p>
- </attribute>
-
- </attributes>
-
- </subsection>
-
-</section>
-
-
-<section name="Nested Components">
-
- <p></p>
+ <p>The <strong>JK Connector</strong> is a web server component used to
+ invisibly integrate Tomcat
with a web server such as Apache or IIS.
+ Communication between the web server and Tomcat is via the <code>JK</code>
+ protocol (also known as the <code>AJP</code> protocol).</p>
+
+ <p>Tomact is usually integrated with a web server in cases where you want
+ the web server to handle the static content contained in the web
application,
+ and/or utilize the web server's SSL processing. In many application
+ environments, this will result in better overall performance than running
+ your applications under Tomcat stand-alone using the <a href="coyote.html">
+ Coyote HTTP/1.1 Connector</a>. However, the only way to know for sure
whether
+ it will provide better performance for <strong>your</strong> application is
+ to try it both ways.</p>
</section>
@@ -237,7 +102,7 @@
worker at the moment.</li>
<li><strong>Web Server Plug-in/Tomcat Redirector</strong> -
For Tomcat to cooperate with any web server it needs an
"agent"
- to reside in the web server and send him servlet requests.
+ to reside in the web server and send Tomcat servlet requests.
This is the web server plug-in, and in our case the web server
plug-in is mod_jk. The redirector usually comes in the shape
of
a DLL or shared object module that you plug into
@@ -246,7 +111,7 @@
configure the web server plug-in so that it knows where
the different Tomcat workers are and to which of them
it should forward requests. This information, accompanied with
- some internal parameter, such as the log level, comprises
+ some internal parameters, such as the log level, comprises
the plug-in configuration.</li>
<li><strong>Web Server Configuration</strong> - Each web
server
has some configuration that defines its behavior, e.g. on
which
@@ -315,7 +180,8 @@
<code>JkMount URL_PREFIX WORKER_NAME</code>. You can use the
JkMount directive at the top level or inside
<VirtualHost>
sections of your httpd.conf file.</li>
- <li>The directive <tt>JkRequestLogFormat</tt> (Apache 1.3
only) will configure the format of mod_jk
+ <li>The directive <tt>JkRequestLogFormat</tt> (Apache 1.3 only)
+ will configure the format of mod_jk
individual request logging. Request logging is configured and
enabled on a per
virtual host basis. To enable request logging for a virtual
host just add
a JkRequestLogFormat config.
1.10 +19 -152 jakarta-tomcat-4.0/webapps/tomcat-docs/config/jk2.xml
Index: jk2.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/jk2.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- jk2.xml 14 Apr 2005 19:02:52 -0000 1.9
+++ jk2.xml 26 May 2005 21:12:20 -0000 1.10
@@ -16,164 +16,31 @@
<section name="Introduction">
- <p><b>IMPORTANT NOTE: The Coyote JK 2 connector is now deprecated. Use the
- JK connector instead or, for Apache http 2.x only, use mod_proxy with AJP
- enabled.</b></p>
-
- <p>The <strong>JK 2 Connector</strong> element represents a
- <strong>Connector</strong> component that communicates with a web
- connector via the <code>AJP</code> protocol. This is used for cases
- where you wish to invisibly integrate Tomcat 4 into an existing (or new)
- Apache installation, and you want Apache to handle the static content
- contained in the web application, and/or utilize Apache's SSL
- processing. In many application environments, this will result in
- better overall performance than running your applications under
- Tomcat stand-alone using the <a href="http11.html">HTTP/1.1 Connector</a>.
- However, the only way to know for sure whether it will provide better
- performance for <strong>your</strong> application is to try it both
- ways.</p>
-
- <p>This connector supports load balancing when used in conjunction with
- the <code>jvmRoute</code> attribute of the
- <a href="engine.html">Engine</a>.</p>
-
-</section>
-
-
-<section name="Attributes">
-
- <subsection name="Common Attributes">
-
- <p>All implementations of <strong>Connector</strong>
- support the following attributes:</p>
-
- <attributes>
-
- <attribute name="className" required="true">
- <p>Java class name of the implementation to use. This class must
- implement the <code>org.apache.catalina.Connector</code> interface.
- You must specify the standard value defined below.</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
- order to return the actual host name of the remote client. Set
- to <code>false</code> to skip the DNS lookup and return the IP
- address in String form instead (thereby improving performance).
- By default, DNS lookups are disabled.</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
- <code><security-constraint></code> requires SSL transport,
- Catalina will automatically redirect the request to the port
- number specified here.</p>
- </attribute>
-
- <attribute name="scheme" required="false">
- <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>
- </attribute>
-
- <attribute name="secure" required="false">
- <p>Set this attribute to <code>true</code> if you wish to have
- calls to <code>request.isSecure()</code> to return <code>true</code>
- for requests received by this Connector (you would want this on an
- SSL Connector). The default value is <code>false</code>.</p>
- </attribute>
-
- <attribute name="URIEncoding" required="false">
- <p>This specifies the character encoding used to decode the URI bytes,
- after %xx decoding the URL. If not specified, ISO-8859-1 will be used.
- </p>
- </attribute>
-
- <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.27 and earlier.
- The default value is <code>true</code>.
- </p>
- </attribute>
-
- </attributes>
-
- </subsection>
-
- <subsection name="Standard Implementation">
-
- <p>The standard implementation of <strong>JK 2 Connector</strong> is
- <strong>org.apache.coyote.tomcat4.CoyoteConnector</strong>, but you
- must specify the protocolHandlerClassName attribute (see below).</p>
-
- <p><strong>This implementation supports the AJP/1.3 protocol.</strong></p>
-
- <p>It supports the following additional attributes (in addition to the
- common attributes listed above):</p>
-
- <attributes>
-
- <attribute name="acceptCount" 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="debug" required="false">
- <p>The debugging detail level of log messages generated by this
- component, with higher numbers creating more detailed output.
- If not specified, this attribute is set to zero (0).</p>
- </attribute>
-
- <attribute name="maxProcessors" 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 20.</p>
- </attribute>
-
- <attribute name="minProcessors" required="false">
- <p>The number of request processing threads that will be created
- when this <strong>Connector</strong> is first started. This
- attribute should be set to a value smaller than that set for
- <code>maxProcessors</code>. The default value is 5.</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="protocolHandlerClassName" required="false">
- <p>This attribute value must be
- <code>org.apache.jk.server.JkCoyoteHandler</code> to use the JK 2
- handler.</p>
- </attribute>
-
- </attributes>
-
- </subsection>
-
-</section>
-
-
-<section name="Nested Components">
-
- <p></p>
+ <p><b>IMPORTANT NOTE: The JK 2 connector is now deprecated. Use
+ <a href="jk.html">JK</a> or
+ <a href="http://httpd.apache.org/docs-2.1/mod/mod_proxy_ajp.html";>
+ mod_proxy_ajp</a> instead.</b></p>
+
+ <p>The <strong>JK 2 Connector</strong> is a web server component used to
+ invisibly integrate Tomcat
with a web server such as Apache or IIS.
+ Communication between the web server and Tomcat is via the <code>JK</code>
+ protocol (also known as the <code>AJP</code> protocol).</p>
+
+ <p>Tomact is usually integrated with a web server in cases where you want
+ the web server to handle the static content contained in the web
application,
+ and/or utilize the web server's SSL processing. In many application
+ environments, this will result in better overall performance than running
+ your applications under Tomcat stand-alone using the <a href="coyote.html">
+ Coyote HTTP/1.1 Connector</a>. However, the only way to know for sure
whether
+ it will provide better performance for <strong>your</strong> application is
+ to try it both ways.</p>
</section>
<section name="Configuration HOWTOs">
- <p>Please refer to the <a href="../jk2/index.html">Coyote JK 2
documentation</a>
+ <p>Please refer to the <a href="../jk2/index.html">JK/JK2
documentation</a>
for HOWTOs and complete configuration information.</p>
</section>
1.13 +10 -2 jakarta-tomcat-4.0/webapps/tomcat-docs/config/project.xml
Index: project.xml
===================================================================
RCS file:
/home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/project.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- project.xml 14 Apr 2005 19:02:52 -0000 1.12
+++ project.xml 26 May 2005 21:12:20 -0000 1.13
@@ -21,13 +21,21 @@
<item name="Service" href="service.html"/>
</menu>
- <menu name="Connectors">
+ <menu name="Current Connectors">
<item name="JTC Connectors" href="connectors.html"/>
<item name="Coyote HTTP/1.1" href="coyote.html"/>
+ <item name="Coyote JK" href="coyotejk.html"/>
<item name="JK" href="jk.html"/>
+ <item name="mod_proxy_ajp"
+
href="http://httpd.apache.org/docs-2.1/mod/mod_proxy_ajp.html"/>
+ </menu>
+
+ <menu name="Deprecated Connectors">
+ <item name="JTC Connectors" href="connectors.html"/>
<item name="HTTP/1.1" href="http11.html"/>
- <item name="JK 2" href="jk2.html"/>
+ <item name="AJP/1.3" href="ajp13.html"/>
<item name="Webapp" href="webapp.html"/>
+ <item name="JK2" href="jk2.html"/>
</menu>
<menu name="Containers">
1.7 +7 -1 jakarta-tomcat-4.0/webapps/tomcat-docs/config/webapp.xml
Index: webapp.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/webapp.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- webapp.xml 12 Jan 2003 17:26:48 -0000 1.6
+++ webapp.xml 26 May 2005 21:12:20 -0000 1.7
@@ -16,6 +16,12 @@
<section name="Introduction">
+ <p><b>IMPORTANT NOTE: The Webapp connector is now deprecated. Use the
+ <a href="coyotejk.html">Coyote JK Connector</a> with
+ <a href="jk.html">JK</a> or
+ <a href="http://httpd.apache.org/docs-2.1/mod/mod_proxy_ajp.html";>
+ mod_proxy_ajp</a> instead.</b></p>
+
<p>The <strong>Webapp Connector</strong> element represents a
<strong>Connector</strong> component that communicates with a web
connector via the <code>WARP</code> protocol. This is used for cases
@@ -25,7 +31,7 @@
processing. In many application environments, this will result in
better overall performance than running your applications under
Tomcat stand-alone using the
- <a href="http11.html">HTTP/1.1 Connector</a>. However, the only way
+ <a href="http11.html">HTTP/1.1 Connector</a>. However, the only way
to know for sure whether it will provide better performance for
<strong>your</strong> application is to try it both ways.</p>
1.1 jakarta-tomcat-4.0/webapps/tomcat-docs/config/ajp13.xml
Index: ajp13.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document [
<!ENTITY project SYSTEM "project.xml">
]>
<document url="ajp13.html">
&project;
<properties>
<author email="[EMAIL PROTECTED]">Remy Maucherat</author>
<title>The AJP/1.3 Connector</title>
</properties>
<body>
<section name="Introduction">
<p><b>IMPORTANT NOTE: The AJP/1.3 Connector is now deprecated. Use the
<a href="coyotejk.html">Coyote JK Connector</a> instead.</b></p>
<p>The <strong>AJP/1.3 Connector</strong> element represents a
<strong>Connector</strong> component that communicates with a web
connector via the <code>JK</code> protocol (also known as the AJP protocol).
This is used for cases where you wish to invisibly integrate Tomcat 4 into
an existing (or new) web server installation, and you want the web server to
handle the static content contained in the web application, and/or utilize
the web server's SSL processing. In many application environments, this
will
result in better overall performance than running your applications under
Tomcat stand-alone using the <a href="coyote.html">Coyote HTTP/1.1
Connector</a>. However, the only way to know for sure whether it will
provide better performance for <strong>your</strong> application is to try
it both ways.</p>
<p>This connector supports load balancing when used in conjunction with
the <code>jvmRoute</code> attribute of the
<a href="engine.html">Engine</a>.</p>
</section>
<section name="Attributes">
<subsection name="Common Attributes">
<p>All implementations of <strong>Connector</strong>
support the following attributes:</p>
<attributes>
<attribute name="className" required="true">
<p>Java class name of the implementation to use. This class must
implement the <code>org.apache.catalina.Connector</code> interface.
You must specify the standard value defined below.</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
order to return the actual host name of the remote client. Set
to <code>false</code> to skip the DNS lookup and return the IP
address in String form instead (thereby improving performance).
By default, DNS lookups are disabled.</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
<code><security-constraint></code> requires SSL transport,
Catalina will automatically redirect the request to the port
number specified here.</p>
</attribute>
<attribute name="scheme" required="false">
<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>
</attribute>
<attribute name="secure" required="false">
<p>Set this attribute to <code>true</code> if you wish to have
calls to <code>request.isSecure()</code> to return <code>true</code>
for requests received by this Connector (you would want this on an
SSL Connector). The default value is <code>false</code>.</p>
</attribute>
</attributes>
</subsection>
<subsection name="Standard Implementation">
<p>The standard implementation of <strong>JK/AJP Connector</strong> is
<strong>org.apache.ajp.tomcat4.Ajp13Connector</strong>.</p>
<p><strong>This implementation supports the JK 1.3 and 1.4 protocols
(also known as AJP 1.3 and 1.4).</strong></p>
<p>It supports the following additional attributes (in addition to the
common attributes listed above):</p>
<attributes>
<attribute name="acceptCount" 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="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="debug" required="false">
<p>The debugging detail level of log messages generated by this
component, with higher numbers creating more detailed output.
If not specified, this attribute is set to zero (0).</p>
</attribute>
<attribute name="maxProcessors" 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 20.</p>
<p><b>NOTE:</b>For Apache 1.3 on Unix there is a 1 to 1 mapping
between httpd processes and Ajp13Processors. You must configure
maxProcessors to be greater than or equal to the maximum number
of httpd processes your Apache web server spawns.</p>
</attribute>
<attribute name="minProcessors" required="false">
<p>The number of request processing threads that will be created
when this <strong>Connector</strong> is first started. This
attribute should be set to a value smaller than that set for
<code>maxProcessors</code>. The default value is 5.</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="tomcatAuthentication" required="false">
<p>This flag, which value defaults to <code>true</code>, indicates
whether or not authentication will be handled by Tomcat or the native
web server. If the attribute value is <code>true</code>, any pricipal
authenticated by the native web server will be ignored, and Tomcat will
take care of the authentication. If the attribute value
is <code>false</code>, Tomcat will not attempt to authenticate
a principal if the native web server has already authenticated one.</p>
</attribute>
</attributes>
</subsection>
</section>
<section name="Nested Components">
<p></p>
</section>
</body>
</document>
1.1
jakarta-tomcat-4.0/webapps/tomcat-docs/config/coyotejk.xml
Index: coyotejk.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document [
<!ENTITY project SYSTEM "project.xml">
]>
<document url="coyotejk.html">
&project;
<properties>
<author email="[EMAIL PROTECTED]">Remy Maucherat</author>
<title>The Coyote JK Connector</title>
</properties>
<body>
<section name="Introduction">
<p>The <strong>Coyote JK Connector</strong> element represents a
<strong>Connector</strong> component that communicates with a web
connector via the <code>JK</code> protocol (also known as the AJP protocol).
This is used for cases where you wish to invisibly integrate Tomcat 4 into
an existing (or new) web server installation, and you want the web server to
handle the static content contained in the web application, and/or utilize
the web server's SSL processing. In many application environments, this
will
result in better overall performance than running your applications under
Tomcat stand-alone using the <a href="coyote.html">Coyote HTTP/1.1
Connector</a>. However, the only way to know for sure whether it will
provide better performance for <strong>your</strong> application is to try
it both ways.</p>
<p>This connector supports load balancing when used in conjunction with
the <code>jvmRoute</code> attribute of the
<a href="engine.html">Engine</a>.</p>
</section>
<section name="Attributes">
<subsection name="Common Attributes">
<p>All implementations of <strong>Connector</strong>
support the following attributes:</p>
<attributes>
<attribute name="className" required="true">
<p>Java class name of the implementation to use. This class must
implement the <code>org.apache.catalina.Connector</code> interface.
You must specify the standard value defined below.</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
order to return the actual host name of the remote client. Set
to <code>false</code> to skip the DNS lookup and return the IP
address in String form instead (thereby improving performance).
By default, DNS lookups are disabled.</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
<code><security-constraint></code> requires SSL transport,
Catalina will automatically redirect the request to the port
number specified here.</p>
</attribute>
<attribute name="scheme" required="false">
<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>
</attribute>
<attribute name="secure" required="false">
<p>Set this attribute to <code>true</code> if you wish to have
calls to <code>request.isSecure()</code> to return <code>true</code>
for requests received by this Connector (you would want this on an
SSL Connector). The default value is <code>false</code>.</p>
</attribute>
<attribute name="URIEncoding" required="false">
<p>This specifies the character encoding used to decode the URI bytes,
after %xx decoding the URL. If not specified, ISO-8859-1 will be used.
</p>
</attribute>
<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.27 and earlier.
The default value is <code>true</code>.
</p>
</attribute>
</attributes>
</subsection>
<subsection name="Standard Implementation">
<p>The standard implementation of <strong>Coyote JK Connector</strong> is
<strong>org.apache.coyote.tomcat4.CoyoteConnector</strong>, but you
must specify the protocolHandlerClassName attribute (see below).</p>
<p><strong>This implementation supports the AJP/1.3 protocol.</strong></p>
<p>It supports the following additional attributes (in addition to the
common attributes listed above):</p>
<attributes>
<attribute name="acceptCount" 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="debug" required="false">
<p>The debugging detail level of log messages generated by this
component, with higher numbers creating more detailed output.
If not specified, this attribute is set to zero (0).</p>
</attribute>
<attribute name="maxProcessors" 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 20.</p>
</attribute>
<attribute name="minProcessors" required="false">
<p>The number of request processing threads that will be created
when this <strong>Connector</strong> is first started. This
attribute should be set to a value smaller than that set for
<code>maxProcessors</code>. The default value is 5.</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="protocolHandlerClassName" required="false">
<p>This attribute value must be
<code>org.apache.jk.server.JkCoyoteHandler</code> to use the JK 2
handler.</p>
</attribute>
</attributes>
</subsection>
</section>
<section name="Nested Components">
<p></p>
</section>
</body>
</document>
1.12 +2 -2 jakarta-tomcat-4.0/webapps/tomcat-docs/tomcat-docs.xsl
Index: tomcat-docs.xsl
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/tomcat-docs.xsl,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- tomcat-docs.xsl 8 May 2004 22:30:14 -0000 1.11
+++ tomcat-docs.xsl 26 May 2005 21:12:21 -0000 1.12
@@ -157,7 +157,7 @@
<xsl:comment>PAGE FOOTER</xsl:comment>
<tr><td colspan="2">
<div align="center"><font color="{$body-link}" size="-1"><em>
- Copyright © 1999-2002, Apache Software Foundation
+ Copyright © 1999-2005, Apache Software Foundation
</em></font></div>
</td></tr>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
