Update the docs for the protocol attribute
authormarkt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Thu, 9 Apr 2009 09:53:34 +0000 (09:53 +0000)
committermarkt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Thu, 9 Apr 2009 09:53:34 +0000 (09:53 +0000)
git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@763581 13f79535-47bb-0310-9956-ffa450edef68

webapps/docs/config/ajp.xml
webapps/docs/config/http.xml

index a0dfb64..b4053c7 100644 (file)
     </attribute>
 
     <attribute name="protocol" required="false">
-      <p>Sets the protocol to handle incoming traffic. The default value is
-        <code>AJP/1.3</code> and configures
-        <code>org.apache.jk.server.JkCoyoteHandler</code> the original blocking
-        Java connector by default.<br/>
-        If the <code>PATH(Windows)</code> or <code>LD_LIBRARY_PATH
-        (on most unix system)</code> environment variables contain the Tomcat
-        native library, the native/APR connector will automatically be
-        configured instead.<br/>
+      <p>Sets the protocol to handle incoming traffic. To configure an AJP
+        connector this must be specified. If no value for protocol is provided,
+        an <a href="http.html">HTTP connector</a> rather than an AJP connector
+        will be configured.<br/>
+        The standard protocol value for an AJP connector is <code>AJP/1.3</code>
+        which uses an auto-switching mechanism to select either a Java based
+        connector or an APR/native based connector. If the
+        <code>PATH(Windows)</code> or <code>LD_LIBRARY_PATH</code> (on most unix
+        system) environment variables contain the Tomcat native library, the
+        native/APR connector will be used. If the native library cannot be
+        found, the Java based connector will be used.<br/>
         To use an explicit protocol rather than rely on the auto-switching
         mechanism described above, the following values may be used:<br/>
-        <code>org.apache.jk.server.JkCoyoteHandler</code>
-        - original blocking Java connector<br/>
         <code>org.apache.coyote.ajp.AjpProtocol</code>
-        - new blocking Java connector that supports an executor<br/>
+        - blocking Java connector<br/>
         <code>org.apache.coyote.ajp.AjpAprProtocol</code>
         - the APR/native connector.<br/>
       Custom implementations may also be used.</p>
     <attribute name="executor" required="false">
       <p>A reference to the name in an <a href="executor.html">Executor</a> element.
          If this attribute is enabled, and the named executor exists, the connector will
-         use the executor, and all the other thread attributes will be ignored.
-         This attribute is not supported by the original blocking Java
-         connector.</p>
+         use the executor, and all the other thread attributes will be ignored.</p>
     </attribute>
 
     <attribute name="keepAliveTimeout" required="false">
index 133e651..2cc23e7 100644 (file)
     <attribute name="protocol" required="false">
       <p>
         Sets the protocol to handle incoming traffic.
-        The default value is <code>HTTP/1.1</code> and configures the 
-        <code>org.apache.coyote.http11.Http11Protocol</code>. This is the blocking Java connector.<br/>
-        If the <code>PATH(Windows)</code> or <code>LD_LIBRARY_PATH(on most unix system)</code>  
-        environment variables contain the Tomcat native library, the APR connector
-        will automatically be configured. Please be advised that the APR connector has different
-        settings for HTTPS than the default Java connector.<br/>
-        Other values for this attribute are, but not limited to:<br/>
-        <code>org.apache.coyote.http11.Http11Protocol</code> - same as HTTP/1.1<br/>
-        <code>org.apache.coyote.http11.Http11NioProtocol</code> - non blocking Java connector<br/>
-        <code>org.apache.coyote.http11.Http11AprProtocol</code> - the APR connector.<br/>
-        Take a look at our <a href="#Connector Comparison">Connector Comparison</a> chart.
-        The configuration for both Java connectors are identical, both for http and https. <br/>
-        For more information on the APR connector and APR specific SSL settings please 
-        visit the <a href="../apr.html">APR documentation</a>
-        
+        The default value is <code>HTTP/1.1</code> which uses an auto-switching
+        mechanism to select either a blocking Java based connector or an
+        APR/native based connector. If the <code>PATH(Windows)</code> or
+        <code>LD_LIBRARY_PATH</code> (on most unix system) environment variables
+        contain the Tomcat native library, the native/APR connector will be used.
+        If the native library cannot be found, the blocking Java based connector
+        will be used. Please be advised that the native/APR connector has
+        different settings for HTTPS than the Java connectors.<br/>
+        To use an explicit protocol rather than rely on the auto-switching
+        mechanism described above, the following values may be used:<br/>
+        <code>org.apache.coyote.http11.Http11Protocol</code> -
+              blocking Java connector<br/>
+        <code>org.apache.coyote.http11.Http11NioProtocol</code> -
+              non blocking Java connector<br/>
+        <code>org.apache.coyote.http11.Http11AprProtocol</code> -
+              the APR/native connector.<br/>
+        Custom implementations may also be used.<br/>
+        Take a look at our <a href="#Connector Comparison">Connector
+        Comparison</a> chart. The configuration for both Java connectors is
+        identical, for http and https.<br/>
+        For more information on the APR connector and APR specific SSL settings
+        please  visit the <a href="../apr.html">APR documentation</a>
       </p>
     </attribute>