source: nutchez-0.1/tomcat/webapps/docs/config/printer/http.html @ 66

Last change on this file since 66 was 66, checked in by waue, 15 years ago

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