| [66] | 1 | <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat Configuration Reference - The HTTP Connector</title><meta value="Craig R. McClanahan" name="author"><meta value="craigmcc@apache.org" name="email"><meta value="Yoav Shapira" name="author"><meta value="yoavs@apache.org" name="email"></head><body vlink="#525D76" alink="#525D76" link="#525D76" text="#000000" bgcolor="#ffffff"><table cellspacing="0" width="100%" border="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/"><img border="0" alt=" |
|---|
| 2 | The Apache Tomcat Servlet/JSP Container |
|---|
| 3 | " align="right" src="../images/tomcat.gif"></a></td><td><font face="arial,helvetica,sanserif"><h1>Apache Tomcat 6.0</h1></font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img border="0" alt="Apache Logo" align="right" src="../images/asf-logo.gif"></a></td></tr></table><table cellspacing="4" width="100%" border="0"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><tr><!--LEFT SIDE NAVIGATION--><td nowrap="true" valign="top" width="20%"><p><strong>Links</strong></p><ul><li><a href="../index.html">Docs Home</a></li><li><a href="index.html">Config Ref. Home</a></li></ul><p><strong>Top Level Elements</strong></p><ul><li><a href="server.html">Server</a></li><li><a href="service.html">Service</a></li></ul><p><strong>Executors</strong></p><ul><li><a href="executor.html">Executor</a></li></ul><p><strong>Connectors</strong></p><ul><li><a href="http.html">HTTP</a></li><li><a href="ajp.html">AJP</a></li></ul><p><strong>Containers</strong></p><ul><li><a href="context.html">Context</a></li><li><a href="engine.html">Engine</a></li><li><a href="host.html">Host</a></li><li><a href="cluster.html">Cluster</a></li></ul><p><strong>Nested Components</strong></p><ul><li><a href="globalresources.html">Global Resources</a></li><li><a href="loader.html">Loader</a></li><li><a href="manager.html">Manager</a></li><li><a href="realm.html">Realm</a></li><li><a href="resources.html">Resources</a></li><li><a href="valve.html">Valve</a></li></ul><p><strong>Cluster Elements</strong></p><ul><li><a href="cluster.html">Cluster</a></li><li><a href="cluster-manager.html">Manager</a></li><li><a href="cluster-channel.html">Channel</a></li><li><a href="cluster-membership.html">Channel/Membership</a></li><li><a href="cluster-sender.html">Channel/Sender</a></li><li><a href="cluster-receiver.html">Channel/Receiver</a></li><li><a href="cluster-interceptor.html">Channel/Interceptor</a></li><li><a href="cluster-valve.html">Valve</a></li><li><a href="cluster-deployer.html">Deployer</a></li><li><a href="cluster-listener.html">ClusterListener</a></li></ul><p><strong>Global Settings</strong></p><ul><li><a href="systemprops.html">System properties</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td align="left" valign="top" width="80%"><table cellspacing="4" width="100%" border="0"><tr><td valign="top" align="left"><h1>Apache Tomcat Configuration Reference</h1><h2>The HTTP Connector</h2></td><td nowrap="true" valign="top" align="right"><small><a href="printer/http.html"><img alt="Printer Friendly Version" border="0" src="../images/printer.gif"><br>print-friendly<br>version |
|---|
| 4 | </a></small></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 5 | |
|---|
| 6 | <p>The <strong>HTTP Connector</strong> element represents a |
|---|
| 7 | <strong>Connector</strong> component that supports the HTTP/1.1 protocol. |
|---|
| 8 | It enables Catalina to function as a stand-alone web server, in addition |
|---|
| 9 | to its ability to execute servlets and JSP pages. A particular instance |
|---|
| 10 | of this component listens for connections on a specific TCP port number |
|---|
| 11 | on the server. One or more such <strong>Connectors</strong> can be |
|---|
| 12 | configured as part of a single <a href="service.html">Service</a>, each |
|---|
| 13 | forwarding to the associated <a href="engine.html">Engine</a> to perform |
|---|
| 14 | request processing and create the response.</p> |
|---|
| 15 | |
|---|
| 16 | <p>If you wish to configure the <strong>Connector</strong> that is used |
|---|
| 17 | for connections to web servers using the AJP protocol (such as the |
|---|
| 18 | <code>mod_jk 1.2.x</code> connector for Apache 1.3), see |
|---|
| 19 | <a href="ajp.html">here</a> instead.</p> |
|---|
| 20 | |
|---|
| 21 | <p>Each incoming request requires |
|---|
| 22 | a thread for the duration of that request. If more simultaneous requests |
|---|
| 23 | are received than can be handled by the currently available request |
|---|
| 24 | processing threads, additional threads will be created up to the |
|---|
| 25 | configured maximum (the value of the <code>maxThreads</code> attribute). |
|---|
| 26 | If still more simultaneous requests are received, they are stacked up |
|---|
| 27 | inside the server socket created by the <strong>Connector</strong>, up to |
|---|
| 28 | the configured maximum (the value of the <code>acceptCount</code> |
|---|
| 29 | attribute. Any further simultaneous requests will receive "connection |
|---|
| 30 | refused" errors, until resources are available to process them.</p> |
|---|
| 31 | |
|---|
| 32 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 33 | |
|---|
| 34 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Common Attributes"><strong>Common Attributes</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 35 | |
|---|
| 36 | <p>All implementations of <strong>Connector</strong> |
|---|
| 37 | support the following attributes:</p> |
|---|
| 38 | |
|---|
| 39 | <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><code>allowTrace</code></td><td valign="center" align="left"> |
|---|
| 40 | <p>A boolean value which can be used to enable or disable the TRACE |
|---|
| 41 | HTTP method. If not specified, this attribute is set to false.</p> |
|---|
| 42 | </td></tr><tr><td valign="center" align="left"><code>emptySessionPath</code></td><td valign="center" align="left"> |
|---|
| 43 | <p>If set to <code>true</code>, all paths for session cookies will be set |
|---|
| 44 | to <code>/</code>. This can be useful for portlet specification implementations. |
|---|
| 45 | If not specified, this attribute is set to <code>false</code>.</p> |
|---|
| 46 | </td></tr><tr><td valign="center" align="left"><code>enableLookups</code></td><td valign="center" align="left"> |
|---|
| 47 | <p>Set to <code>true</code> if you want calls to |
|---|
| 48 | <code>request.getRemoteHost()</code> to perform DNS lookups in |
|---|
| 49 | order to return the actual host name of the remote client. Set |
|---|
| 50 | to <code>false</code> to skip the DNS lookup and return the IP |
|---|
| 51 | address in String form instead (thereby improving performance). |
|---|
| 52 | By default, DNS lookups are enabled.</p> |
|---|
| 53 | </td></tr><tr><td valign="center" align="left"><code>maxPostSize</code></td><td valign="center" align="left"> |
|---|
| 54 | <p>The maximum size in bytes of the POST which will be handled by |
|---|
| 55 | the container FORM URL parameter parsing. The limit can be disabled by |
|---|
| 56 | setting this attribute to a value less than or equal to 0. |
|---|
| 57 | If not specified, this attribute is set to 2097152 (2 megabytes).</p> |
|---|
| 58 | </td></tr><tr><td valign="center" align="left"><code>maxSavePostSize</code></td><td valign="center" align="left"> |
|---|
| 59 | <p>The maximum size in bytes of the POST which will be saved/buffered by |
|---|
| 60 | the container during FORM or CLIENT-CERT authentication. For both types |
|---|
| 61 | of authentication, the POST will be saved/buffered before the user is |
|---|
| 62 | authenticated. For CLIENT-CERT authentication, the POST is buffered for |
|---|
| 63 | the duration of |
|---|
| 64 | the SSL handshake and the buffer emptied when the request |
|---|
| 65 | is processed. For FORM authentication the POST is |
|---|
| 66 | saved whilst the user |
|---|
| 67 | is re-directed to the login form and is retained until the user |
|---|
| 68 | successfully authenticates or the session associated with the |
|---|
| 69 | authentication request expires. The limit can be disabled by setting this |
|---|
| 70 | attribute to -1. Setting the attribute to |
|---|
| 71 | zero will disable the saving of |
|---|
| 72 | POST data during authentication |
|---|
| 73 | . If not |
|---|
| 74 | specified, this attribute is set |
|---|
| 75 | to |
|---|
| 76 | 4096 (4 kilobytes).</p> |
|---|
| 77 | </td></tr><tr><td valign="center" align="left"><code>protocol</code></td><td valign="center" align="left"> |
|---|
| 78 | <p> |
|---|
| 79 | Sets the protocol to handle incoming traffic. |
|---|
| 80 | The default value is <code>HTTP/1.1</code> and configures the |
|---|
| 81 | <code>org.apache.coyote.http11.Http11Protocol</code>. This is the blocking Java connector.<br> |
|---|
| 82 | If the <code>PATH(Windows)</code> or <code>LD_LIBRARY_PATH(on most unix system)</code> |
|---|
| 83 | environment variables contain the Tomcat native library, the APR connector |
|---|
| 84 | will automatically be configured. Please be advised that the APR connector has different |
|---|
| 85 | settings for HTTPS than the default Java connector.<br> |
|---|
| 86 | Other values for this attribute are, but not limited to:<br> |
|---|
| 87 | <code>org.apache.coyote.http11.Http11Protocol</code> - same as HTTP/1.1<br> |
|---|
| 88 | <code>org.apache.coyote.http11.Http11NioProtocol</code> - non blocking Java connector<br> |
|---|
| 89 | <code>org.apache.coyote.http11.Http11AprProtocol</code> - the APR connector.<br> |
|---|
| 90 | Take a look at our <a href="#Connector Comparison">Connector Comparison</a> chart. |
|---|
| 91 | The configuration for both Java connectors are identical, both for http and https. <br> |
|---|
| 92 | For more information on the APR connector and APR specific SSL settings please |
|---|
| 93 | visit the <a href="../apr.html">APR documentation</a> |
|---|
| 94 | |
|---|
| 95 | </p> |
|---|
| 96 | </td></tr><tr><td valign="center" align="left"><code>proxyName</code></td><td valign="center" align="left"> |
|---|
| 97 | <p>If this <strong>Connector</strong> is being used in a proxy |
|---|
| 98 | configuration, configure this attribute to specify the server name |
|---|
| 99 | to be returned for calls to <code>request.getServerName()</code>. |
|---|
| 100 | See <a href="#Proxy Support">Proxy Support</a> for more |
|---|
| 101 | information.</p> |
|---|
| 102 | </td></tr><tr><td valign="center" align="left"><code>proxyPort</code></td><td valign="center" align="left"> |
|---|
| 103 | <p>If this <strong>Connector</strong> is being used in a proxy |
|---|
| 104 | configuration, configure this attribute to specify the server port |
|---|
| 105 | to be returned for calls to <code>request.getServerPort()</code>. |
|---|
| 106 | See <a href="#Proxy Support">Proxy Support</a> for more |
|---|
| 107 | information.</p> |
|---|
| 108 | </td></tr><tr><td valign="center" align="left"><code>redirectPort</code></td><td valign="center" align="left"> |
|---|
| 109 | <p>If this <strong>Connector</strong> is supporting non-SSL |
|---|
| 110 | requests, and a request is received for which a matching |
|---|
| 111 | <code><security-constraint></code> requires SSL transport, |
|---|
| 112 | Catalina will automatically redirect the request to the port |
|---|
| 113 | number specified here.</p> |
|---|
| 114 | </td></tr><tr><td valign="center" align="left"><code>SSLEnabled</code></td><td valign="center" align="left"> |
|---|
| 115 | <p> |
|---|
| 116 | Use this attribute to enable SSL traffic on a connector. |
|---|
| 117 | To turn on SSL handshake/encryption/decryption on a connector |
|---|
| 118 | set this value to <code>true</code>. |
|---|
| 119 | The default value is <code>false</code>. |
|---|
| 120 | When turning this value <code>true</code> you will want to set the |
|---|
| 121 | <code>scheme</code> and the <code>secure</code> attributes as well |
|---|
| 122 | to pass the correct <code>request.getScheme()</code> and |
|---|
| 123 | <code>request.isSecure()</code> values to the servlets |
|---|
| 124 | See <a href="#SSL Support">SSL Support</a> for more information. |
|---|
| 125 | </p> |
|---|
| 126 | </td></tr><tr><td valign="center" align="left"><code>scheme</code></td><td valign="center" align="left"> |
|---|
| 127 | <p>Set this attribute to the name of the protocol you wish to have |
|---|
| 128 | returned by calls to <code>request.getScheme()</code>. For |
|---|
| 129 | example, you would set this attribute to "<code>https</code>" |
|---|
| 130 | for an SSL Connector. The default value is "<code>http</code>". |
|---|
| 131 | </p> |
|---|
| 132 | </td></tr><tr><td valign="center" align="left"><code>secure</code></td><td valign="center" align="left"> |
|---|
| 133 | <p>Set this attribute to <code>true</code> if you wish to have |
|---|
| 134 | calls to <code>request.isSecure()</code> to return <code>true</code> |
|---|
| 135 | for requests received by this Connector. You would want this on an |
|---|
| 136 | SSL Connector or a non SSL connector that is receiving data from a |
|---|
| 137 | SSL accelerator, like a crypto card, a SSL appliance or even a webserver. |
|---|
| 138 | The default value is <code>false</code>.</p> |
|---|
| 139 | </td></tr><tr><td valign="center" align="left"><code>URIEncoding</code></td><td valign="center" align="left"> |
|---|
| 140 | <p>This specifies the character encoding used to decode the URI bytes, |
|---|
| 141 | after %xx decoding the URL. If not specified, ISO-8859-1 will be used. |
|---|
| 142 | </p> |
|---|
| 143 | </td></tr><tr><td valign="center" align="left"><code>useBodyEncodingForURI</code></td><td valign="center" align="left"> |
|---|
| 144 | <p>This specifies if the encoding specified in contentType should be used |
|---|
| 145 | for URI query parameters, instead of using the URIEncoding. This |
|---|
| 146 | setting is present for compatibility with Tomcat 4.1.x, where the |
|---|
| 147 | encoding specified in the contentType, or explicitely set using |
|---|
| 148 | Request.setCharacterEncoding method was also used for the parameters from |
|---|
| 149 | the URL. The default value is <code>false</code>. |
|---|
| 150 | </p> |
|---|
| 151 | </td></tr><tr><td valign="center" align="left"><code>useIPVHosts</code></td><td valign="center" align="left"> |
|---|
| 152 | <p>Set this attribute to <code>true</code> to cause Tomcat to use |
|---|
| 153 | the IP address that the request was recieved on to determine the Host |
|---|
| 154 | to send the request to. The default value is <code>false</code>.</p> |
|---|
| 155 | </td></tr><tr><td valign="center" align="left"><code>xpoweredBy</code></td><td valign="center" align="left"> |
|---|
| 156 | <p>Set this attribute to <code>true</code> to cause Tomcat to advertise |
|---|
| 157 | support for the Servlet specification using the header recommended in the |
|---|
| 158 | specification. The default value is <code>false</code>.</p> |
|---|
| 159 | </td></tr></table> |
|---|
| 160 | |
|---|
| 161 | </blockquote></td></tr></table> |
|---|
| 162 | |
|---|
| 163 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Standard Implementation"><strong>Standard Implementation</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 164 | |
|---|
| 165 | <p> |
|---|
| 166 | HTTP supports the following additional attributes (in addition to the |
|---|
| 167 | common attributes listed above):</p> |
|---|
| 168 | |
|---|
| 169 | <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><code>acceptCount</code></td><td valign="center" align="left"> |
|---|
| 170 | <p>The maximum queue length for incoming connection requests when |
|---|
| 171 | all possible request processing threads are in use. Any requests |
|---|
| 172 | received when the queue is full will be refused. The default |
|---|
| 173 | value is 10.</p> |
|---|
| 174 | </td></tr><tr><td valign="center" align="left"><code>address</code></td><td valign="center" align="left"> |
|---|
| 175 | <p>For servers with more than one IP address, this attribute |
|---|
| 176 | specifies which address will be used for listening on the specified |
|---|
| 177 | port. By default, this port will be used on all IP addresses |
|---|
| 178 | associated with the server.</p> |
|---|
| 179 | </td></tr><tr><td valign="center" align="left"><code>bufferSize</code></td><td valign="center" align="left"> |
|---|
| 180 | <p>The size (in bytes) of the buffer to be provided for input |
|---|
| 181 | streams created by this connector. By default, buffers of |
|---|
| 182 | 2048 bytes will be provided.</p> |
|---|
| 183 | </td></tr><tr><td valign="center" align="left"><code>compressableMimeType</code></td><td valign="center" align="left"> |
|---|
| 184 | <p>The value is a comma separated list of MIME types for which HTTP |
|---|
| 185 | compression may be used. |
|---|
| 186 | The default value is <code>text/html,text/xml,text/plain</code>.</p> |
|---|
| 187 | </td></tr><tr><td valign="center" align="left"><code>compression</code></td><td valign="center" align="left"> |
|---|
| 188 | <p>The <strong>Connector</strong> may use HTTP/1.1 GZIP compression in |
|---|
| 189 | an attempt to save server bandwidth. The acceptable values for the |
|---|
| 190 | parameter is "off" (disable compression), "on" (allow compression, which |
|---|
| 191 | causes text data to be compressed), "force" (forces compression in all |
|---|
| 192 | cases), or a numerical integer value (which is equivalent to "on", but |
|---|
| 193 | specifies the minimum amount of data before the output is compressed). If |
|---|
| 194 | the content-length is not known and compression is set to "on" or more |
|---|
| 195 | aggressive, the output will also be compressed. If not specified, this |
|---|
| 196 | attribute is set to "off".</p> |
|---|
| 197 | </td></tr><tr><td valign="center" align="left"><code>connectionLinger</code></td><td valign="center" align="left"> |
|---|
| 198 | <p>The number of milliseconds during which the sockets used by this |
|---|
| 199 | <strong>Connector</strong> will linger when they are closed. |
|---|
| 200 | The default value is -1 (socket linger is disabled).</p> |
|---|
| 201 | </td></tr><tr><td valign="center" align="left"><code>connectionTimeout</code></td><td valign="center" align="left"> |
|---|
| 202 | <p>The number of milliseconds this <strong>Connector</strong> will wait, |
|---|
| 203 | after accepting a connection, for the request URI line to be |
|---|
| 204 | presented. The default value is 60000 (i.e. 60 seconds).</p> |
|---|
| 205 | </td></tr><tr><td valign="center" align="left"><code>executor</code></td><td valign="center" align="left"> |
|---|
| 206 | <p>A reference to the name in an <a href="executor.html">Executor</a> element. |
|---|
| 207 | If this attribute is enabled, and the named executor exists, the connector will |
|---|
| 208 | use the executor, and all the other thread attributes will be ignored.</p> |
|---|
| 209 | </td></tr><tr><td valign="center" align="left"><code>keepAliveTimeout</code></td><td valign="center" align="left"> |
|---|
| 210 | <p>The number of milliseconds this <strong>Connector</strong> will wait for |
|---|
| 211 | another HTTP request before closing the connection. |
|---|
| 212 | The default value is to use the value that has been set for the |
|---|
| 213 | connectionTimeout attribute.</p> |
|---|
| 214 | </td></tr><tr><td valign="center" align="left"><code>disableUploadTimeout</code></td><td valign="center" align="left"> |
|---|
| 215 | <p>This flag allows the servlet container to use a different, longer |
|---|
| 216 | connection timeout while a servlet is being executed, which in the end |
|---|
| 217 | allows either the servlet a longer amount of time to complete its |
|---|
| 218 | execution, or a longer timeout during data upload. If not specified, |
|---|
| 219 | this attribute is set to "true".</p> |
|---|
| 220 | </td></tr><tr><td valign="center" align="left"><code>maxHttpHeaderSize</code></td><td valign="center" align="left"> |
|---|
| 221 | <p>The maximum size of the request and response HTTP header, specified |
|---|
| 222 | in bytes. |
|---|
| 223 | If not specified, this attribute is set to 4096 (4 KB).</p> |
|---|
| 224 | </td></tr><tr><td valign="center" align="left"><code>maxKeepAliveRequests</code></td><td valign="center" align="left"> |
|---|
| 225 | <p>The maximum number of HTTP requests which can be pipelined until |
|---|
| 226 | the connection is closed by the server. Setting this attribute to 1 will |
|---|
| 227 | disable HTTP/1.0 keep-alive, as well as HTTP/1.1 keep-alive and |
|---|
| 228 | pipelining. Setting this to -1 will allow an unlimited amount of |
|---|
| 229 | pipelined or keep-alive HTTP requests. |
|---|
| 230 | If not specified, this attribute is set to 100.</p> |
|---|
| 231 | </td></tr><tr><td valign="center" align="left"><code>maxThreads</code></td><td valign="center" align="left"> |
|---|
| 232 | <p>The maximum number of request processing threads to be created |
|---|
| 233 | by this <strong>Connector</strong>, which therefore determines the |
|---|
| 234 | maximum number of simultaneous requests that can be handled. If |
|---|
| 235 | not specified, this attribute is set to 40. If an executor is associated |
|---|
| 236 | with this connector, this attribute is ignored as the connector will |
|---|
| 237 | execute tasks using the executor rather than an internal thread pool.</p> |
|---|
| 238 | </td></tr><tr><td valign="center" align="left"><code>noCompressionUserAgents</code></td><td valign="center" align="left"> |
|---|
| 239 | <p>The value is a comma separated list of regular expressions matching |
|---|
| 240 | user-agents of HTTP clients for which compression should not be used, |
|---|
| 241 | because these clients, although they do advertise support for the |
|---|
| 242 | feature, have a broken implementation. |
|---|
| 243 | The default value is an empty String (regexp matching disabled).</p> |
|---|
| 244 | </td></tr><tr><td valign="center" align="left"><strong><code>port</code></strong></td><td valign="center" align="left"> |
|---|
| 245 | <p>The TCP port number on which this <strong>Connector</strong> |
|---|
| 246 | will create a server socket and await incoming connections. Your |
|---|
| 247 | operating system will allow only one server application to listen |
|---|
| 248 | to a particular port number on a particular IP address.</p> |
|---|
| 249 | </td></tr><tr><td valign="center" align="left"><code>restrictedUserAgents</code></td><td valign="center" align="left"> |
|---|
| 250 | <p>The value is a comma separated list of regular expressions matching |
|---|
| 251 | user-agents of HTTP clients for which HTTP/1.1 or HTTP/1.0 keep alive |
|---|
| 252 | should not be used, even if the clients advertise support for these |
|---|
| 253 | features. |
|---|
| 254 | The default value is an empty String (regexp matching disabled).</p> |
|---|
| 255 | </td></tr><tr><td valign="center" align="left"><code>server</code></td><td valign="center" align="left"> |
|---|
| 256 | <p>The Server header for the http response. |
|---|
| 257 | Unless you are paranoid, you won't need this feature. |
|---|
| 258 | </p> |
|---|
| 259 | </td></tr><tr><td valign="center" align="left"><code>socketBuffer</code></td><td valign="center" align="left"> |
|---|
| 260 | <p>The size (in bytes) of the buffer to be provided for socket |
|---|
| 261 | output buffering. -1 can be specified to disable the use of a buffer. |
|---|
| 262 | By default, a buffers of 9000 bytes will be used.</p> |
|---|
| 263 | </td></tr><tr><td valign="center" align="left"><code>tcpNoDelay</code></td><td valign="center" align="left"> |
|---|
| 264 | <p>If set to <code>true</code>, the TCP_NO_DELAY option will be |
|---|
| 265 | set on the server socket, which improves performance under most |
|---|
| 266 | circumstances. This is set to <code>true</code> by default.</p> |
|---|
| 267 | </td></tr><tr><td valign="center" align="left"><code>threadPriority</code></td><td valign="center" align="left"> |
|---|
| 268 | <p>The priority of the request processing threads within the JVM. |
|---|
| 269 | The default value is <code>java.lang.Thread#NORM_PRIORITY</code>. |
|---|
| 270 | See the JavaDoc for the java.lang.Thread class for more details on |
|---|
| 271 | what this priority means. |
|---|
| 272 | </p> |
|---|
| 273 | </td></tr></table> |
|---|
| 274 | |
|---|
| 275 | </blockquote></td></tr></table> |
|---|
| 276 | |
|---|
| 277 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Nio Implementation"><strong>Nio Implementation</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 278 | |
|---|
| 279 | <p>The NIO connector exposes all the low level socket properties that can be used to tune the connector. |
|---|
| 280 | Most of these attributes are directly linked to the socket implementation in the JDK so you can find out |
|---|
| 281 | about the actual meaning in the JDK API documentation.<br> |
|---|
| 282 | <strong>Note</strong>On some JDK versions, setTrafficClass causes a problem, a work around for this is to add |
|---|
| 283 | the <code>-Djava.net.preferIPv4Stack=true</code> value to your command line</p> |
|---|
| 284 | |
|---|
| 285 | <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><code>useSendfile</code></td><td valign="center" align="left"> |
|---|
| 286 | <p>(bool)Use this attribute to enable or disable sendfile capability. |
|---|
| 287 | The default value is <code>true</code> |
|---|
| 288 | </p> |
|---|
| 289 | </td></tr><tr><td valign="center" align="left"><code>useExecutor</code></td><td valign="center" align="left"> |
|---|
| 290 | <p>(bool)Set to true to use the NIO thread pool executor. The default value is <code>true</code>. |
|---|
| 291 | If set to false, it uses a thread pool based on a stack for its execution. |
|---|
| 292 | Generally, using the executor yields a little bit slower performance, but yields a better |
|---|
| 293 | fairness for processing connections in a high load environment as the traffic gets queued through a |
|---|
| 294 | FIFO queue. If set to true(default) then the max pool size is the <code>maxThreads</code> attribute |
|---|
| 295 | and the core pool size is the <code>minSpareThreads</code>. |
|---|
| 296 | This value is ignored if the <code>executor</code> attribute is present and points to a valid shared thread pool. |
|---|
| 297 | </p> |
|---|
| 298 | </td></tr><tr><td valign="center" align="left"><code>acceptorThreadCount</code></td><td valign="center" align="left"> |
|---|
| 299 | <p>(int)The number of threads to be used to accept connections. Increase this value on a multi CPU machine, |
|---|
| 300 | although you would never really need more than <code>2</code>. Also, with a lot of non keep alive connections, |
|---|
| 301 | you might want to increase this value as well. Default value is <code>1</code>.</p> |
|---|
| 302 | </td></tr><tr><td valign="center" align="left"><code>pollerThreadCount</code></td><td valign="center" align="left"> |
|---|
| 303 | <p>(int)The number of threads to be used to run for the polling events. Default value is <code>1</code>. |
|---|
| 304 | Can't see a reason to go above that. But experiment and find your own results.</p> |
|---|
| 305 | </td></tr><tr><td valign="center" align="left"><code>pollerThreadPriority</code></td><td valign="center" align="left"> |
|---|
| 306 | <p>(int)The priority of the poller threads. |
|---|
| 307 | The default value is <code>java.lang.Thread#NORM_PRIORITY</code>. |
|---|
| 308 | See the JavaDoc for the java.lang.Thread class for more details on |
|---|
| 309 | what this priority means. |
|---|
| 310 | </p> |
|---|
| 311 | </td></tr><tr><td valign="center" align="left"><code>acceptorThreadPriority</code></td><td valign="center" align="left"> |
|---|
| 312 | <p>(int)The priority of the acceptor threads. The threads used to accept new connections. |
|---|
| 313 | The default value is <code>java.lang.Thread#NORM_PRIORITY</code>. |
|---|
| 314 | See the JavaDoc for the java.lang.Thread class for more details on |
|---|
| 315 | what this priority means. |
|---|
| 316 | </p> |
|---|
| 317 | </td></tr><tr><td valign="center" align="left"><code>selectorTimeout</code></td><td valign="center" align="left"> |
|---|
| 318 | <p>(int)The time in milliseconds to timeout on a select() for the poller. |
|---|
| 319 | This value is important, since connection clean up is done on the same thread, so dont set this |
|---|
| 320 | value to an extremely high one. The default value is <code>1000</code> milliseconds.</p> |
|---|
| 321 | </td></tr><tr><td valign="center" align="left"><code>useComet</code></td><td valign="center" align="left"> |
|---|
| 322 | <p>(bool)Whether to allow comet servlets or not, Default value is <code>true</code>.</p> |
|---|
| 323 | </td></tr><tr><td valign="center" align="left"><code>processCache</code></td><td valign="center" align="left"> |
|---|
| 324 | <p>(int)The protocol handler caches Http11NioProcessor objects to speed up performance. |
|---|
| 325 | This setting dictates how many of these objects get cached. |
|---|
| 326 | <code>-1</code> means unlimited, default is <code>200</code>. Set this value somewhere close to your maxThreads value. |
|---|
| 327 | </p> |
|---|
| 328 | </td></tr><tr><td valign="center" align="left"><code>socket.directBuffer</code></td><td valign="center" align="left"> |
|---|
| 329 | <p>(bool)Boolean value, whether to use direct ByteBuffers or java mapped ByteBuffers. Default is <code>false</code> |
|---|
| 330 | <br>When you are using direct buffers, make sure you allocate the appropriate amount of memory for the |
|---|
| 331 | direct memory space. On Sun's JDK that would be something like <code>-XX:MaxDirectMemorySize=256m</code></p> |
|---|
| 332 | </td></tr><tr><td valign="center" align="left"><code>socket.rxBufSize</code></td><td valign="center" align="left"> |
|---|
| 333 | <p>(int)The socket receive buffer (SO_RCVBUF) size in bytes. Default value is <code>25188</code></p> |
|---|
| 334 | </td></tr><tr><td valign="center" align="left"><code>socket.txBufSize</code></td><td valign="center" align="left"> |
|---|
| 335 | <p>(int)The socket send buffer (SO_SNDBUF) size in bytes. Default value is <code>43800</code></p> |
|---|
| 336 | </td></tr><tr><td valign="center" align="left"><code>socket.appReadBufSize</code></td><td valign="center" align="left"> |
|---|
| 337 | <p>(int)Each connection that is opened up in Tomcat get associated with a read and a write ByteBuffer |
|---|
| 338 | This attribute controls the size of these buffers. By default this read buffer is sized at <code>8192</code> bytes. |
|---|
| 339 | For lower concurrency, you can increase this to buffer more data. |
|---|
| 340 | For an extreme amount of keep alive connections, decrease this number or increase your heap size.</p> |
|---|
| 341 | </td></tr><tr><td valign="center" align="left"><code>socket.appWriteBufSize</code></td><td valign="center" align="left"> |
|---|
| 342 | <p>(int)Each connection that is opened up in Tomcat get associated with a read and a write ByteBuffer |
|---|
| 343 | This attribute controls the size of these buffers. By default this write buffer is sized at <code>8192</code> bytes. |
|---|
| 344 | For low concurrency you can increase this to buffer more response data. |
|---|
| 345 | For an extreme amount of keep alive connections, decrease this number or increase your heap size. |
|---|
| 346 | <br> |
|---|
| 347 | The default value here is pretty low, you should up it if you are not dealing with tens of thousands |
|---|
| 348 | concurrent connections.</p> |
|---|
| 349 | </td></tr><tr><td valign="center" align="left"><code>socket.bufferPool</code></td><td valign="center" align="left"> |
|---|
| 350 | <p>(int)The Nio connector uses a class called NioChannel that holds elements linked to a socket. |
|---|
| 351 | To reduce garbage collection, the Nio connector caches these channel objects. |
|---|
| 352 | This value specifies the size of this cache. |
|---|
| 353 | The default value is <code>500</code>, and represents that the cache will hold 500 NioChannel objects. |
|---|
| 354 | Other values are <code>-1</code>. unlimited cache, and <code>0</code>, no cache.</p> |
|---|
| 355 | </td></tr><tr><td valign="center" align="left"><code>socket.bufferPoolSize</code></td><td valign="center" align="left"> |
|---|
| 356 | <p>(int)The NioChannel pool can also be size based, not used object based. The size is calculated as follows:<br> |
|---|
| 357 | NioChannel <code>buffer size = read buffer size + write buffer size</code><br> |
|---|
| 358 | SecureNioChannel <code>buffer size = application read buffer size + application write buffer size + network read buffer size + network write buffer size</code><br> |
|---|
| 359 | The value is in bytes, the default value is <code>1024*1024*100</code> (100MB) |
|---|
| 360 | </p> |
|---|
| 361 | </td></tr><tr><td valign="center" align="left"><code>socket.processorCache</code></td><td valign="center" align="left"> |
|---|
| 362 | <p>(int)Tomcat will cache SocketProcessor objects to reduce garbage collection. |
|---|
| 363 | The integer value specifies how many objects to keep in the cache at most. |
|---|
| 364 | The default is <code>500</code>. |
|---|
| 365 | Other values are <code>-1</code>. unlimited cache, and <code>0</code>, no cache.</p> |
|---|
| 366 | </td></tr><tr><td valign="center" align="left"><code>socket.keyCache</code></td><td valign="center" align="left"> |
|---|
| 367 | <p>(int)Tomcat will cache KeyAttachment objects to reduce garbage collection. |
|---|
| 368 | The integer value specifies how many objects to keep in the cache at most. |
|---|
| 369 | The default is <code>500</code>. |
|---|
| 370 | Other values are <code>-1</code>. unlimited cache, and <code>0</code>, no cache.</p> |
|---|
| 371 | </td></tr><tr><td valign="center" align="left"><code>socket.eventCache</code></td><td valign="center" align="left"> |
|---|
| 372 | <p>(int)Tomcat will cache PollerEvent objects to reduce garbage collection. |
|---|
| 373 | The integer value specifies how many objects to keep in the cache at most. |
|---|
| 374 | The default is <code>500</code>. |
|---|
| 375 | Other values are <code>-1</code>. unlimited cache, and <code>0</code>, no cache.</p> |
|---|
| 376 | </td></tr><tr><td valign="center" align="left"><code>socket.tcpNoDelay</code></td><td valign="center" align="left"> |
|---|
| 377 | <p>(bool)same as the standard setting <code>tcpNoDelay</code>. Default value is <code>false</code></p> |
|---|
| 378 | </td></tr><tr><td valign="center" align="left"><code>socket.soKeepAlive</code></td><td valign="center" align="left"> |
|---|
| 379 | <p>(bool)Boolean value for the socket's keep alive setting (SO_KEEPALIVE). Default is <code>false</code>. </p> |
|---|
| 380 | </td></tr><tr><td valign="center" align="left"><code>socket.ooBInline</code></td><td valign="center" align="left"> |
|---|
| 381 | <p>(bool)Boolean value for the socket OOBINLINE setting. Default value is <code>true</code></p> |
|---|
| 382 | </td></tr><tr><td valign="center" align="left"><code>socket.soReuseAddress</code></td><td valign="center" align="left"> |
|---|
| 383 | <p>(bool)Boolean value for the sockets reuse address option (SO_REUSEADDR). Default value is <code>true</code></p> |
|---|
| 384 | </td></tr><tr><td valign="center" align="left"><code>socket.soLingerOn</code></td><td valign="center" align="left"> |
|---|
| 385 | <p>(bool)Boolean value for the sockets so linger option (SO_LINGER). Default value is <code>true</code>. |
|---|
| 386 | This option is paired with the <code>soLingerTime</code> value.</p> |
|---|
| 387 | </td></tr><tr><td valign="center" align="left"><code>socket.soLingerTime</code></td><td valign="center" align="left"> |
|---|
| 388 | <p>(bool)Value in seconds for the sockets so linger option (SO_LINGER). Default value is <code>25</code> seconds. |
|---|
| 389 | This option is paired with the soLinger value.</p> |
|---|
| 390 | </td></tr><tr><td valign="center" align="left"><code>socket.soTimeout</code></td><td valign="center" align="left"> |
|---|
| 391 | <p>(int)Value in milliseconds for the sockets read timeout (SO_TIMEOUT). Default value is <code>5000</code> milliseconds.</p> |
|---|
| 392 | </td></tr><tr><td valign="center" align="left"><code>socket.soTrafficClass</code></td><td valign="center" align="left"> |
|---|
| 393 | <p>(byte)Value between <code>0</code> and <code>255</code> for the traffic class on the socket, <code>0x04 | 0x08 | 0x010</code></p> |
|---|
| 394 | </td></tr><tr><td valign="center" align="left"><code>socket.performanceConnectionTime</code></td><td valign="center" align="left"> |
|---|
| 395 | <p>(int)The first value for the performance settings. Default is <code>1</code>, see <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int)">Socket Performance Options</a></p> |
|---|
| 396 | </td></tr><tr><td valign="center" align="left"><code>socket.performanceLatency</code></td><td valign="center" align="left"> |
|---|
| 397 | <p>(int)The second value for the performance settings. Default is <code>0</code>, see <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int)">Socket Performance Options</a></p> |
|---|
| 398 | </td></tr><tr><td valign="center" align="left"><code>socket.performanceBandwidth</code></td><td valign="center" align="left"> |
|---|
| 399 | <p>(int)The third value for the performance settings. Default is <code>1</code>, see <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int)">Socket Performance Options</a></p> |
|---|
| 400 | </td></tr><tr><td valign="center" align="left"><code>selectorPool.maxSelectors</code></td><td valign="center" align="left"> |
|---|
| 401 | <p>(int)The max selectors to be used in the pool, to reduce selector contention. |
|---|
| 402 | Use this option when the command line <code>org.apache.tomcat.util.net.NioSelectorShared</code> value is set to false. |
|---|
| 403 | Default value is <code>200</code>.</p> |
|---|
| 404 | </td></tr><tr><td valign="center" align="left"><code>selectorPool.maxSpareSelectors</code></td><td valign="center" align="left"> |
|---|
| 405 | <p>(int)The max spare selectors to be used in the pool, to reduce selector contention. |
|---|
| 406 | When a selector is returned to the pool, the system can decide to keep it or let it be GC:ed. |
|---|
| 407 | Use this option when the command line <code>org.apache.tomcat.util.net.NioSelectorShared</code> value is set to false. |
|---|
| 408 | Default value is <code>-1</code> (unlimited)</p> |
|---|
| 409 | </td></tr><tr><td valign="center" align="left"><code>command-line-options</code></td><td valign="center" align="left"> |
|---|
| 410 | <p>The following command line options are available for the NIO connector:<br> |
|---|
| 411 | <code>-Dorg.apache.tomcat.util.net.NioSelectorShared=true|false</code> - default is <code>true</code>. |
|---|
| 412 | Set this value to false if you wish to use a selector for each thread. |
|---|
| 413 | the property. If you do set it to false, you can control the size of the pool of selectors by using the |
|---|
| 414 | selectorPool.maxSelectors attribute</p> |
|---|
| 415 | </td></tr><tr><td valign="center" align="left"><code>oomParachute</code></td><td valign="center" align="left"> |
|---|
| 416 | <p>(int)The NIO connector implements an OutOfMemoryError strategy called parachute. |
|---|
| 417 | It holds a chunk of data as a byte array. In case of an OOM, |
|---|
| 418 | this chunk of data is released and the error is reported. This will give the VM enough room |
|---|
| 419 | to clean up. The <code>oomParachute</code> represent the size in bytes of the parachute(the byte array). |
|---|
| 420 | The default value is <code>1024*1024</code>(1MB). |
|---|
| 421 | Please note, this only works for OOM errors regarding the Java Heap space, and there is absolutely no |
|---|
| 422 | guarantee that you will be able to recover at all. |
|---|
| 423 | If you have an OOM outside of the Java Heap, then this parachute trick will not help. |
|---|
| 424 | </p> |
|---|
| 425 | </td></tr></table> |
|---|
| 426 | </blockquote></td></tr></table> |
|---|
| 427 | |
|---|
| 428 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Nested Components"><strong>Nested Components</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 429 | |
|---|
| 430 | <p>None at this time.</p> |
|---|
| 431 | |
|---|
| 432 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Special Features"><strong>Special Features</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 433 | |
|---|
| 434 | |
|---|
| 435 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="HTTP/1.1 and HTTP/1.0 Support"><strong>HTTP/1.1 and HTTP/1.0 Support</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 436 | |
|---|
| 437 | <p>This <strong>Connector</strong> supports all of the required features |
|---|
| 438 | of the HTTP/1.1 protocol, as described in RFC 2616, including persistent |
|---|
| 439 | connections, pipelining, expectations and chunked encoding. If the client |
|---|
| 440 | (typically a browser) supports only HTTP/1.0, the |
|---|
| 441 | <strong>Connector</strong> will gracefully fall back to supporting this |
|---|
| 442 | protocol as well. No special configuration is required to enable this |
|---|
| 443 | support. The <strong>Connector</strong> also supports HTTP/1.0 |
|---|
| 444 | keep-alive.</p> |
|---|
| 445 | |
|---|
| 446 | <p>RFC 2616 requires that HTTP servers always begin their responses with |
|---|
| 447 | the highest HTTP version that they claim to support. Therefore, this |
|---|
| 448 | <strong>Connector</strong> will always return <code>HTTP/1.1</code> at |
|---|
| 449 | the beginning of its responses.</p> |
|---|
| 450 | |
|---|
| 451 | </blockquote></td></tr></table> |
|---|
| 452 | |
|---|
| 453 | |
|---|
| 454 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Proxy Support"><strong>Proxy Support</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 455 | |
|---|
| 456 | <p>The <code>proxyName</code> and <code>proxyPort</code> attributes can |
|---|
| 457 | be used when Tomcat is run behind a proxy server. These attributes |
|---|
| 458 | modify the values returned to web applications that call the |
|---|
| 459 | <code>request.getServerName()</code> and <code>request.getServerPort()</code> |
|---|
| 460 | methods, which are often used to construct absolute URLs for redirects. |
|---|
| 461 | Without configuring these attributes, the values returned would reflect |
|---|
| 462 | the server name and port on which the connection from the proxy server |
|---|
| 463 | was received, rather than the server name and port to whom the client |
|---|
| 464 | directed the original request.</p> |
|---|
| 465 | |
|---|
| 466 | <p>For more information, see the |
|---|
| 467 | <a href="../proxy-howto.html">Proxy Support HOW-TO</a>.</p> |
|---|
| 468 | |
|---|
| 469 | </blockquote></td></tr></table> |
|---|
| 470 | |
|---|
| 471 | |
|---|
| 472 | |
|---|
| 473 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="SSL Support"><strong>SSL Support</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 474 | |
|---|
| 475 | <p>You can enable SSL support for a particular instance of this |
|---|
| 476 | <strong>Connector</strong> by setting the <code>secure</code> attribute to |
|---|
| 477 | <code>true</code>. In addition, you may need to configure the following |
|---|
| 478 | attributes:</p> |
|---|
| 479 | |
|---|
| 480 | <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><code>algorithm</code></td><td valign="center" align="left"> |
|---|
| 481 | <p>The certificate encoding algorithm to be used. This defaults to the Sun |
|---|
| 482 | implementation (<code>SunX509</code>). For IBM JVMs you should use the |
|---|
| 483 | value <code>IbmX509</code>. For other vendors, consult the JVM |
|---|
| 484 | documentation for the correct value.</p> |
|---|
| 485 | </td></tr><tr><td valign="center" align="left"><code>clientAuth</code></td><td valign="center" align="left"> |
|---|
| 486 | <p>Set to <code>true</code> if you want the SSL stack to require a |
|---|
| 487 | valid certificate chain from the client before accepting a connection. |
|---|
| 488 | Set to <code>want</code> if you want the SSL stack to request a client |
|---|
| 489 | Certificate, but not fail if one isn't presented. A <code>false</code> |
|---|
| 490 | value (which is the default) will not require a certificate chain |
|---|
| 491 | unless the client requests a resource protected by a security |
|---|
| 492 | constraint that uses <code>CLIENT-CERT</code> authentication. See the |
|---|
| 493 | <a href="../ssl-howto.html">SSL HowTo</a> for an example.</p> |
|---|
| 494 | </td></tr><tr><td valign="center" align="left"><code>keystoreFile</code></td><td valign="center" align="left"> |
|---|
| 495 | <p>The pathname of the keystore file where you have stored the |
|---|
| 496 | server certificate to be loaded. By default, the pathname is |
|---|
| 497 | the file "<code>.keystore</code>" in the operating system home |
|---|
| 498 | directory of the user that is running Tomcat. If your |
|---|
| 499 | <code>keystoreType</code> doesn't need a file use <code>""</code> |
|---|
| 500 | (empty string) for this parameter.</p> |
|---|
| 501 | </td></tr><tr><td valign="center" align="left"><code>keystorePass</code></td><td valign="center" align="left"> |
|---|
| 502 | <p>The password used to access the server certificate from the |
|---|
| 503 | specified keystore file. The default value is "<code>changeit</code>". |
|---|
| 504 | </p> |
|---|
| 505 | </td></tr><tr><td valign="center" align="left"><code>keystoreType</code></td><td valign="center" align="left"> |
|---|
| 506 | <p>The type of keystore file to be used for the server certificate. |
|---|
| 507 | If not specified, the default value is "<code>JKS</code>".</p> |
|---|
| 508 | </td></tr><tr><td valign="center" align="left"><code>keystoreProvider</code></td><td valign="center" align="left"> |
|---|
| 509 | <p>The name of the keystore provider to be used for the server |
|---|
| 510 | certificate. If not specified, the list of registered providers is |
|---|
| 511 | traversed in preference order and the first provider that supports the |
|---|
| 512 | <code>keystoreType</code> is used. |
|---|
| 513 | </p> |
|---|
| 514 | </td></tr><tr><td valign="center" align="left"><code>sslProtocol</code></td><td valign="center" align="left"> |
|---|
| 515 | <p>The version of the SSL protocol to use. If not specified, |
|---|
| 516 | the default is "<code>TLS</code>".</p> |
|---|
| 517 | </td></tr><tr><td valign="center" align="left"><code>ciphers</code></td><td valign="center" align="left"> |
|---|
| 518 | <p>A comma seperated list of the encryption ciphers that may be used. |
|---|
| 519 | If not specified, then any available cipher may be used.</p> |
|---|
| 520 | </td></tr><tr><td valign="center" align="left"><code>keyAlias</code></td><td valign="center" align="left"> |
|---|
| 521 | <p>The alias used to for the server certificate in the keystore. If not |
|---|
| 522 | specified the first key read in the keystore will be used.</p> |
|---|
| 523 | </td></tr><tr><td valign="center" align="left"><code>truststoreFile</code></td><td valign="center" align="left"> |
|---|
| 524 | <p>The TrustStore file to use to validate client certificates.</p> |
|---|
| 525 | </td></tr><tr><td valign="center" align="left"><code>truststorePass</code></td><td valign="center" align="left"> |
|---|
| 526 | <p>The password to access the TrustStore. This defaults to the value |
|---|
| 527 | of <code>keystorePass</code>.</p> |
|---|
| 528 | </td></tr><tr><td valign="center" align="left"><code>truststoreType</code></td><td valign="center" align="left"> |
|---|
| 529 | <p>Add this element if your are using a different format for the |
|---|
| 530 | TrustStore then you are using for the KeyStore.</p> |
|---|
| 531 | </td></tr><tr><td valign="center" align="left"><code>truststoreProvider</code></td><td valign="center" align="left"> |
|---|
| 532 | <p>The name of the truststore provider to be used for the server |
|---|
| 533 | certificate. If not specified, the list of registered providers is |
|---|
| 534 | traversed in preference order and the first provider that supports the |
|---|
| 535 | <code>truststoreType</code> is used. |
|---|
| 536 | </p> |
|---|
| 537 | </td></tr></table> |
|---|
| 538 | |
|---|
| 539 | <p>For more information, see the |
|---|
| 540 | <a href="../ssl-howto.html">SSL Configuration HOW-TO</a>.</p> |
|---|
| 541 | |
|---|
| 542 | </blockquote></td></tr></table> |
|---|
| 543 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Connector Comparison"><strong>Connector Comparison</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 544 | |
|---|
| 545 | <p>Below is a small chart that shows how the connectors differentiate.</p> |
|---|
| 546 | <div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> |
|---|
| 547 | Java Blocking Connector Java Nio Blocking Connector APR Connector |
|---|
| 548 | Classname Http11Protocol Http11NioProtocol Http11AprProtocol |
|---|
| 549 | Tomcat Version 3.x 4.x 5.x 6.x 6.x 5.5.x 6.x |
|---|
| 550 | Support Polling NO YES YES |
|---|
| 551 | Polling Size N/A Unlimited - Restricted by mem Unlimited |
|---|
| 552 | Read HTTP Request Blocking Blocking Blocking |
|---|
| 553 | Read HTTP Body Blocking Blocking Blocking |
|---|
| 554 | Write HTTP Response Blocking Blocking Blocking |
|---|
| 555 | SSL Support Java SSL Java SSL OpenSSL |
|---|
| 556 | SSL Handshake Blocking Non blocking Blocking |
|---|
| 557 | Max Connections maxThreads See polling size See polling size |
|---|
| 558 | |
|---|
| 559 | |
|---|
| 560 | </pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="../images/void.gif"></td></tr></table></div> |
|---|
| 561 | |
|---|
| 562 | </blockquote></td></tr></table> |
|---|
| 563 | </blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font size="-1" color="#525D76"><em> |
|---|
| 564 | Copyright © 1999-2008, Apache Software Foundation |
|---|
| 565 | </em></font></div></td></tr></table></body></html> |
|---|
