--- webapps/docs/config/http.xml (revision 1081117) +++ webapps/docs/config/http.xml (working copy) @@ -85,10 +85,10 @@ -

Set to true if you want calls to +

Set to true if you want calls to request.getRemoteHost() to perform DNS lookups in order to return the actual host name of the remote client. Set - to false to skip the DNS lookup and return the IP + to false to skip the DNS lookup and return the IP address in String form instead (thereby improving performance). By default, DNS lookups are enabled.

@@ -120,12 +120,12 @@ bodies will be parsed for request parameters identically to POST. This is useful in RESTful applications that want to support POST-style semantics for PUT requests. - Note that any setting other than POST causes Tomcat + Note that any setting other than POST causes Tomcat to behave in a way that goes against the intent of the servlet specification. The HTTP method TRACE is specifically forbidden here in accordance with the HTTP specification. - The default is POST

+ The default is POST

@@ -137,7 +137,7 @@

Sets the protocol to handle incoming traffic. The default value is - HTTP/1.1 which uses an auto-switching mechanism to select + HTTP/1.1 which uses an auto-switching mechanism to select either a blocking Java based connector or an APR/native based connector. If the PATH (Windows) or LD_LIBRARY_PATH (on most unix systems) environment variables contain the Tomcat native @@ -147,11 +147,11 @@ Java connectors.
To use an explicit protocol rather than rely on the auto-switching mechanism described above, the following values may be used:
- org.apache.coyote.http11.Http11Protocol - + org.apache.coyote.http11.Http11Protocol - blocking Java connector
- org.apache.coyote.http11.Http11NioProtocol - + org.apache.coyote.http11.Http11NioProtocol - non blocking Java connector
- org.apache.coyote.http11.Http11AprProtocol - + org.apache.coyote.http11.Http11AprProtocol - the APR/native connector.
Custom implementations may also be used.
Take a look at our Connector @@ -189,18 +189,18 @@

Set this attribute to the name of the protocol you wish to have returned by calls to request.getScheme(). For - example, you would set this attribute to "https" - for an SSL Connector. The default value is "http". + example, you would set this attribute to https + for an SSL Connector. The default value is http.

-

Set this attribute to true if you wish to have +

Set this attribute to true if you wish to have calls to request.isSecure() to return true for requests received by this Connector. You would want this on an SSL Connector or a non SSL connector that is receiving data from a SSL accelerator, like a crypto card, a SSL appliance or even a webserver. - The default value is false.

+ The default value is false.

@@ -215,20 +215,20 @@ setting is present for compatibility with Tomcat 4.1.x, where the encoding specified in the contentType, or explicitly set using Request.setCharacterEncoding method was also used for the parameters from - the URL. The default value is false. + the URL. The default value is false.

-

Set this attribute to true to cause Tomcat to use +

Set this attribute to true to cause Tomcat to use the IP address that the request was received on to determine the Host - to send the request to. The default value is false.

+ to send the request to. The default value is false.

-

Set this attribute to true to cause Tomcat to advertise +

Set this attribute to true to cause Tomcat to advertise support for the Servlet specification using the header recommended in the - specification. The default value is false.

+ specification. The default value is false.

@@ -255,7 +255,7 @@ value on a multi CPU machine, although you would never really need more than 2. Also, with a lot of non keep alive connections, you might want to increase this value as well. Default value is - 1.

+ 1.

@@ -268,14 +268,14 @@

Controls when the socket used by the connector is bound. By default it is bound when the connector is initiated and unbund when the connector is - destroyed. If set to false, the socket will be bound when the + destroyed. If set to false, the socket will be bound when the connector is started and unbound when it is stopped.

The value is a comma separated list of MIME types for which HTTP compression may be used. - The default value is text/html,text/xml,text/plain.

+ The default value is text/html,text/xml,text/plain.

@@ -311,7 +311,7 @@

The number of milliseconds during which the sockets used by this Connector will linger when they are closed. - The default value -1 which disables this option.

+ The default value -1 which disables this option.

@@ -323,14 +323,14 @@

Specifies the timeout, in milliseconds, to use while a data upload is in progress. This only takes effect if - disableUploadTimeout is set to false. + disableUploadTimeout is set to false.

This flag allows the servlet container to use a different, usually longer connection timeout during data upload. If not specified, this - attribute is set to true which disables this longer timeout. + attribute is set to true which disables this longer timeout.

@@ -379,19 +379,19 @@ connections until the number of connections reach below this value. The operating system may still accept connections based on the acceptCount setting. This setting is currently only applicable to the blocking Java connectors (AJP/HTTP). - Default value is 10000.

+ Default value is 10000.

Limits the total length of trailing headers in the last chunk of - a chunked HTTP request. If the value is -1, no limit will be - imposed. If not specified, the default value of 8192 will be + a chunked HTTP request. If the value is -1, no limit will be + imposed. If not specified, the default value of 8192 will be used.

The minimum number of threads always kept running. If not specified, - the default of 10 is used.

+ the default of 10 is used.

@@ -406,7 +406,7 @@

The protocol handler caches Processor objects to speed up performance. This setting dictates how many of these objects get cached. - -1 means unlimited, default is 200. Set this + -1 means unlimited, default is 200. Set this value somewhere close to your maxThreads value.

@@ -423,7 +423,7 @@ for this attribute overrides the Tomcat default and any Server header set by a web application. If not set, any value specified by the application is used. If the application does not specify a value then - Apache-Coyote/1.1 is used. Unless you are paranoid, you won't + Apache-Coyote/1.1 is used. Unless you are paranoid, you won't need this feature.

@@ -437,9 +437,9 @@

Use this attribute to enable SSL traffic on a connector. To turn on SSL handshake/encryption/decryption on a connector - set this value to true. - The default value is false. - When turning this value true you will want to set the + set this value to true. + The default value is false. + When turning this value true you will want to set the scheme and the secure attributes as well to pass the correct request.getScheme() and request.isSecure() values to the servlets @@ -448,9 +448,9 @@ -

If set to true, the TCP_NO_DELAY option will be +

If set to true, the TCP_NO_DELAY option will be set on the server socket, which improves performance under most - circumstances. This is set to true by default.

+ circumstances. This is set to true by default.

@@ -499,9 +499,9 @@

(bool)Boolean value for the sockets so linger option (SO_LINGER). A value for the standard attribute connectionLinger - that is >=0 is equivalent to setting this to true. + that is >=0 is equivalent to setting this to true. A value for the standard attribute connectionLinger - that is <0 is equivalent to setting this to false. + that is <0 is equivalent to setting this to false. Both this attribute and soLingerTime must be set else the JVM defaults will be used for both.

@@ -517,7 +517,7 @@ connectionTimeout.

-

(byte)Value between 0 and 255 for the +

(byte)Value between 0 and 255 for the traffic class on the socket. JVM default used if not set.

NoteOn some JDK versions, setting soTrafficClass causes a problem. A work around for this @@ -544,7 +544,7 @@

(int) The timeout for a socket unlock. When a connector is stopped, it will try to release the acceptor thread by opening a connector to itself. - The default value is 250 and the value is in milliseconds

+ The default value is 250 and the value is in milliseconds

@@ -570,7 +570,7 @@

(int)The number of threads to be used to run for the polling events. - Default value is 1 per processor. Can't see a reason to go + Default value is 1 per processor. Can't see a reason to go above that. But experiment and find your own results.

@@ -584,22 +584,22 @@

(int)The time in milliseconds to timeout on a select() for the poller. This value is important, since connection clean up is done on the same thread, so do not set this value to an extremely high one. The - default value is 1000 milliseconds.

+ default value is 1000 milliseconds.

(bool)Whether to allow comet servlets or not. Default value is - true.

+ true.

(bool)Use this attribute to enable or disable sendfile capability. - The default value is true.

+ The default value is true.

(bool)Boolean value, whether to use direct ByteBuffers or java mapped - ByteBuffers. Default is false.
+ ByteBuffers. Default is false.
When you are using direct buffers, make sure you allocate the appropriate amount of memory for the direct memory space. On Sun's JDK that would be something like -XX:MaxDirectMemorySize=256m. @@ -609,7 +609,7 @@

(int)Each connection that is opened up in Tomcat get associated with a read ByteBuffer. This attribute controls the size of this buffer. By - default this read buffer is sized at 8192 bytes. For lower + default this read buffer is sized at 8192 bytes. For lower concurrency, you can increase this to buffer more data. For an extreme amount of keep alive connections, decrease this number or increase your heap size.

@@ -618,7 +618,7 @@

(int)Each connection that is opened up in Tomcat get associated with a write ByteBuffer. This attribute controls the size of this buffer. By - default this write buffer is sized at 8192 bytes. For low + default this write buffer is sized at 8192 bytes. For low concurrency you can increase this to buffer more response data. For an extreme amount of keep alive connections, decrease this number or increase your heap size.
@@ -630,9 +630,9 @@

(int)The NIO connector uses a class called NioChannel that holds elements linked to a socket. To reduce garbage collection, the NIO connector caches these channel objects. This value specifies the size of - this cache. The default value is 500, and represents that + this cache. The default value is 500, and represents that the cache will hold 500 NioChannel objects. Other values are - -1 for unlimited cache and 0 for no cache.

+ -1 for unlimited cache and 0 for no cache.

@@ -643,36 +643,36 @@ SecureNioChannel buffer size = application read buffer size + application write buffer size + network read buffer size + network write buffer size
- The value is in bytes, the default value is 1024*1024*100 + The value is in bytes, the default value is 1024*1024*100 (100MB).

(int)Tomcat will cache SocketProcessor objects to reduce garbage collection. The integer value specifies how many objects to keep in the - cache at most. The default is 500. Other values are - -1 for unlimited cache and 0for no cache.

+ cache at most. The default is 500. Other values are + -1 for unlimited cache and 0for no cache.

(int)Tomcat will cache KeyAttachment objects to reduce garbage collection. The integer value specifies how many objects to keep in the - cache at most. The default is 500. Other values are - -1 for unlimited cache and 0for no cache.

+ cache at most. The default is 500. Other values are + -1 for unlimited cache and 0for no cache.

(int)Tomcat will cache PollerEvent objects to reduce garbage collection. The integer value specifies how many objects to keep in the - cache at most. The default is 500. Other values are - -1 for unlimited cache and 0for no cache.

+ cache at most. The default is 500. Other values are + -1 for unlimited cache and 0for no cache.

(int)The max selectors to be used in the pool, to reduce selector contention. Use this option when the command line org.apache.tomcat.util.net.NioSelectorShared value is set - to false. Default value is 200.

+ to false. Default value is 200.

@@ -680,14 +680,14 @@ selector contention. When a selector is returned to the pool, the system can decide to keep it or let it be GC'd. Use this option when the command line org.apache.tomcat.util.net.NioSelectorShared - value is set to false. Default value is -1 (unlimited).

+ value is set to false. Default value is -1 (unlimited).

The following command line options are available for the NIO connector:
-Dorg.apache.tomcat.util.net.NioSelectorShared=true|false - - default is true. Set this value to false if you wish to + - default is true. Set this value to false if you wish to use a selector for each thread. If you do set it to false, you can control the size of the pool of selectors by using the selectorPool.maxSelectors attribute.

@@ -699,7 +699,7 @@ this chunk of data is released and the error is reported. This will give the VM enough room to clean up. The oomParachute represents the size in bytes of the parachute(the byte array). The default value is - 1024*1024(1MB). Please note, this only works for OOM errors + 1024*1024(1MB). Please note, this only works for OOM errors regarding the Java Heap space, and there is absolutely no guarantee that you will be able to recover at all. If you have an OOM outside of the Java Heap, then this parachute trick will not help. @@ -716,9 +716,9 @@

Sets the TCP_DEFER_ACCEPT flag on the listening socket - for this connector. The default value is true where + for this connector. The default value is true where TCP_DEFER_ACCEPT is supported by the operating system, - otherwise it is false.

+ otherwise it is false.

@@ -769,12 +769,12 @@

(bool)Whether to allow comet servlets or not. Default value is - true.

+ true.

(bool)Use this attribute to enable or disable sendfile capability. - The default value is true.

+ The default value is true.

@@ -836,7 +836,7 @@

You can enable SSL support for a particular instance of this Connector by setting the SSLEnabled attribute to - true.

+ true.

You will also need to set the scheme and secure attributes to the values https and true @@ -855,8 +855,8 @@

The certificate encoding algorithm to be used. This defaults to KeyManagerFactory.getDefaultAlgorithm() which returns - SunX509 for Sun JVMs. IBM JVMs return - IbmX509. For other vendors, consult the JVM + SunX509 for Sun JVMs. IBM JVMs return + IbmX509. For other vendors, consult the JVM documentation for the default value.

@@ -864,7 +864,7 @@

Is unsafe legacy TLS renegotiation allowed which is likely to expose users to CVE-2009-3555, a man-in-the-middle vulnerability in the TLS protocol that allows an attacker to inject arbitrary data into the user's - request. If not specified, a default of false is used. This + request. If not specified, a default of false is used. This attribute only has an effect if the JVM does not support RFC 5746 as indicated by the presence of the pseudo-ciphersuite TLS_EMPTY_RENEGOTIATION_INFO_SCSV. This is available JRE/JDK 6 update 22 @@ -878,16 +878,16 @@ allowed to use. By default, the default ciphers for the JVM will be used. Note that this usually means that the weak export grade ciphers will be included in the list of available ciphers. The ciphers are specified using - the JSSE cipher naming convention. The special value of ALL + the JSSE cipher naming convention. The special value of ALL will enable all supported ciphers. This will include many that are not - secure. ALL is intended for testing purposes only.

+ secure. ALL is intended for testing purposes only.

-

Set to true if you want the SSL stack to require a +

Set to true if you want the SSL stack to require a valid certificate chain from the client before accepting a connection. - Set to want if you want the SSL stack to request a client - Certificate, but not fail if one isn't presented. A false + Set to want if you want the SSL stack to request a client + Certificate, but not fail if one isn't presented. A false value (which is the default) will not require a certificate chain unless the client requests a resource protected by a security constraint that uses CLIENT-CERT authentication.

@@ -946,7 +946,7 @@

The type of keystore file to be used for the server certificate. - If not specified, the default value is "JKS".

+ If not specified, the default value is JKS".

@@ -968,14 +968,14 @@

The class name of the SSL implementation to use. If not specified, the - default of org.apache.tomcat.util.net.jsse.JSSEImplementation + default of org.apache.tomcat.util.net.jsse.JSSEImplementation will be used which wraps JVM's default JSSE provider. Note that the JVM can be configured to use a different JSSE provider as the default.

The version of the SSL protocol to use. If not specified, - the default is "TLS".

+ the default is TLS.

--- webapps/docs/tomcat-docs.xsl (revision 1080234) +++ webapps/docs/tomcat-docs.xsl (working copy) @@ -543,6 +543,11 @@ + + + "" + +