|
Internal Name: |
Tomcat Connector |
|
Description: |
|
|
Singleton: |
no |
|
Plugin: |
Tomcat |
|
Name |
Description |
Required |
Internal Name |
|
Object Name |
|
yes |
objectName |
|
Port |
Port on which this connector is configured to listen. |
yes |
port |
|
Handler |
Connector protocol handler. |
yes |
handler |
|
Address |
For servers with more than one IP address, this attribute specifies which address will be used for listening on the specified port. By default, this port will be used on all IP addresses associated with the server. |
no |
address |
|
Shared Executor Name |
If this Connector is configured to use a shared Executor for its thread pool, this is the name of that Executor. This is required to successfully collect threadpool metrics for the Connector. Leave this unset if the Connector is not using a shared Executor for its threadpool. |
no |
sharedExecutorName |
|
Name Template |
|
yes |
nameTemplate |
|
Description Template |
|
yes |
descriptionTemplate |
You must use the internal name to reference properties in Dynamic Group Definition expressions.
|
Name |
Type |
Description |
Internal Name |
|
Maximum Request Time |
measurement |
Maximum time it took to process a request. |
Catalina:type=GlobalRequestProcessor,name=%handler%%address%-%port%:maxTime |
|
Request count |
measurement |
Total number of requests processed since last restart. |
Catalina:type=GlobalRequestProcessor,name=%handler%%address%-%port%:requestCount |
|
Request count per Minute |
measurement |
Total number of requests processed since last restart. |
Catalina:type=GlobalRequestProcessor,name=%handler%%address%-%port%:requestCount |
|
Error count |
measurement |
Number of errors while processing since last restart. |
Catalina:type=GlobalRequestProcessor,name=%handler%%address%-%port%:errorCount |
|
Error count per Minute |
measurement |
Number of errors while processing since last restart. |
Catalina:type=GlobalRequestProcessor,name=%handler%%address%-%port%:errorCount |
|
Threadpool Threads Active |
measurement |
Number of current busy threads. |
Catalina:type=ThreadPool,name=%handler%%address%-%port%:currentThreadsBusy |
|
Threadpool Threads Allocated |
measurement |
Number of current threads. |
Catalina:type=ThreadPool,name=%handler%%address%-%port%:currentThreadCount |
|
Threadpool Max Threads |
measurement |
Maximum number of threads that can be allocated for the ThreadPool. |
Catalina:type=ThreadPool,name=%handler%%address%-%port%:maxThreads |
You must use the internal name to reference traits in Dynamic Group Definition expressions.
|
Name |
Description |
Required |
Internal Name |
|
Allow Trace |
A boolean value which can be used to enable or disable the TRACE HTTP method. If not specified, this attribute is set to false. |
yes |
allowTrace |
|
Buffer Size |
HTTP: The size (in bytes) of the buffer to be provided for input streams created by this connector. By default, buffers of 2048 bytes will be provided. AJP: The size of the output buffer to use. If less than or equal to zero, then output buffering is disabled. The default value is -1 (i.e. buffering disabled) |
yes |
bufferSize |
|
Connection Timeout |
HTTP: The number of milliseconds this Connector will wait, after accepting a connection, for the request URI line to be presented. The default value is 60000 (i.e. 60 seconds). AJP: The number of milliseconds this Connector will wait, after accepting a connection, for the request URI line to be presented. The default value is infinite (i.e. no timeout). |
no |
connectionTimeout |
|
Empty Session Path |
If set to true, all paths for session cookies will be set to /. This can be useful for portlet specification implementations, but will greatly affect performance if many applications are accessed on a given server by the client. If not specified, this attribute is set to false. |
yes |
emptySessionPath |
|
Enable Lookups |
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 address in String form instead (thereby improving performance). By default, DNS lookups are enabled. |
yes |
enableLookups |
|
Keep Alive Timeout |
Ignored prior to Tomcat 6. HTTP: The number of milliseconds this Connector will wait for another HTTP request before closing the connection. The default value is to use the value that has been set for the connectionTimeout attribute. AJP: The number of milliseconds this Connector will wait for another AJP request before closing the connection. The default value is to use the value that has been set for the connectionTimeout attribute. |
no |
keepAliveTimeout |
|
Max Post Size |
The maximum size in bytes of the POST which will be handled by the container FORM URL parameter parsing. The limit can be disabled by setting this attribute to a value less than or equal to 0. If not specified, this attribute is set to 2097152 (2 megabytes). |
yes |
maxPostSize |
|
Max Threads |
HTTP: The maximum number of request processing threads to be created by this Connector, which therefore determines the maximum number of simultaneous requests that can be handled. If not specified, this attribute is set to 40. If an executor is associated with this connector, this attribute is ignored as the connector will execute tasks using the executor rather than an internal thread pool. AJP: The maximum number of request processing threads to be created by this Connector, which therefore determines the maximum number of simultaneous requests that can be handled. If not specified, this attribute is set to 200. If an executor is associated with this connector, this attribute is ignored as the connector will execute tasks using the executor rather than an internal thread pool. |
no |
maxThreads |
|
Protocol |
The protocol to handle incoming traffic. |
yes |
protocol |
|
Proxy Name |
If this Connector is being used in a proxy configuration, configure this attribute to specify the server name to be returned for calls to request.getServerName(). |
no |
proxyName |
|
Proxy Port |
If this Connector is being used in a proxy configuration, configure this attribute to specify the server port to be returned for calls to request.getServerPort(). |
no |
proxyPort |
|
Redirect Port |
If this Connector is supporting non-SSL requests, and a request is received for which a matching security-constraint requires SSL transport, Catalina will automatically redirect the request to the port number specified here. |
yes |
redirectPort |
|
Scheme |
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' |
yes |
scheme |
|
Secure |
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 |
no |
secure |
|
TCP NoDelay |
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. |
no |
tcpNoDelay |
|
URI Encoding |
This specifies the character encoding used to decode the URI bytes, after %xx decoding the URL. If not specified, ISO-8859-1 will be used. |
no |
URIEncoding |
|
Use Body Encoding for URI |
This specifies if the encoding specified in contentType should be used for URI query parameters, instead of using the URIEncoding. This setting is present for compatibility with Tomcat 4.1.x. |
yes |
useBodyEncodingForURI |
|
X-Powered-By |
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. |
yes |
xpoweredBy |
|
Accept Count |
The maximum queue length for incoming connection requests when all possible request processing threads are in use. Any requests received when the queue is full will be refused. The default value is 10. |
no |
acceptCount |
|
Compression |
The Connector may use HTTP/1.1 GZIP compression in an attempt to save server bandwidth. The acceptable values for the parameter is 'off' (disable compression), 'on' (allow compression, which causes text data to be compressed), 'force' (forces compression in all cases), or a numerical integer value (which is equivalent to 'on', but specifies the minimum amount of data before the output is compressed). If the content-length is not known and compression is set to 'on' or more aggressive, the output will also be compressed. If not specified, this attribute is set to 'off'. |
no |
compression |
|
Connection Linger |
The number of milliseconds during which the sockets used by this Connector will linger when they are closed. (-1 socket linger is disabled). |
no |
connectionLinger |
|
Disable Upload Timeout |
This flag allows the servlet container to use a different, longer connection timeout while a servlet is being executed, which in the end allows either the servlet a longer amount of time to complete its execution, or a longer timeout during data upload. If not specified, this attribute is set to true. |
no |
disableUploadTimeout |
|
Max Http Header Size |
The maximum size of the request and response HTTP header, specified in bytes. If not specified, this attribute is set to 4096 (4 KB). |
no |
maxHttpHeaderSize |
|
Max Keep Alive Requests |
The maximum number of HTTP requests which can be pipelined until the connection is closed by the server. Setting this attribute to 1 will disable HTTP/1.0 keep-alive, as well as HTTP/1.1 keep-alive and pipelining. Setting this to -1 will allow an unlimited amount of pipelined or keep-alive HTTP requests. If not specified, this attribute is set to 100. |
no |
maxKeepAliveRequests |
|
Max Spare Threads |
The maximum number of unused request processing threads that will be allowed to exist until the thread pool starts stopping the unnecessary threads. The default value is 50. |
no |
maxSpareThreads |
|
Min Spare Threads |
The number of request processing threads that will be created when this Connector is first started. The connector will also make sure it has the specified number of idle processing threads available. This attribute should be set to a value smaller than that set for maxThreads. The default value is 4. |
no |
minSpareThreads |
|
Strategy |
The thread pooling strategy which will be used. The default strategy does not use a master thread, but a more conventional strategy using a master listener thread can be used by setting 'ms' as this attribute's value. The master strategy will work significantly better using the threadPriority attribute, which will apply only to the thread which listens on the server socket. This is set to 'lf' by default. |
no |
strategy |
|
Thread Priority |
The priority of the request processing threads within the JVM. The default value is java.lang.Thread#NORM_PRIORITY. See the JavaDoc for the java.lang.Thread class for more details on what this priority means. |
no |
threadPriority |
|
Algorithm |
The certificate encoding algorithm to be used. This defaults to the Sun implementation (SunX509). For IBM JVMs you should use the value IbmX509. For other vendors, consult the JVM documentation for the correct value. |
no |
algorithm |
|
Ciphers |
The comma separated list of encryption ciphers that this socket is 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. |
no |
ciphers |
|
Client Authentication |
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 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. |
no |
clientAuth |
|
Key Alias |
The alias used to for the server certificate in the keystore. If not specified the first key read in the keystore will be used. |
no |
keyAlias |
|
Keystore Password |
The password used to access the server certificate from the specified keystore file. |
no |
keystorePass |
|
Keystore File |
Path to the keystore file used to validate client certificates. |
no |
keystoreFile |
|
Keystore Type |
The type of keystore file to be used for the server certificate. If not specified, the default value is 'JKS'. |
no |
keystoreType |
|
SSL Protocol |
The version of the SSL protocol to use. If not specified, the default is 'TLS'. |
no |
sslProtocol |
|
Trust Store File |
Path to the trust store file used to validate client certificates. |
no |
trustStoreFile |
|
Trust Store Password |
The password to access the TrustStore. This defaults to the value of Keystore Password. |
no |
trustStorePass |
|
Trust Store Type |
Add this element if your are using a different format for the TrustStore then you are using for the KeyStore. |
no |
trustStoreType |
|
Tomcat Authentication |
If set to true, the authentication will be done in Tomcat. Otherwise, the authenticated principal will be propagated from the native web server and used for authorization in Tomcat. The default value is true. |
no |
tomcatAuthentication |
You must use the internal name to reference properties in Dynamic Group Definition expressions.
|
Name |
Description |
|
Start |
Starts this connector |
|
Stop |
Stops this connector |
|
Pause |
Pauses this connector |
|
Resume |
Resumes this connector |