diff options
Diffstat (limited to 'rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference')
6 files changed, 3748 insertions, 0 deletions
diff --git a/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/apache.xml b/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/apache.xml new file mode 100644 index 00000000..e4ad0360 --- /dev/null +++ b/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/apache.xml @@ -0,0 +1,1119 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!DOCTYPE document [ + <!ENTITY project SYSTEM "project.xml"> +]> +<document url="apache.html"> + + &project; + + <properties> + <author email="mturk@apache.org">Mladen Turk</author> + <title>Configuring Apache</title> + </properties> + +<body> + +<section name="Configuration Directives"> +<p> +Most of the directives are allowed once in the global part of the Apache httpd +configuration and once in every <VirtualHost> elements. Exceptions from this rule are +explicitly listed in the table below. +</p> +<p> +Most values are inherited from the main server to the virtual hosts. +Since version 1.2.20 they can be overwritten in the virtual hosts. +Exceptions from this rule are again explicitly listed in the table below. +See especially JkMountCopy. +</p> +<warn> +Warning: If Apache httpd and Tomcat are configured to serve content from +the same filing system location then care must be taken to ensure that httpd is +not able to serve inappropriate content such as the contents of the WEB-INF +directory or JSP source code. +</warn> +<p> +This could occur if the httpd DocumentRoot +overlaps with a Tomcat Host's appBase or the docBase of any Context. It could +also occur when using the httpd Alias directive with a Tomcat Host's appBase or +the docBase of any Context. +</p> +<p> +Here are the all directives supported by Apache: +</p> +<attributes name="Directive"> +<attribute name="JkWorkersFile" required="false"><p> +The name of a worker file for the Tomcat servlet containers. +<br/> +This directive is only allowed once. It must be put into +the global part of the configuration. +<br/> +If you don't use the JkWorkerProperty directives, then you must +define your workers with a valid JkWorkersFile. There is no default +value. +</p></attribute> +<attribute name="JkWorkerProperty" required="false"><p> +Enables setting worker properties inside Apache configuration file. +The syntax is the same as in the JkWorkersFile (usually workers.properties). +Simply prefix each line with "JkWorkerProperty" to put it directly into +the Apache httpd config files. +<br/> +This directive is allowed multiple times. +It must be put into the global part of the configuration. +<br/> +If you don't use the JkWorkerProperty directives, then you must +define your workers with a valid JkWorkersFile. There is no default +value. +<br/> +This directive is available in jk1.2.7 version and later. +</p></attribute> +<attribute name="JkShmFile" required="false"><p> +Shared memory file name. Used only on unix platforms. +The shm file is used by balancer and status workers. +<br/> +This directive is only allowed once. It must be put into +the global part of the configuration. +<br/> +The default value is logs/jk-runtime-status. +It is highly recommended that the shm file be placed on a local +drive and not an NFS share. +</p> +<p> +The shared memory contains configuration and runtime information for load balancer +workers and their members. It is need in order that all apache children +<ul> +<li>share the same status information for load balancing members (OK, ERROR, ...),</li> +<li>share the information about load taken by the individual workers,</li> +<li>share the information for the parts of the configuration, which are changeable +during runtime by status workers.</li> +</ul> +</p> +</attribute> +<attribute name="JkShmSize" required="false"><p> +Size of the shared memory file name. +<br/> +This directive is only allowed once. It must be put into +the global part of the configuration. +<br/> +The default value depends on the platform. It is usually less than 64KB. +</p></attribute> +<p>Starting with version 1.2.27 the size of the shared memory is determined +automatically, even for large numbers of workers. This attribute is not +needed any longer.</p> +<attribute name="JkMountFile" required="false"><p> +File containing multiple mappings from a context to a Tomcat worker. +It is usually called uriworkermap.properties. +<br/> +For inheritance rules, see: JkMountCopy. +<br/> +There is no default value. +</p></attribute> +<attribute name="JkMountFileReload" required="false"><p> +This directive configures the reload check interval in seconds. +The JkMountFile is checked periodically for changes. +A changed file gets reloaded automatically. If you set +this directive to "0", reload checking is turned off. +<br/> +The default value is 60 seconds. +<br/> +This directive has been added in version 1.2.20 of mod_jk. +</p></attribute> +<attribute name="JkMount" required="false"><p> +A mount point from a context to a Tomcat worker. +<br/> +This directive is allowed multiple times. +It is allowed in the global configuration and in VirtualHost. +You can also use it inside Location with a different syntax. +Inside Location, one omits the first argument (path), +which gets inherited from the Location. +<br/> +By default JkMount entries are not inherited from the global +server to other VirtualHosts or between VirtualHosts. +For the complete inheritance rules, see: JkMountCopy. +</p></attribute> +<attribute name="JkUnMount" required="false"><p> +An exclusion mount point from a context to a Tomcat worker. +All exclusion mounts are checked after mapping a request +to a tomcat worker. If the request maps also to an exclusion, +it will not be forwarded to tomcat, and instead be served locally. +<br/> +This directive is allowed multiple times. +It is allowed in the global configuration and in VirtualHost. +You can also use it inside Location with a different syntax. +Inside Location, one omits the first argument (path), +which gets inherited from the Location. +For inheritance rules, see: JkMountCopy. +<br/> +This directive is available in jk1.2.7 version and later. +</p></attribute> +<attribute name="JkAutoAlias" required="false"><p> +Automatically Alias webapp context directories into the Apache +document space. +<br/> +Care should be taken to ensure that only static content is served via httpd as a +result of using this directive. Any static content served by httpd will bypass any +security constraints defined in the application's web.xml. +<br/> +For inheritance rules, see: JkMountCopy. +<br/> +There is no default value. +</p></attribute> +<attribute name="JkMountCopy" required="false"><p> +If this directive is set to "On" in some virtual server, +the mounts from the global server will be copied to this +virtual server, more precisely all mounts defined by JkMount +or JkUnMount. The Mounts defined by JkMountFile and JkAutoAlias +will only be inherited, if the VirtualHost does not define +it's own JkMountFile or JkAutoAlias. +<br/> +If you want all vhost to inherit mounts from the main server, +you can set JkMountCopy to 'All' in the main server. +<br/> +This directive is only allowed inside VirtualHost (with value "On") +and in the global server (with value "All"). +<br/> +The default is Off, so no mounts will be inherited from the global +server to any VirtualHost. +<br/> +Starting with version 1.2.26 you can also set it to "All" in the +global virtual server. This will switch the default to On. +</p></attribute> +<attribute name="JkWorkerIndicator" required="false"><p> +Name of the Apache environment variable that can be used to set worker names +in combination with SetHandler jakarta-servlet. +<br/> +This directive is only allowed once per virtual server. +It is allowed in the global configuration and in VirtualHost. +<br/> +The default value is JK_WORKER_NAME. +</p></attribute> +<attribute name="JkWatchdogInterval" required="false"><p> +This directive configures the watchdog thread interval in seconds. +The workers are maintained periodically by a background thread +running periodically every watchdog_interval seconds. Worker maintenance +checks for idle connections, corrects load status and is able +to detect backend health status. +<br/> +The maintenance only happens, if since the last maintenance at +least <a href="workers.html"><code>worker.maintain</code></a> +seconds have passed. So setting the JkWatchdogInterval +much smaller than <code>worker.maintain</code> is not useful. +<br/> +The default value is 0 seconds, meaning the watchdog thread +will not be created, and the maintenance is done in combination +with normal requests instead. +<br/> +This directive is only allowed once. It must be put into +the global part of the configuration. +<br/> +This directive has been added in version 1.2.27 of mod_jk. +It is available only for httpd 2.x and above using APR libraries +including thread support. +</p></attribute> +<attribute name="JkLogFile" required="false"><p> +Full or server relative path to the Tomcat Connector module log file. +It will also work with pipe, by using a value of the form "| ...". +<br/> +The default value is logs/mod_jk.log. +<br/> +Pipes are supported for Apache 1.3 only since version 1.2.16. +The default value exists only since version 1.2.20. +</p></attribute> +<attribute name="JkLogLevel" required="false"><p> +The Tomcat Connector module log level, can be debug, info, warn +error or trace. +<br/> +The default value is info. +</p></attribute> +<attribute name="JkLogStampFormat" required="false"><p> +The Tomcat Connector module <b>date</b> log format, using an +extended strftime syntax. +This format will be used for the time stamps in the JkLogFile. +The maximum length of the format is 63 characters. +<br/> +Starting with version 1.2.24 of mod_jk you can also use %Q +for adding milliseconds to the log and %q for microseconds. +These conversion specifiers are an extension to strftime. +They will only work on platforms with a gettimeofday() function. +You can use %Q and %q only once in the pattern and also not both +together in the same pattern. +<br/> +The default value is "[%a %b %d %H:%M:%S %Y] " and beginning +with version 1.2.24 on platforms with a gettimeofday() +function it is "[%a %b %d %H:%M:%S.%Q %Y] ". +</p></attribute> +<attribute name="JkRequestLogFormat" required="false"><p> +Request log format string. See detailed description below. +<br/> +There is no default value. Without defining a value, the request logging +is turned off. +</p></attribute> +<attribute name="JkExtractSSL" required="false"><p> +Turns on SSL processing and information gathering by mod_jk +<br/> +The default value is On. +<br/> +In order to make SSL data available for mod_jk in Apache, you need to +set <code>SSLOptions +StdEnvVars</code>. For the certificate information you also need +to add <code>SSLOptions +ExportCertData</code>. +</p> +<p> + Specifically, mod_jk will export the following environment variables from + Apache httpd to Tomcat under these request attributes as per the + Servlet Specification 3.0, section 3.8: +</p> +<table> + <tr><th>Env Var</th><th>Request Attribute Name</th><th>Type</th><th>Example</th></tr> + <tr> + <td>SSL_CIPHER<br/>(or <code>JkKEYSIZEIndicator</code>)</td> + <td>javax.servlet.request.cipher_suite</td> + <td>java.lang.String</td> + <td>DHE-RSA-AES256-SHA</td> + </tr> + <tr> + <td>SSL_CIPHER_USEKEYSIZE<br/>(or <code>JkKEYSIZEIndicator</code>)</td> + <td>javax.servlet.request.key_size</td> + <td>java.lang.Integer</td> + <td>256</td> + </tr> + <tr> + <td>SSL_SESSION_ID<br/>(or <code>JkSESSIONIndicator</code>)</td> + <td>javax.servlet.request.ssl_session</td> + <td>java.lang.String</td> + <td>905...32E (a hex string)</td> + </tr> + <tr> + <td>SSL_CLIENT_CERT_CHAIN_<i>n</i><br/>(or <code>JkCERTCHAINPrefix</code><i>n</i>)</td> + <td>javax.servlet.request.X509Certificate</td> + <td>java.security.X509Certificate[]</td> + <td>(A chain of certs in ascending order of trust, the first one being + ths client's certificate, the second being the signer of that + certificate, and so on)</td> + </tr> +</table> +<p> + For all other SSL-related variables, use <code>JkEnvVar</code> for each + variable you want. Please note that, like <code>JkEnvVar</code>, these + variables are available from the request <i><b>attributes</b></i>, not as + environment variables or as request headers. +</p> +</attribute> +<attribute name="JkHTTPSIndicator" required="false"><p> +Name of the Apache environment variable that contains SSL indication. +<br/> +The default value is "HTTPS". +</p></attribute> +<attribute name="JkCERTSIndicator" required="false"><p> +Name of the Apache environment variable that contains SSL client certificates. +<br/> +The default value is "SSL_CLIENT_CERT". +</p></attribute> +<attribute name="JkCIPHERIndicator" required="false"><p> +Name of the Apache environment variable that contains SSL client cipher. +<br/> +The default value is "SSL_CIPHER". +</p></attribute> +<attribute name="JkCERTCHAINPrefix" required="false"><p> +Name of the Apache environment (prefix) that contains SSL client chain certificates. +<br/> +The default value is "SSL_CLIENT_CERT_CHAIN_". +</p></attribute> +<attribute name="JkSESSIONIndicator" required="false"><p> +Name of the Apache environment variable that contains SSL session. +<br/> +The default value is "SSL_SESSION_ID". +</p></attribute> +<attribute name="JkKEYSIZEIndicator" required="false"><p> +Name of the Apache environment variable that contains SSL key size in use. +<br/> +The default value is "SSL_CIPHER_USEKEYSIZE". +</p></attribute> +<attribute name="JkLocalNameIndicator" required="false"><p> +Name of the Apache environment variable which can be used to overwrite +the forwarded local name. +Use this only if you need to adjust the data (see the +<a href="../generic_howto/proxy.html">proxy</a> documentation). +<br/> +The default value is "JK_LOCAL_NAME". +<br/> +This directive has been added in version 1.2.28 of mod_jk. +</p></attribute> +<attribute name="JkLocalPortIndicator" required="false"><p> +Name of the Apache environment variable which can be used to overwrite +the forwarded local port. +Use this only if you need to adjust the data (see the +<a href="../generic_howto/proxy.html">proxy</a> documentation). +<br/> +The default value is "JK_LOCAL_PORT". +<br/> +This directive has been added in version 1.2.28 of mod_jk. +</p></attribute> +<attribute name="JkRemoteHostIndicator" required="false"><p> +Name of the Apache environment variable which can be used to overwrite +the forwarded remote (client) host name. +Use this only if you need to adjust the data (see the +<a href="../generic_howto/proxy.html">proxy</a> documentation). +<br/> +The default value is "JK_REMOTE_HOST". +<br/> +This directive has been added in version 1.2.28 of mod_jk. +</p></attribute> +<attribute name="JkRemoteAddrIndicator" required="false"><p> +Name of the Apache environment variable which can be used to overwrite +the forwarded remote (client) IP address. +Use this only if you need to adjust the data (see the +<a href="../generic_howto/proxy.html">proxy</a> documentation). +<br/> +The default value is "JK_REMOTE_ADDR". +<br/> +This directive has been added in version 1.2.28 of mod_jk. +</p></attribute> +<attribute name="JkRemotePortIndicator" required="false"><p> +Name of the Apache environment variable which can be used to overwrite +the forwarded remote (client) IP address. +Use this only if you need to adjust the data (see the +<a href="../generic_howto/proxy.html">proxy</a> documentation). +<br/> +The default value is "JK_REMOTE_PORT". +<br/> +This directive has been added in version 1.2.32 of mod_jk. +</p></attribute> +<attribute name="JkRemoteUserIndicator" required="false"><p> +Name of the Apache environment variable which can be used to overwrite +the forwarded user name. +Use this only if you need to adjust the data (see the +<a href="../generic_howto/proxy.html">proxy</a> documentation). +<br/> +The default value is "JK_REMOTE_USER". +<br/> +This directive has been added in version 1.2.28 of mod_jk. +</p></attribute> +<attribute name="JkAuthTypeIndicator" required="false"><p> +Name of the Apache environment variable which can be used to overwrite +the forwarded authentication type. +Use this only if you need to adjust the data (see the +<a href="../generic_howto/proxy.html">proxy</a> documentation). +<br/> +The default value is "JK_AUTH_TYPE". +<br/> +This directive has been added in version 1.2.28 of mod_jk. +</p></attribute> +<attribute name="JkOptions" required="false"><p> +Set one of more options to configure the mod_jk module. See below for +details about this directive. +<br/> +This directive can be used multiple times per virtual server. +<br/> +The default value is "ForwardURIProxy" since version 1.2.24. +It was "ForwardURICompatUnparsed" in version 1.2.23 and +"ForwardURICompat" until version 1.2.22. +</p></attribute> +<attribute name="JkEnvVar" required="false"><p> +Adds a name and an optional default value of environment variable +that should be sent to servlet-engine as a request attribute. +If the default value is not given explicitly, the variable +will only be send, if it is set during runtime. +<br/> +The default is empty, so no additional variables will be sent. +<br/> +This directive can be used multiple times per virtual server. +The settings will be merged between the global server and any +virtual server. +<br/> +You can retrieve the variables on Tomcat as request attributes +via request.getAttribute(attributeName). Note that the variables +send via JkEnvVar will not be listed in request.getAttributeNames(). +<br/> +Empty default values are supported since version 1.2.20. +Not sending variables with empty defaults and empty runtime value +has been introduced in version 1.2.21. +</p></attribute> +<attribute name="JkStripSession" required="false"><p> +If this directive is set to On in some virtual server, +the session IDs <code>;jsessionid=...</code> will be +removed for non matched URLs. +<br/> +This directive is only allowed inside VirtualHost. +<br/> +The default is Off. +<br/> +This directive has been introduced in version 1.2.21. +<br/>With version 1.2.27 and later this directive can have optional +session ID identifier. If not specified it defaults to +<code>;jsessionid</code>. +</p> +</attribute> + +</attributes> +</section> + +<section name="Configuration Directives Types"> +<p> +We'll discuss here the mod_jk directive types. +</p> + +<subsection name="Define workers"> +<p> +<b>JkWorkersFile</b> specify the location where mod_jk will find the workers definitions. +Take a look at <a href="workers.html">Workers documentation</a> for detailed description. + +<source> + JkWorkersFile /etc/httpd/conf/workers.properties +</source> + +<br/> +<br/> +</p> + +</subsection> + +<subsection name="Logging"> +<p> +<b>JkLogFile</b> specify the location where mod_jk is going to place its log file. +</p> + +<source> + JkLogFile /var/log/httpd/mod_jk.log +</source> + +<p> +Since JK 1.2.3 for Apache 2.x and JK 1.2.16 for Apache 1.3 this can also +be used for piped logging: +</p> + +<source> + JkLogFile "|/usr/bin/rotatelogs /var/log/httpd/mod_jk.log 86400" +</source> + +<p> +<b>JkLogLevel</b> +set the log level between : +</p> + +<ul> +<li> +<b>info</b> log will contain standard mod_jk activity (default). +</li> +<li> +<b>warn</b> log will contain non fatal error reports. +</li> +<li> +<b>error</b> log will contain also error reports. +</li> +<li> +<b>debug</b> log will contain all information on mod_jk activity +</li> +<li> +<b>trace</b> log will contain all tracing information on mod_jk activity +</li> +</ul> + +<source> + JkLogLevel info +</source> + +<p> +<code>info</code> should be your default selection for normal operations. +<br/> +<br/> +</p> + +<p> +<b>JkLogStampFormat</b> will configure the date/time format found on mod_jk log file. +Using the strftime() format string it's set by<br /> +default to <b>"[%a %b %d %H:%M:%S %Y]"</b> +</p> + +<source> + JkLogStampFormat "[%a %b %d %H:%M:%S %Y] " +</source> + +<p> +<br/> +<br/> +</p> + +<p> +<b>JkRequestLogFormat</b> will configure the format of mod_jk individual request logging. +Request logging is configured and enabled on a per virtual host basis. +To enable request logging for a virtual host just add a JkRequestLogFormat config. +The syntax of the format string is similar to the Apache LogFormat command, +here is a list of the available request log format options: +</p> + +<p> +<attributes name="Options"> + <attribute name="%b" required="false">Bytes sent, excluding HTTP headers (CLF format)</attribute> + <attribute name="%B" required="false">Bytes sent, excluding HTTP headers</attribute> + <attribute name="%H" required="false">The request protocol</attribute> + <attribute name="%m" required="false">The request method</attribute> + <attribute name="%p" required="false">The canonical Port of the server serving the request</attribute> + <attribute name="%q" required="false">The query string (prepended with a ? if a query string exists, otherwise an empty string)</attribute> + <attribute name="%r" required="false">First line of request</attribute> + <attribute name="%s" required="false">Request HTTP status code</attribute> + <attribute name="%T" required="false">Request duration, elapsed time to handle request in seconds '.' micro seconds</attribute> + <attribute name="%U" required="false">The URL path requested, not including any query string.</attribute> + <attribute name="%v" required="false">The canonical ServerName of the server serving the request</attribute> + <attribute name="%V" required="false">The server name according to the UseCanonicalName setting</attribute> + <attribute name="%w" required="false">Tomcat worker name</attribute> + <attribute name="%R" required="false">Real worker name</attribute> +</attributes> + +<source> + JkRequestLogFormat "%w %V %T" +</source> + +<br/> +<br/> +</p> + +<p> +You can also log mod_jk information using the Apache standard module <b>mod_log_config</b>. +The module sets several notes in the Apache httpd notes table. +Most of them are are only useful in combination with a load balancer worker. +</p> + +<p> +<attributes name="Note"> + <attribute name="JK_WORKER_NAME" required="false">Name of the worker selected by the URI mapping</attribute> + <attribute name="JK_WORKER_TYPE" required="false">Type of the worker selected by the URI mapping</attribute> + <attribute name="JK_WORKER_ROUTE" required="false">Actual worker name selected by the URI mapping (usually a member of the load balancer).<br/> + Before version 1.2.26 only available if JkRequestLogFormat is set.</attribute> + <attribute name="JK_REQUEST_DURATION" required="false">Request duration in seconds and microseconds.<br/> + Before version 1.2.26 only available if JkRequestLogFormat is set.</attribute> + <attribute name="JK_LB_FIRST_NAME" required="false">Load-Balancer: Name of the first worker tried</attribute> + <attribute name="JK_LB_FIRST_TYPE" required="false">Load-Balancer: Type of the first worker tried</attribute> + <attribute name="JK_LB_FIRST_ACCESSED" required="false">Load-Balancer: Access count for the first worker tried</attribute> + <attribute name="JK_LB_FIRST_READ" required="false">Load-Balancer: Bytes read for the first worker tried</attribute> + <attribute name="JK_LB_FIRST_TRANSFERRED" required="false">Load-Balancer: Bytes transferred for the first worker tried</attribute> + <attribute name="JK_LB_FIRST_ERRORS" required="false">Load-Balancer: Error count for the first worker tried</attribute> + <attribute name="JK_LB_FIRST_BUSY" required="false">Load-Balancer: Busy count for the first worker tried</attribute> + <attribute name="JK_LB_FIRST_ACTIVATION" required="false">Load-Balancer: Activation state for the first worker tried</attribute> + <attribute name="JK_LB_FIRST_STATE" required="false">Load-Balancer: Error state for the first worker tried</attribute> + <attribute name="JK_LB_LAST_NAME" required="false">Load-Balancer: Name of the last worker tried</attribute> + <attribute name="JK_LB_LAST_TYPE" required="false">Load-Balancer: Type of the last worker tried</attribute> + <attribute name="JK_LB_LAST_ACCESSED" required="false">Load-Balancer: Access count for the last worker tried</attribute> + <attribute name="JK_LB_LAST_READ" required="false">Load-Balancer: Bytes read for the last worker tried</attribute> + <attribute name="JK_LB_LAST_TRANSFERRED" required="false">Load-Balancer: Bytes transferred for the last worker tried</attribute> + <attribute name="JK_LB_LAST_ERRORS" required="false">Load-Balancer: Error count for the last worker tried</attribute> + <attribute name="JK_LB_LAST_BUSY" required="false">Load-Balancer: Busy count for the last worker tried</attribute> + <attribute name="JK_LB_LAST_ACTIVATION" required="false">Load-Balancer: Activation state for the last worker tried</attribute> + <attribute name="JK_LB_LAST_STATE" required="false">Load-Balancer: Error state for the last worker tried</attribute> +</attributes> + +<source> + LogFormat "%h %l %u %t \"%r\" %>s %b %{JK_WORKER_NAME}n %{JK_LB_FIRST_NAME}n \ + %{JK_LB_FIRST_BUSY}n %{JK_LB_LAST_NAME}n %{JK_LB_LAST_BUSY}n" mod_jk_log + CustomLog logs/access_log mod_jk_log +</source> + +<br/> +<br/> +</p> + +</subsection> + +<subsection name="Forwarding"> +<p> +The directive JkOptions allow you to set many forwarding options which will enable (+) +or disable (-) following option. Without any leading signs, options will be enabled. +<br/> +<br/> +</p> + +<p> +The four following options <b>+ForwardURIxxx</b> are mutually exclusive. +Exactly one of them is required, a negative sign prefix is not allowed with them. +The default value is "ForwardURIProxy" since version 1.2.24. +It was "ForwardURICompatUnparsed" in version 1.2.23 and +"ForwardURICompat" until version 1.2.22. +You can turn the default off by switching on one of the other two options. +You should leave this at it's default value, unless you have a very good +reason to change it. +<br/> +<br/> +</p> + +<p> +All options are inherited from the global server to virtual hosts. +Options that support enabling (plus options) and disabling (minus options), +are inherited in the following way: +<br/> +<br/> +options(vhost) = plus_options(global) - minus_options(global) + plus_options(vhost) - minus_options(vhost) +<br/> +<br/> +</p> + +<p> +Using JkOptions <b>ForwardURIProxy</b>, the forwarded URI +will be partially reencoded after processing inside Apache httpd and +before forwarding to Tomcat. This will be compatible with local +URL manipulation by mod_rewrite and with URL encoded session ids. + +<source> + JkOptions +ForwardURIProxy +</source> + +<br/> +<br/> +</p> + +<p> +Using JkOptions <b>ForwardURICompatUnparsed</b>, the forwarded URI +will be unparsed. It's spec compliant and secure. +It will always forward the original request URI, so rewriting +URIs with mod_rewrite and then forwarding the rewritten URI +will not work. + +<source> + JkOptions +ForwardURICompatUnparsed +</source> + +<br/> +<br/> +</p> + +<p> +Using JkOptions <b>ForwardURICompat</b>, the forwarded URI will +be decoded by Apache httpd. Encoded characters will be decoded and +explicit path components like ".." will already be resolved. +This is less spec compliant and is <b>not safe</b> if you are using +prefix JkMount. This option will allow to rewrite URIs with +mod_rewrite before forwarding. + +<source> + JkOptions +ForwardURICompat +</source> + +<br/> +<br/> +</p> + +<p> +Using JkOptions <b>ForwardURIEscaped</b>, the forwarded URI will +be the encoded form of the URI used by ForwardURICompat. +Explicit path components like ".." will already be resolved. +This will not work in combination with URL encoded session IDs, +but it will allow to rewrite URIs with mod_rewrite before forwarding. + +<source> + JkOptions +ForwardURIEscaped +</source> + +<br/> +<br/> +</p> + +<p> +JkOptions <b>RejectUnsafeURI</b> will block all +URLs, which contain percent signs '%' or backslashes '\' +after decoding. +<br/> +<br/> +</p> +<p> +Most web apps do not use such URLs. Using the option RejectUnsafeURI, you +can block several well known URL encoding attacks. By default, this option +is not set. +</p> +<p> +You can also realise such a check with mod_rewrite, which is more powerful +but also slightly more complicated. + +<source> + JkOptions +RejectUnsafeURI +</source> + +<br/> +<br/> +</p> + +<p> +JkOptions <b>ForwardDirectories</b> is used in conjunction with <b>DirectoryIndex</b> +directive of Apache web server. As such mod_dir should be available to Apache, +statically or dynamically (DSO) +<br/> +<br/> +</p> + +<p> +When DirectoryIndex is configured, Apache will create sub-requests for +each of the local-url's specified in the directive, to determine if there is a +local file that matches (this is done by stat-ing the file). +</p> + +<p> +If ForwardDirectories is set to false (default) and Apache doesn't find any +files that match, Apache will serve the content of the directory (if directive +Options specifies Indexes for that directory) or a <code>403 Forbidden</code> response (if +directive Options doesn't specify Indexes for that directory). +</p> + +<p> +If ForwardDirectories is set to true and Apache doesn't find any files that +match, the request will be forwarded to Tomcat for resolution. This is used in +cases when Apache cannot see the index files on the file system for various +reasons: Tomcat is running on a different machine, the JSP file has been +precompiled etc. +</p> + +<p>Note that locally visible files will take precedence over the +ones visible only to Tomcat (i.e. if Apache can see the file, that's the one +that's going to get served). This is important if there is more then one type of +file that Tomcat normally serves - for instance Velocity pages and JSP pages. + +<source> + JkOptions +ForwardDirectories +</source> +<br/> +<br/> +</p> + +<p> +JkOptions <b>ForwardLocalAddress</b>, you ask mod_jk to send the local address, +of the Apache web server instead remote client address. This can be used by +Tomcat remote address valve for allowing connections only from registered Apache +web servers. + +<source> + JkOptions +ForwardLocalAddress +</source> + +<br/> +<br/> +</p> + +<p> +JkOptions <b>FlushPackets</b>, you ask mod_jk to flush Apache's connection +buffer after each AJP packet chunk received from Tomcat. This option can have +a strong performance penalty for Apache and Tomcat as writes are performed +more often than would normally be required (ie: at the end of each +response). + +<source> + JkOptions +FlushPackets +</source> + +<br/> +<br/> +</p> + +<p> +JkOptions <b>FlushHeader</b>, you ask mod_jk to flush Apache's connection +buffer after the response headers have been received from Tomcat. + +<source> + JkOptions +FlushHeader +</source> + +<br/> +<br/> +</p> + +<p> +JkOptions <b>DisableReuse</b>, you ask mod_jk to close connections immediately +after their use. Normally mod_jk uses persistent connections and pools idle +connections to reuse them, when new requests have to be sent to Tomcat. +</p> + +<p> +Using this option will have a strong performance penalty for Apache and Tomcat. +Use this only as a last resort in case of unfixable network problems. +If a firewall between Apache and Tomcat silently kills idle connections, +try to use the worker attribute socket_keepalive in combination with an appropriate +TCP keepalive value in your OS. + +<source> + JkOptions +DisableReuse +</source> + +<br/> +<br/> +</p> + +<p> +JkOptions <b>ForwardKeySize</b>, you ask mod_jk, when using ajp13, to forward also the SSL Key Size as +required by Servlet API 2.3. +This flag shouldn't be set when servlet engine is Tomcat 3.2.x (on by default). + +<source> + JkOptions +ForwardKeySize +</source> + +<br/> +<br/> +</p> + +<p> +JkOptions <b>ForwardSSLCertChain</b>, you ask mod_jk, when using ajp13, +to forward SSL certificate chain (off by default). +Mod_jk only passes the <code>SSL_CLIENT_CERT</code> to the AJP connector. This is not a +problem with self-signed certificates or certificates directly signed by the +root CA certificate. However, there's a large number of certificates signed by +an intermediate CA certificate, where this is a significant problem: A servlet +will not have the possibility to validate the client certificate on its own. The +bug would be fixed by passing on the <code>SSL_CLIENT_CERT_CHAIN</code> to Tomcat via the AJP connector. +<br/> +This directive exists only since version 1.2.22. +<source> + JkOptions +ForwardSSLCertChain +</source> + +<br/> +<br/> +</p> + +<p> +The directive <b>JkEnvVar</b> allows you to forward environment variables +from Apache server to Tomcat engine. +You can add a default value as a second parameter to the directive. +If the default value is not given explicitly, the variable +will only be send, if it is set during runtime. +<br/> +The variables can be retrieved on the Tomcat side as request attributes +via request.getAttribute(attributeName). +Note that the variables send via JkEnvVar will not be listed +in request.getAttributeNames(). +<br/> +<br/> +The variables are inherited from the global server to virtual hosts. + +<source> + JkEnvVar SSL_CLIENT_V_START undefined +</source> +<br/> +<br/> +</p> + +</subsection> + +<subsection name="Assigning URLs to Tomcat"> +<p> +If you have created a custom or local version of mod_jk.conf-local as noted above, +you can change settings such as the workers or URL prefix. +</p> +<p> +<b>JkMount</b> directive assign specific URLs to Tomcat. +In general the structure of a JkMount directive is: +</p> + +<source> + JkMount [URL prefix] [Worker name] +</source> + +<source> + # send all requests ending in .jsp to worker1 + JkMount /*.jsp worker1 + # send all requests ending /servlet to worker1 + JkMount /*/servlet/ worker1 + # send all requests jsp requests to files located in /otherworker will go worker2 + JkMount /otherworker/*.jsp worker2 +</source> + +<p> +You can use the JkMount directive at the top level or inside <VirtualHost> +sections of your httpd.conf file. +</p> +<p><b>JkUnMount</b> directive acts as an opposite to JkMount and blocks access +to a particular URL. The purpose is to be able to filter out the particular content +types from mounted context. The following example mounts /servlet/* +context, but all .gif files that belongs to that context are not served. +</p> +<source> + # send all requests ending with /servlet to worker1 + JkMount /servlet/* worker1 + # do not send requests ending with .gif to worker1 + JkUnMount /servlet/*.gif worker1 +</source> +<p> +JkUnMount takes precedence over JkMount directives, meaning that the JK +will first try to mount and then checks, if there is an exclusion defined by a +JkUnMount. A JkUnMount overrides a JkMount only, if the worker names in the +JkMount and in the JkUnMount are the same. +</p> +<p> +The following example will block all .gif files although there is a JkMount for them: +</p> +<source> + # do not send requests ending with .gif to worker1 + JkUnMount /*.gif worker1 + # The .gif files will not be mounted cause JkUnMount takes + # precedence over JkMount directive + JkMount /servlet/*.gif worker1 +</source> +<p> +Starting with version 1.2.26 of JK you can apply a JkUnMount to any worker, +by using the star character '*' as the worker name in the JkUnMount. +More complex patterns in JkUnMount worker names are not allowed. +</p> +<source> + # Mapping the webapps myapp1 and myapp2: + /myapp1/*=worker1 + /myapp2/*=worker2 + # Exclude the all subdirectories static for all workers: + !/*/static/*=* + # Exclude some suffixes for all workers: + !*.html=* +</source> +<p> +<b>JkAutoAlias</b> directive automatically <b>Alias</b> webapp context directories into +the Apache document space. It enables Apache to serve a static context while Tomcat +serving dynamic context. This directive is used for convenience so that you don't +have to put an apache Alias directive for each application directory inside Tomcat's +webapp directory. For security reasons is is strongly recommended that JkMount +is used to pass all requests to Tomcat by default and JkUnMount is used to +explicitly exclude static content to be served by httpd. It should also be noted +that content served by httpd will bypass any security constraints defined in the +application's web.xml. +</p> +<source> + # enter the full path to the tomcat webapps directory + JkAutoAlias /opt/tomtact/webapps +</source> +<p>The following example shows how to serve a dynamic context by +Tomcat and static using Apache. The webapps directory has to +be accessible by apache.</p> + +<source> + # enter the full path to the tomcat webapps directory + JkAutoAlias /opt/tomtact/webapps + + # Mount 'servlets-examples' directory. It's physical location + # is assumed to be in the /opt/tomtact/webapps/servlets-examples + # ajp13w is a worker defined in the workers.properties + JkMount /servlets-examples/* ajp13w + + # Unmount desired static content from servlets-examples webapp. + # This content will be served by the httpd directly. + JkUnMount /servlets-examples/*.gif ajp13w + JkUnMount /servlets-examples/*.jpg ajp13w +</source> +<p>Note that you can have a single JkAutoAlias directive per virtual +host inside your httpd.conf +</p> +<p> +<b>JkWorkerProperty</b> is a new directive available from JK 1.2.7 +version. It is a convenient method for setting directives that are +usually set inside <b>workers.propeties</b> file. The parameter for +that directive is raw line from workers.properties file. +</p> +<source> + # Just like workers.properties but exact line is prefixed + # with JkWorkerProperty + + # Minimal jk configuration + JkWorkerProperty worker.list=ajp13w + JkWorkerProperty worker.ajp13w.type=ajp13 + JkWorkerProperty worker.ajp13w.host=localhost + JkWorkerProperty worker.ajp13w.port=8009 +</source> +<p> +<b>JkMountFile</b> is a new directive available from JK 1.2.9 +version. It is used for dynamic updates of mount points at runtime. +When the mount file is changed, JK will reload it's content. +</p> +<source> + # Load mount points + + JkMountFile conf/uriworkermap.properties +</source> +<p>If the mount point uri starts with an exclamation mark '!' +it defines an exclusion in the same way JkUnMount does. +If the mount point uri starts with minus sign '-' +the mount point will only be disabled. A disabled mount can be reenabled +by deleting the minus sign and waiting for the JkMountFile to reload. +An exclusion can be disabled by prefixing it with a minus sign. +</p> +<source> + # Sample uriworkermap.properties file + + /servlets-examples/*=ajp13w + # Do not map .jpeg files + !/servlets-examples/*.jpeg=ajp13w + # Make jsp examples initially disabled + -/jsp-examples/*=ajp13w +</source> +<p>At run time you can change the content of this file. For example +removing minus signs will enable the previously disabled uri mappings. +You can add any number of new entries at runtime that reflects the newly deployed +applications. Apache will reload the file and update the mount +points within 60 second interval. +</p> +<p> +There is no way to delete entries by dynamic reloading, but you can disable or +exclude mappings. +<br/> +<br/> +</p> + +</subsection> + +<subsection name="Using SetHandler and Environment Variables"> +<p> +Alternatively to the mod_jk specific directives, you can also use +SetHandler and environment variables to control, which requests +are being forwarded via which worker. This gives you more flexibility, +but the results might be more difficult to understand. If you mix both +ways of defining the forwards, in general to mod_jk directives will win. +</p> +<p> +<b>SetHandler jakarta-servlet</b> forces requests to be handled by mod_jk. +If you neither specify any workers via JkMount and the related directives, +not via the environment variable described below, +the first worker in the list of all worker will be chosen. You can use SetHandler +for example in Location blocks or with Apache 2.2 also in RewriteRule. +</p> +<p> +In order to control the worker using <b>SetEnvIf</b> or <b>RewriteRule</b> +for more complex rules, you can set the environment variable <b>JK_WORKER_NAME</b> +to the name of your chosen target worker. This enables you to decide on +the chosen worker in a more flexible way, including dependencies on cookie values. +This feature has been added in version 1.2.19 of mod_jk. +</p> +<p> +In order to use another variable than <b>JK_WORKER_NAME</b>, you can set the name +of this variable via the <b>JkWorkerIndicator</b> directive. +</p> +<p> +You can also define exclusions from mod_jk forwards by setting the environment +variable <b>no-jk</b>. +</p> +<source> + # Automatically map all encoded urls + <Location *;jsessionid=> + SetHandler jakarta-servlet + SetEnv JK_WORKER_NAME my_worker + </Location> + + # Map all subdirs to workers via naming rule + # and exclude static content. + <Location /apps/> + SetHandler jakarta-servlet + SetEnvIf REQUEST_URI ^/apps/([^/]*)/ JK_WORKER_NAME=$1 + SetEnvIf REQUEST_URI ^/apps/([^/]*)/static no-jk + </Location> +</source> +<p> +Finally, starting with version 1.2.27 you can use the environment variable +<b>JK_REPLY_TIMEOUT</b> to dynamically set a reply timeout. +</p> +</subsection> + </section> +</body> +</document> diff --git a/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/iis.xml b/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/iis.xml new file mode 100644 index 00000000..0539c454 --- /dev/null +++ b/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/iis.xml @@ -0,0 +1,387 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!DOCTYPE document [ + <!ENTITY project SYSTEM "project.xml"> +]> +<document url="iis.html"> + + &project; + + <properties> + <author email="mturk@apache.org">Mladen Turk</author> + <title>Configuring IIS</title> + </properties> + +<body> + +<section name="Requirements"> +<p> +The Tomcat redirector requires three entities: + +<ul> +<li> +<b>isapi_redirect.dll</b> - The IIS server plugin, either obtain a pre-built DLL or build it yourself (see the build section). +</li> +<li> +<b>workers.properties</b> - A file that describes the host(s) and port(s) used by the workers (Tomcat processes). +A sample workers.properties can be found under the conf directory. +</li> +<li> +<b>uriworkermap.properties</b> - A file that maps URL-Path patterns to workers. +A sample uriworkermap.properties can be found under the conf directory as well. +</li> +</ul> +</p> + +<p> +The installation includes the following parts: + +<ul> +<li> +Configuring the ISAPI redirector with a default /examples context and checking that you can serve servlets with IIS. +</li> +<li> +Adding more contexts to the configuration. +</li> +</ul> +</p> +</section> +<section name="Registry settings"> +<p> +ISAPI redirector reads configuration from the registry, create a new registry key named : +</p> +<p> +<b>"HKEY_LOCAL_MACHINE\SOFTWARE\Apache Software Foundation\Jakarta Isapi Redirector\1.0"</b> +</p> +<attributes name="Key Name"> +<attribute name="extension_uri" required="true"><p> +A string value pointing to the ISAPI extension <b>/jakarta/isapi_redirect.dll</b> +</p></attribute> +<attribute name="log_file" required="false"><p> +A value pointing to location where log file will be created. +(for example <b>c:\tomcat\logs\isapi.log</b>) +<br/>If one of the log rotation settings (<b>log_rotationtime</b> or <b>log_filesize</b>) are specified then the actual log file name is based on this setting. +If the log file name includes any '%' characters, then it is treated as a format string for <code>strftime(3)</code>, +e.g. <b>c:\tomcat\logs\isapi-%Y-%m-%d-%H_%M_%S.log</b>. Otherwise, the suffix <em>.nnnnnnnnnn</em> is automatically added and is the time in seconds. +A full list of format string substitutions can be found in the <a href="http://httpd.apache.org/docs/2.0/programs/rotatelogs.html">Apache rotatelogs documentation</a> +</p></attribute> +<attribute name="log_level" required="false"><p> +A string value for log level +(can be debug, info, warn, error or trace).</p> +<p>This directive was added in version 1.2.31</p> +</attribute> +<attribute name="log_rotationtime" required="false"><p> +The time between log file rotations in seconds. +Setting this to 0 (the default) disables log rotation based on time.</p> +<p>This directive was added in version 1.2.31</p> +</attribute> +<attribute name="log_filesize" required="false"><p> +The maximum log file size in megabytes, after which the log file will be rotated. Setting this to 0 (the default) disables log rotation based on file size. +<br/>The value can have an optional <b>M</b> suffix, i.e. both <b>5</b> and <b>5M</b> will rotate the log file when it grows to 5MB. +<br/>If <b>log_rotationtime</b> is specified, then this setting is ignored. +</p></attribute> +<attribute name="worker_file" required="true"><p> +A string value which is the full path to workers.properties file +(for example <b>c:\tomcat\conf\workers.properties</b>) +</p></attribute> +<attribute name="worker_mount_file" required="true"><p> +A string value which is the full path to uriworkermap.properties file +(for example <b>c:\tomcat\conf\uriworkermap.properties</b>) +</p></attribute> +<attribute name="rewrite_rule_file" required="false"><p> +A string value which is the full path to rewrite.properties file +(for example <b>c:\tomcat\conf\rewrite.properties</b>) +</p></attribute> +<attribute name="shm_size" required="false"><p> +A DWORD value size of the shared memory. Set this value to be +the number of all defined workers * 400. +(Set this value only if you have <b>more</b> then <b>64</b> workers) +</p> +<p>This directive has been added in version 1.2.20</p> +<p>Starting with version 1.2.27 the size of the shared memory is determined +automatically, even for large numbers of workers. This attribute is not +needed any longer.</p> +</attribute> +<attribute name="worker_mount_reload" required="false"><p> +A DWORD value specifying the time in seconds upon which the +<b>worker_mount_file</b> will be reloaded. +</p> +<p>This directive has been added in version 1.2.20</p> +</attribute> +<attribute name="strip_session" required="false"><p> +A string value representing a boolean. If it is set to true, +URL session suffixes of the form ";jsessionid=..." get stripped of URLs, +even if the are served locally by the web server. +</p> +<p> +A true value can be represented by the string "1" or any string starting +with the letters "T" or "t". A false value will be assumed for "0" +or any string starting with "F" or "f". The default value is false. +</p> +<p>This directive has been added in version 1.2.21</p> +</attribute> +<attribute name="auth_complete" required="false"><p> +A DWORD value representing "0" or "1". This is needed because +of minor incompatibilities with IIS 5.1. +</p> +<p> +By default its value is 1, which means we use the SF_NOTIFY_AUTH_COMPLETE +event. If you set this to 0, then we use SF_NOTIFY_PREPROC_HEADERS. +This might be needed for IIS 5.1 when handling requests using the +PUT HTTP method. +</p> +<p>This directive has been added in version 1.2.21</p> +</attribute> +<attribute name="uri_select" required="false"><p> +A string value which influences, how URIs are decoded and re-encoded +between IIS and Tomcat. You should leave this at it's default value, +unless you have a very good reason to change it. +</p> +<p> +If the value is "parsed", the forwarded URI +will be decoded and explicit path components like ".." will already +be resolved. This is less spec compliant and is <b>not safe</b> +if you are using prefix forwarding rules. +</p> +<p> +If the value is "unparsed", the forwarded URI +will be the original request URI. It's spec compliant and also +the safest option. Rewriting the URI and then forwarding the rewritten +URI will not work. +</p> +<p> +If the value is "escaped", the forwarded URI +will be the re-encoded form of the URI used by "parsed". +Explicit path components like ".." will already be resolved. +This will not work in combination with URL encoded session IDs. +</p> +<p> +If the value is "proxy", the forwarded URI +will be a partially re-encoded form of the URI used by "parsed". +Explicit path components like ".." will already be resolved. +and problematic are re-encoded. +</p> +<p>The default value since version 1.2.24 is "proxy". Before it was "parsed".</p> +</attribute> +<attribute name="reject_unsafe" required="false"><p> +A string value representing a boolean. If it is set to true, +URLs containing percent signs '%' or backslashes '\' +after decoding will be rejected. +</p> +<p> +Most web apps do not use such URLs. By enabling "reject_unsafe" you +can block several well known URL encoding attacks. +</p> +<p> +A true value can be represented by the string "1" or any string starting +with the letters "T" or "t". A false value will be assumed for "0" +or any string starting with "F" or "f". The default value is false. +</p> +<p>This directive has been added in version 1.2.24</p> +</attribute> +<attribute name="watchdog_interval" required="false"><p> +A DWORD value representing the watchdog thread interval in seconds. +The workers are maintained periodically by a background thread +running periodically every watchdog_interval seconds. Worker maintenance +checks for idle connections, corrects load status and is able +to detect backend health status. +</p> +<p> +The maintenance only happens, if since the last maintenance at +least <a href="workers.html"><code>worker.maintain</code></a> +seconds have passed. So setting the watchdog_interval +much smaller than <code>worker.maintain</code> is not useful. +</p> +<p> +The default value is 0 seconds, meaning the watchdog thread +will not be created, and the maintenance is done in combination +with normal requests instead. +</p> +<p>This directive has been added in version 1.2.27</p> +</attribute> +<attribute name="error_page" required="false"><p> +A string value representing the error page url redirection when +backend returns non-200 response. This directive can be used +to customise the error messages returned from backend server. +</p> +<p>The url must point to a valid server url and can contain +format string number <code>(%d)</code> that can be used to +separate the pages by error number. The redirect url in that +case is formatted by replacing <code>%d</code> from +<code>error_page</code> to returned error number. +</p> +<p>This directive has been added in version 1.2.27</p> +</attribute> +<attribute name="enable_chunked_encoding" required="false"><p> +A string value representing a boolean. If it is set to true, +chunked encoding is supported by the server. +</p> +<p> +A true value can be represented by the string "1" or any string starting +with the letters "T" or "t". A false value will be assumed for "0" +or any string starting with "F" or "f". The default value is false. +</p> +<warn>This option is considered experimental and its support +must be compile time enabled. Use <code>isapi_redirect.dll</code> +with chunked support enabled. +</warn> +<p>This directive has been added in version 1.2.27</p> +</attribute> +</attributes> +</section> +<section name="Using a properties file for configuration"> +<p> +The ISAPI redirector can read it's configuration from a properties file instead of the registry. +This has the advantage that you can use multiple ISAPI redirectors with independent configurations on the same server. +The redirector will check for the properties file during initialisation, and use it in preference to the registry if present. +</p> +<p> +Create a properties file in the same directory as the ISAPI redirector called <b>isapi_redirect.properties</b> i.e. with the same name as the ISAPI redirector DLL but with a <em>.properties</em> extension. A sample isapi_redirect.properties can be found under the conf directory. +</p> +<p> +The property names and values in the properties file are the same as for the registry settings described above. For example: +</p> +<p> +<source> +# Configuration file for the Jakarta ISAPI Redirector + +# The path to the ISAPI Redirector Extension, relative to the website +# This must be in a virtual directory with execute privileges +extension_uri=/jakarta/isapi_redirect.dll + +# Full path to the log file for the ISAPI Redirector +log_file=c:\tomcat\logs\isapi_redirect.log + +# Log level (debug, info, warn, error or trace) +log_level=info + +# Full path to the workers.properties file +worker_file=c:\tomcat\conf\workers.properties + +# Full path to the uriworkermap.properties file +worker_mount_file=c:\tomcat\conf\uriworkermap.properties +</source> +</p> +<p> + Notes: + <ul> + <li> + Back-slashes - '\' - are not escape characters. + </li> + <li> + Comment lines begin with '#'. + </li> + </ul> +</p> +<p>Starting with version 1.2.27 two environment variables are +dynamically added to the environment that can be used inside +<code>.properties</code> files. + <ul> + <li>JKISAPI_PATH - Full path to the ISAPI Redirector. + </li> + <li>JKISAPI_NAME - Name of the ISAPI Redirector dll without extension + </li> + </ul> +</p> +<p><source> +# Use the logs in the installation path of ISAPI Redirector +log_file=$(ISAPI_PATH)\$(ISAPI_NAME).log +</source></p> +</section> + +<section name="Log file rotation"> +<p> +The ISAPI redirector with version 1.2.31 can perform log rotation, with configuration and behaviour similar to the +<a href="http://httpd.apache.org/docs/2.0/programs/rotatelogs.html">rotatelogs</a> program provided with Apache HTTP Server. +</p> +<p> +To configure log rotation, configure a <b>log_file</b>, and one of the <b>log_rotationtime</b> or <b>log_filesize</b> options. +If both are specified, the <b>log_rotationtime</b> will take precedence, and <b>log_filesize</b> will be ignored. +<br/>For example, to configure daily rotation of the log file: +</p> +<source> +# Configuration file for the Jakarta ISAPI Redirector +... + +# Full path to the log file for the ISAPI Redirector +log_file=c:\tomcat\logs\isapi_redirect.%Y-%m-%d.log + +# Log level (debug, info, warn, error or trace) +log_level=info + +# Rotate the log file every day +log_rotationtime=86400 + +... +</source> +<p> +Or to configure rotation of the log file when it reaches 5MB in size: +</p> +<source> +# Configuration file for the Jakarta ISAPI Redirector +... + +# Full path to the log file for the ISAPI Redirector +log_file=c:\tomcat\logs\isapi_redirect.%Y-%m-%d-%H.log + +# Log level (debug, info, warn, error or trace) +log_level=info + +# Rotate the log file at 5 MB +log_filesize=5M + +... +</source> +<p> +The log will be rotated whenever the configured limit is reached, but only if the log file name would change. If you configure + a log file name with <code>strftime(3)</code> format codes in it, then ensure it specifies the same granularity + as the rotation time configured, e.g. <b>%Y-%m-%d</b> if rotating daily (<b>log_rotationtime=86400</b>). +<br/>See the <a href="http://httpd.apache.org/docs/2.0/programs/rotatelogs.html">rotatelogs</a> documentation for more examples. +</p> + +</section> + +<section name="Using a simple rewrite rules"> +<p> +The ISAPI redirector with version 1.2.16 can do a simple URL rewriting. Although not +as powerful as Apache Httpd's mod_rewrite, it allows a simple exchange of request URIs +</p> +<p> +The rule is in the form original-url-prefix=forward-url-prefix. For example: +</p> +<source> +# Simple rewrite rules, making /jsp-examples +# and /servlets-examples available under shorter URLs +/jsp/=/jsp-examples/ +/servlets/=/servlets-examples/ +</source> +<p> +You can also use regular expressions, if you prefix the rule with a tilde <code>~</code>: +</p> +<source> +# Complex rewrite rule, adding "-examples" +# to the first path component of all requests +~/([^/]*)=/$1-examples +</source> +<p> +Note that uriworkermap.properties must use the URLs before rewriting. +</p> +</section> + +</body> +</document> diff --git a/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/project.xml b/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/project.xml new file mode 100644 index 00000000..f5d56447 --- /dev/null +++ b/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/project.xml @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<project name="Apache Tomcat Connector Documentation - Reference Guide" + href="http://tomcat.apache.org/"> + + <title>The Apache Tomcat Connector - Reference Guide</title> + + <logo href="/images/tomcat.gif"> + The Apache Tomcat Connector - Reference Guide + </logo> +<body> + + <menu name="Links"> + <item name="Docs Home" href="../index.html"/> + </menu> + + <menu name="Reference Guide"> + <item name="workers.properties" href="../reference/workers.html"/> + <item name="uriworkermap.properties" href="../reference/uriworkermap.html"/> + <item name="Status Worker" href="../reference/status.html"/> + <item name="Apache HTTP Server" href="../reference/apache.html"/> + <item name="IIS" href="../reference/iis.html"/> + </menu> + + <menu name="Generic HowTo"> + <item name="For the impatient" href="../generic_howto/quick.html"/> + <item name="All about workers" href="../generic_howto/workers.html"/> + <item name="Timeouts" href="../generic_howto/timeouts.html"/> + <item name="Load Balancing" href="../generic_howto/loadbalancers.html"/> + <item name="Reverse Proxy" href="../generic_howto/proxy.html"/> + </menu> + + <menu name="Webserver HowTo"> + <item name="Apache HTTP Server" href="../webserver_howto/apache.html"/> + <item name="IIS" href="../webserver_howto/iis.html"/> + <item name="Netscape/SunOne/Sun" href="../webserver_howto/nes.html"/> + </menu> + + <menu name="AJP Protocol Reference"> + <item name="AJPv13" href="../ajp/ajpv13a.html"/> + <item name="AJPv13 Extension Proposal" href="../ajp/ajpv13ext.html"/> + </menu> + + <menu name="Miscellaneous Documentation"> + <item name="Frequently asked questions" href="../miscellaneous/faq.html"/> + <item name="Changelog" href="../miscellaneous/changelog.html"/> + <item name="Current Tomcat Connectors bugs" href="http://issues.apache.org/bugzilla/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&product=Tomcat+Connectors&long_desc_type=substring&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&keywords_type=allwords&keywords=&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&emailassigned_to1=1&emailtype1=substring&email1=&emailassigned_to2=1&emailreporter2=1&emailcc2=1&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&field0-0-0=noop&type0-0-0=noop&value0-0-0="/> + <item name="Contribute documentation" href="../miscellaneous/doccontrib.html"/> + <item name="JK Status Ant Tasks" href="../miscellaneous/jkstatustasks.html"/> + <item name="Reporting Tools" href="../miscellaneous/reporttools.html"/> + <item name="Old JK/JK2 documentation" href="http://tomcat.apache.org/connectors-doc-archive/jk2/index.html"/> + </menu> + + <menu name="News"> + <item name="2011" href="../news/20110701.html"/> + <item name="2010" href="../news/20100101.html"/> + <item name="2009" href="../news/20090301.html"/> + <item name="2008" href="../news/20081001.html"/> + <item name="2007" href="../news/20070301.html"/> + <item name="2006" href="../news/20060101.html"/> + <item name="2005" href="../news/20050101.html"/> + <item name="2004" href="../news/20041100.html"/> + </menu> + +</body> +</project> diff --git a/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/status.xml b/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/status.xml new file mode 100644 index 00000000..5c2a1f23 --- /dev/null +++ b/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/status.xml @@ -0,0 +1,584 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!DOCTYPE document [ + <!ENTITY project SYSTEM "project.xml"> +]> +<document url="status.html"> + + &project; + + <properties> + <author email="rjung@apache.org">Rainer Jung</author> + <title>Status Worker Reference</title> + </properties> + +<body> + +<section name="Introduction"> +<br/> +<p> +Tomcat Connectors has a special type of worker, the so-called status worker. +The status worker does not forward requests to Tomcat instances. Instead it allows +to retrieve status and configuration information at runtime, +and furthermore to change many configuration items dynamically. This can be done +via a simple embedded web interface. +</p> +<p> +The status worker is especially powerful, when used together with load balancing workers. +</p> +<p> +This document does not explain the HTML user interface of the status worker. +Until now it is very simple, so just go ahead and use it. This doc instead +tries to explain the less obvious features of the status worker. We also will give a +complete coverage of the various request parameters and their meaning, so that you can +include the status worker in your automation scripts. +</p> +<p> +The documentation of the status worker starts with <b>jk 1.2.20</b> +</p> +</section> + +<section name="Usage Patterns"> +<br/> +<subsection name="Actions"> +<br/> +<p> +The status worker knows about six actions. +<ul> +<li> +<b>list</b>: lists the configurations and runtime information of all configured workers. +The output will be grouped by global information first (version data), then load balancer +information, after that AJP worker information and finally the legend. For load balancers, +there will be a summary part, and after that details for each member worker. For all workers, +we also include the URL mappings (forward definitions). +</li> +<li> +<b>show</b>: the same as list, but only shows data for one chosen worker +</li> +<li> +<b>edit</b>: produces a form to edit configuration data for a chosen worker. There is a +special subtype of "edit", that makes it easy to change one attribute for all members of +a load balancer, e.g. their activation state. +</li> +<li> +<b>update</b>: commit changes made in an edit form. <b>Caution</b>: the changes will not be +persisted to the configuration files. As soon as your restart your web server, all changes +made through the status worker will be lost! On the other hand, the changes done by the status +worker will be applied during runtime without a restart of the web server. +</li> +<li> +<b>reset</b>: reset all runtime statistics for a worker. +</li> +<li> +<b>recover</b>: Mark a member of a load balancer, that is in error state, for immediate recovery. +</li> +<li> +<b>version</b>: only show version information of the web server and the JK software +</li> +<li> +<b>dump</b>: list the original workers configuration. <b>Caution</b>: the dump will only contain +the configuration that was used during startup. Any changes applied later by the dynamic management +interface of the status worker itself will not be contained in this dump. +The dump action has been added in version 1.2.27. +</li> +</ul> +</p> +</subsection> + +<subsection name="Output Format"> +<br/> +<p> +For most actions you can choose between 4 output formats. +<ul> +<li> +<b>HTML</b>: Used interactively with a browser +</li> +<li> +<b>XML</b>: Mostly useful for automation, when your scripting environment is XML friendly. +This format has rich structure information, but does not work line based, so you would really +like to use it together with XML tools. +</li> +<li> +<b>Properties</b>: This format is a line based format, that conforms to the rules of Java +property files. Most structure information is contained in the hierarchical key. For information, +that is of configuration nature, the format should produce lines very similar to the ones you can +use in workers.properties. It will not produce a complete configuration file! +</li> +<li> +<b>Text</b>: A simple textual output format. +</li> +</ul> +The "edit" action does only make sense for the HTML output type. +</p> +</subsection> + +<subsection name="User Interface Features"> +<br/> +<p> +In the HTML view, there is an <b>automatic refresh</b> feature, implemented via the meta refresh +option of HTML. Once you start the automatic refresh, the UI will will respect it for all actions +except edit, update and maintain. Even if you navigate through one of those, the automatic refresh +will start again as soon as you come back to one of the other actions. +</p> +<p> +Many parts of the HTML page can be minimised, if they are not interesting for you. There are a couple +of "Hide" links, which will collapse parts of the information. The feature exists for the following +blocks of information: +<ul> +<li> +<b>Legend</b>: Do not show the legend for the information presented in "list" and "show" actions +</li> +<li> +<b>URI mappings</b>: Do not show the URI mapping for the workers +</li> +<li> +<b>Load Balancing Workers</b>: Do not show workers of type "lb" +</li> +<li> +<b>AJP Workers</b>: Do not show workers of type ajp +</li> +<li> +<b>Balancer Members</b>: Do not show detailed information concerning each member of load balancers +</li> +<li> +<b>Load Balancer Configuration</b>: Do not show configuration data for load balancers +</li> +<li> +<b>Load Balancer Summary</b>: Do not show status summary for load balancers +</li> +<li> +<b>AJP Configuration</b>: Do not show configuration data for ajp workers load balancer members +</li> +</ul> +The last three minimisation features have been added in version 1.2.27. +</p> +</subsection> + +<subsection name="Special Considerations concerning URL Maps and Virtual Hosts"> +<br/> +<p> +<b>Note: </b>The following restriction has been removed starting with version 1.2.26. +</p> +<p> +The Apache module mod_jk makes use of the internal Apache httpd infrastructure concerning +virtual hosts. The downside of this is, that the status worker can only show URL maps, for +the virtual host it is defined in. It is not able to reach the configuration objects +for other virtual hosts. Of course you can define a status worker in any virtual host you +are using. All information presented apart from the URL maps will be the same, independent +of the virtual host the status worker has been called in. +</p> +</subsection> + +<subsection name="Logging"> +<br/> +<p> +The status worker will log changes made to the configuration with log level "info" to the usual +JK log file. Invalid requests will be logged with log level "warn". If you want to report some +broken behaviour, log file content of level "debug" or even "trace" will be useful. +</p> +</subsection> + +</section> + +<section name="Configuration"> +<br/> +<subsection name="Basic Configuration"> +<br/> +<p> +The basic configuration of a status worker is very similar to that of a usual ajp worker. +You need to specify a name for the worker, and the URLs you want to map to it. The first +part of the configuration happens in the workers.properties file. We define a worker named +mystatus of type status: +<source> +worker.list=mystatus +worker.mystatus.type=status +</source> +Then we define a URL, which should be mapped to this worker, i.e. the URL we use +to reach the functionality of the status worker. You can use any method mod_jk supports +for the web server of your choice. Possibilities are maps inside uriworkermap.properties, +an additional mount attribute in workers.properties, or in Apache JkMount. Here's an +example for a uriworkermap.properties line: +<source> +/private/admin/mystatus=mystatus +</source> +The URI pattern is case sensitive. +</p> +<p> +As you will learn in the following sections, the status worker is very powerful. You should +use the usual authentication and authorisation methods of your web server to secure this URL. +</p> +<p> +You can also define multiple instances of the status worker, by using different names and URL mappings. +For instance you might want to configure them individually +and then allow special groups of people to use them +</p> +</subsection> + +<subsection name="Output Customisation"> +<br/> +<p> +There are a couple of attributes for the workers.properties entries, which allow to customise +various aspects of the output of the status worker. +</p> +<p> +The attribute <b>css</b> can be set to the URL of a stylesheet: +<source> +worker.mystatus.css=/private/admin/static/mystatus.css +</source> +When writing HTML output, the status worker then includes the line +<source> +<link rel="stylesheet" type="text/css" href="/private/admin/static/mystatus.css" /> +</source> +There is no sample stylesheet included with the mod_jk release, and by default the attribute css +is empty, so no stylesheet reference will be included in the pages. The HTML code +of the status worker output pages does not include any class attributes. If you like to contribute a +stylesheet or improvements to the HTML layout, please contact us on the tomcat developers list. +</p> +<p> +The properties output format can be customised via the attribute <b>prefix</b>. The names of all +properties the status worker does output, will begin with this prefix. The default is "worker". +</p> +<p> +Several attributes influence the format when writing XML output. +The attribute <b>ns</b> allows to set a namespace prefix, that will be used for every status worker+element. +The default is "jk:". Setting it to "-" disables the namespace prefix. +</p> +<p> +With the attribute xmlns you can map the prefix to a namespace URL. The default value +is xmlns:jk="http://tomcat.apache.org". Setting it to "-" disables the output of the URL. +</p> +<p> +Finally you can specify an XML document type via the attribute doctype. The specified string will +be inserted at the beginning of the document, directly after the xml header. The default is empty. +</p> +</subsection> + +<subsection name="Securing Access"> +<br/> +<p> +We urge you to use the builtin access control features of your web server to control +access to the status worker URLs you have chosen. Nevertheless two configuration +attributes of status workers are helpful. The attribute "read_only" disables all features of +the status worker, that can be used to change configurations or runtime status of the other workers. +A read_only status worker will not allow access to the edit, update, reset or recover actions. +The default value is "False", ie. read/write. To enable read_only you need to set it to "True". +</p> +<p> +You could configure two status workers, one has read_only and will be made available to a larger +admin group, the other one will be used fully featured, but only by fewer people: +<source> +worker.list=jk-watch +worker.jk-watch.type=status +worker.jk-watch.read_only=True +worker.jk-watch.mount=/user/status/jk +worker.list=jk-manage +worker.jk-manage.type=status +worker.jk-manage.mount=/admin/status/jk +</source> +Starting with version 1.2.21, a read/write status worker can also be switched temporarily +into read-only mode by the user via a link in the HTML GUI. The user can always switch it +back to read/write. Only a status worker configured as read-only via the "read_only" attribute +is completely safe from applying any changes. +</p> +<p> +The other attribute you can use is <b>user</b>. By default this list is empty, which means +no limit on the users. You can set "user" to a comma separated list of user names. If your +web server is configured such that it sends the user names with the request, the status worker +will check, if the name attached with the request is contained in it's "user" list. +</p> +<p> +The user list can be split over multiple occurrences of the "user" attribute. +</p> +<p> +By default, the user names are matched case sensitively. Starting with version 1.2.21 you can set +the attribute <b>user_case_insensitive</b> to "True". Then the comparison will be made case insensitive. +</p> +</subsection> + +<subsection name="Service Availability Rating"> +<br/> +<p> +For load balancing workers the status worker shows some interesting overview information. +It categorises the members of the load balancer into the classes "good", "bad" and degraded". +This feature can be combined with external escalation procedures. Depending on your global +system design and your operating practises your preferred categorisation might vary. +</p> +<p> +The categorisation is based on the activation state of the workers (active, disabled or stopped), +which is a pure configuration state, and the runtime state +(OK or ERR with possible substates idle, busy, recovering, probing, and forced recovery) +which only depends on the runtime situation. +</p> +<p> +The runtime substates have the following meaning: +<ul> +<li> +<b>OK (idle)</b>: This worker didn't receive any request since the last balancer +maintenance. By default balancer maintenance runs every 60 seconds. The +worker should be OK, but since we didn't have to use it for some time, we +can't be sure. This state has been called N/A before version 1.2.24. +</li> +<li> +<b>OK (busy)</b>: All connections for this worker are in use for requests. +</li> +<li> +<b>ERROR (recovering)</b>: The worker was in error state for some time and is now +marked for recovery. The next request suitable for this worker will use it. +</li> +<li> +<b>ERROR (probing)</b>: After setting the worker to recovering, we received a request +suitable for this worker. This request is now using the worker. +</li> +<li> +<b>ERROR (forced recovery)</b>: The worker is in error, but we don't have an alternative +worker, so we keep using it. +</li> +</ul> +</p> +<p> +By default the status worker groups into "good" all members, that have activation "active" and +runtime state not equal to "error" with empty substate. +The "bad" group consists of the members, that have either activation +"stopped", or are in runtime state "error" with empty substate. +</p> +<p> +Workers that fit neither of the two groups, are considered to be "degraded". +</p> +<p> +You can define other rules for the grouping into good, bad and degraded. +The two attributes "good" and "bad" can be populated by a comma-separated list ob single characters or +dot-separated pairs. Each character stands for the first character of one of the possible states "active", +"disabled", "stopped", "ok", "idle", "busy", "recovering" and "error". The additional states "probing" +and "forced recovery" are always rated equivalent to "recovering". +Comma-separated entries will be combined +with logical "or", if you combine a configuration and a runtime state with a dot. the are combined with logical +"and". So the default value for "good" is "a.o,a.i,a.b,a.r", for "bad" it is "e,s". +</p> +<p> +The status worker first tries to match against the "bad" definitions, if this doesn't succeed +it tries to match against "good", and finally it chooses "degraded", if no "bad" or "good" match +can be found. +</p> +</subsection> +</section> + +<section name="Request Parameters"> +<br/> +<p> +This section should help you building automation scripts based on the jk status +management interface. This interface is stable in the sense, that we only expect +to add further parameters in the future. Existing parameters from previous versions +will keep their original semantics. We also expect the output formats XML, Properties +and Text to be kept stable. So please use those, if you want to parse status worker +output in your automation scripts. +</p> +<subsection name="Actions"> +<br/> +<p> +The action is determined by the parameter <b>cmd</b>. It can have the values "list", "show", +"edit", "update", "reset", "recover", "version" and "dump". If you omit the <b>cmd</b> parameter, +the default "list" will be used. +All actions except for "list", "refresh", "version" and "dump" need additional parameters. +</p> +<p> +The action "dump" has been added in version 1.2.27. +</p> +</subsection> +<subsection name="Output Format"> +<br/> +<p> +The format is determined by the parameter <b>mime</b>. It can have the values "html", "xml", +"txt" and "prop". If you omit the <b>mime</b> parameter, the default "html" +will be used. The action "edit" (the edit form) does only make sense for "mime=html". +</p> +</subsection> +<subsection name="Worker Selection"> +<br/> +<p> +Actions that operate on a single worker need one or two additional parameters to select +this worker. The parameter <b>w</b> contains the name of the worker from the worker list. +If an action operates on a member (sub worker) of a load balancer, the parameter <b>w</b> +contains the name of the load balancer worker, and the additional parameter <b>sw</b> contains the +name of the sub worker. +</p> +</subsection> +<subsection name="Automatic Refresh"> +<br/> +<p> +During automatic refresh, the parameter <b>re</b> contain the refresh interval in seconds. +If you omit this parameter, automatic refresh will be off. +</p> +</subsection> +<subsection name="Hide Options"> +<br/> +<p> +The parameter <b>opt</b> contains a bit mask of activated options. The default is 0, so +by default no options are activated. The following options exist: +<ul> +<li> +<b>0x0001</b>: hide members of lb workers +</li> +<li> +<b>0x0002</b>: hide URL maps +</li> +<li> +<b>0x0004</b>: hide the legend +</li> +<li> +<b>0x0008</b>: hide load balancer workers +</li> +<li> +<b>0x0010</b>: hide ajp workers +</li> +<li> +<b>0x0020</b>: only allow read_only actions for a read/write status worker. +</li> +<li> +<b>0x0040</b>: hide load balancer configuration +</li> +<li> +<b>0x0080</b>: hide load balancer status summary +</li> +<li> +<b>0x0100</b>: hide configuration for ajp and load balancer member workers +</li> +</ul> +Values 0x0040-0x0100 have been added in version 1.2.27. +</p> +</subsection> +<subsection name="Data Parameters for the standard Update Action"> +<br/> +<p> +You can use the edit action with a final click to the update button, to change settings of workers. +But you can also make direct calls to the update action. The following request parameters +contain the configuration information, you want to change. First the list for load balancer workers: +<ul> +<li> +<b>vlr</b>: retries (number) +</li> +<li> +<b>vlt</b>: recover_time (seconds) +</li> +<li> +<b>vlee</b>: error_escalation_time (seconds) +</li> +<li> +<b>vlx</b>: max_reply_timeouts (number) +</li> +<li> +<b>vls</b>: sticky_session (0/f/n/off=off, 1/t/y/on=on; case insensitive) +</li> +<li> +<b>vlf</b>: sticky_session_force (0/f/n/off=off, 1/t/y/on=on; case insensitive) +</li> +<li> +<b>vlm</b>: method (0/r="Requests", 1/t="Traffic", 2/b="Busyness", 3/s="Sessions"; case insensitive, only first character is used) +</li> +<li> +<b>vll</b>: lock (0/o="Optimistic", 1/p="Pessimistic"; case insensitive, only first character is used) +</li> +</ul> +And now the list of parameters you can use to change settings for load balancer members: +<ul> +<li> +<b>vwa</b>: activation flag (0/a="active", 1/d="disabled", 2/s="stopped"; case insensitive, only first character is used) +</li> +<li> +<b>vwf</b>: load balancing factor (integer weight) +</li> +<li> +<b>vwn</b>: route for use with sticky sessions (string) +</li> +<li> +<b>vwr</b>: redirect to define simple failover rules (string) +</li> +<li> +<b>vwc</b>: domain to tell JK about your replication design (string) +</li> +<li> +<b>vwd</b>: distance to express preferences (integer) +</li> +</ul> +Finally the list of parameters you can use to change settings for ajp workers and ajp load balancer members: +<ul> +<li> +<b>vahst</b>: host (string) +</li> +<li> +<b>vaprt</b>: port (number) +</li> +<li> +<b>vacpt</b>: connection_pool_timeout (number) +</li> +<li> +<b>vact</b>: connect_timeout (number) +</li> +<li> +<b>vapt</b>: prepost_timeout (number) +</li> +<li> +<b>vart</b>: reply_timeout (number) +</li> +<li> +<b>var</b>: retries (number) +</li> +<li> +<b>varo</b>: recovery_options (number) +</li> +<li> +<b>vamps</b>: max_packet_size (number) +</li> +</ul> +Note that changing the host name or port will only take effect for new connections. +Already established connections to the old address will still be used. +Nevertheless this feature is interesting, because you can provision load balancer +members with port "0", which will automatically be stopped during startup. Later +when you know the final names and ports, you can set them and they will be +automatically activated. +</p> +<p> +The leading character "v" has been added to the parameters in version 1.2.27. +Changing settings for ajp workers has also been introduced in version 1.2.27. +</p> +<p> +For the details of all parameters, we refer to the <a href="workers.html">workers.properties Reference</a>. +</p> +</subsection> +<subsection name="Aspect Editing for Load Balancer Members"> +<br/> +<p> +You can use the edit action to edit all settings for a load balancer or for a +member of a load balancer respectively on one page. If you want to edit one +configuration aspect for all members of a load balancer simultaneously, this +will be triggered by the parameter <b>att</b>. The value of the parameter indicates, +which aspect you want to edit. The list is the same as in the previous section, +except for "vahst" and "vaprt": +"vwa", "vwf", "vwn", "vwr", "vwc", "vwd", "vacpt", "vact", "vapt", "vart", "var", +"varo" and "vamps". But here you +need to put the name into the parameter <b>att</b>, instead of using it as a request +parameter name. +</p> +<p> +The values of the common aspect for all the load balancer members will be given +in parameters named "val0", "val1", .... +</p> +</subsection> +</section> + +</body> +</document> diff --git a/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/uriworkermap.xml b/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/uriworkermap.xml new file mode 100644 index 00000000..f9a83dea --- /dev/null +++ b/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/uriworkermap.xml @@ -0,0 +1,422 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!DOCTYPE document [ + <!ENTITY project SYSTEM "project.xml"> +]> +<document url="uriworkermap.html"> + + &project; + + <properties> + <author email="rjung@apache.org">Rainer Jung</author> + <author email="mturk@apache.org">Mladen Turk</author> + <title>uriworkermap.properties configuration</title> + </properties> + +<body> + +<section name="Introduction"> +<br/> +<p> +The forwarding of requests from the web server to tomcat gets configured by defining mapping rules. +Such a rule maps requests to workers. The request part of the map is described by a URI pattern, +the worker by it's worker name. +</p> +<p> +The so-called <b>uriworkermap</b> file is a mechanism of defining rules, +which works for all web servers. There exist also other web server specific configuration +options for defining rules, which will be mostly discussed on the reference pages for +configuring tomcat connectors for the individual web servers. +</p> +<p> +The name of the file is usually uriworkermap.properties, +although this is configurable in the web server. +Please consult the web server specific documentation pages on +how to enable the uriworkermap file. +</p> +<p> +The main features supported by the uriworkermap file are +<ul> +<li> +Support for comments in the rule file. +</li> +<li> +Exact and wildchar matches, shortcuts to map a directory and all including content. +</li> +<li> +Exclusion rules, disabling of rules and rule priorities. +</li> +<li> +Rule extensions, modifying worker behaviour per rule. +</li> +<li> +Virtual host integration: uri mapping rules can be expressed per virtual host. +The details are web server specific though. +</li> +<li> +Dynamic reloading: The file gets checked periodically for changes. +New versions are automatically reloaded without web server restarts. +</li> +<li> +Integration with the status worker. +</li> +</ul> +The following sections describe these aspects in more detail. +</p> +</section> + +<section name="Syntax"> +<br/> +<subsection name="Line format"> +<br/> +<p> +The file has a line based format. There are no continuation characters, +so each rule needs to be defined on a single line. Each rule is a pair consisting +of a URI pattern and a worker name, combined by an equals sign '=': +<source> + /myapp=myworker +</source> +The URI pattern is case sensitive. +</p> +</subsection> +<subsection name="Comments, white space"> +<br/> +<p> +All text after and including the character '#' gets ignored and can be used for comments. +Leading and trailing white space gets trimmed around the URI pattern and also around the worker name. +The following definitions are all equivalent: +<source> + # This is a white space example + /myapp=myworker + /myapp=myworker + /myapp = myworker +</source> +</p> +</subsection> + +<subsection name="URI patterns"> +<br/> +<p> +Inside the URI pattern three special characters can be used, '*', '?' and '|'. +The character '*' is a wildchar that matches any number of arbitrary characters +in the URI, '?' matches exactly one character. +Each URI pattern has to start with the character '/', or with '*' or with '?', +optionally prefixed by any combination of the modifiers '!' and '-' (see next section). +<source> + # Mapping the URI /myapp1 and everything under /myapp1/: + /myapp1=myworker-a + /myapp1/*=myworker-a + # Mapping all URI which end with a common suffix: + *.jsp=myworker + *.do=myworker +</source> +Since the first case of mapping a certain location and everything inside +it is very common, the character '|' gives a handy shortcut: +<source> + # Mapping the URI /myapp1 and everything under /myapp1/: + /myapp1|/*=myworker-a +</source> +The pattern 'X|Y' is exactly equivalent to the two maps 'X' and 'XY'. +</p> +</subsection> +</section> + +<section name="Exclusion, Disabling and Priorities"> +<br/> + +<subsection name="Exclusions and rule disabling"> +<br/> +<p> +Exclusion rules allows to define exclusions from URI rules, which would forward +requests to tomcat. If the exclusion rule matches, the request will not be forwarded. +This is usually used to serve static content by the web server. +A rule is an exclusion rule, if it is suffixed with '!': +<source> + # Mapping the URI /myapp and everything under /myapp/: + /myapp|/*=myworker + # Exclude the subdirectory static: + !/myapp/static|/*=myworker + # Exclude some suffixes: + !*.html=myworker +</source> +An exclusion rule overrides a normal mapping rule only, if the worker names in the +normal rule and in the exclusion rule are the same. Starting with version 1.2.26 of JK +you can apply an exclusion rule to any worker, by using the star character '*' as +the worker name in the exclusion rule. +More complex patterns in exclusion worker names are not allowed. +<source> + # Mapping the webapps /myapp1 and /myapp2: + /myapp1|/*=myworker1 + /myapp2|/*=myworker2 + # Exclude the all subdirectories static for all workers: + !/*/static|/*=* + # Exclude some suffixes for all workers: + !*.html=* +</source> +</p> +<p> +Rule disabling comes into play, if your web server merges rules from various sources, +and you want to disable any rule defined previously. Since the uriworkermap file gets +reloaded dynamically, you can use this to temporarily disable request forwarding: +A rule gets disabled, if it is suffixed with '-': +<source> + # We are not in maintenance. + # The maintenance rule got defined somewhere else. + -/*=maintenance +</source> +Exclusion rules can get disabled as well, then the rule starts with '-!'. +</p> +</subsection> + +<subsection name="Mapping priorities"> +<br/> +<p> +The most restrictive URI pattern is applied first. More precisely the URI patterns are +sorted by the number of '/' characters in the pattern (highest number first), and +rules with equal numbers are sorted by their string length (longest first). +</p> +<p> +If both distinctions still do not suffice, then the defining source of the rule is considered. +Rules defined in uriworkermap.properties come first, before rules defined by JkMount (Apache) +and inside workers.properties using the mount attribute. +</p> +<p> +All disabled rules are ignored. Exclusion rules are applied after all normal rules +have been applied. +</p> +<p> +There is no defined behaviour, for the following configuration conflict: +using literally the same URI pattern in the same defining source but with +different worker targets. +</p> +</subsection> +</section> + +<section name="Rule extensions"> +<br/> +<p> +Rule extensions were added in version 1.2.27 and are not available in earlier versions. +</p> +<subsection name="Syntax"> +<br/> +<p> +Rule extensions are additional attributes, that can be attached to any rule. +They are added at the end of the rule, each extension separated by a semicolon: +<source> + # This is an extension example, + # setting a reply_timeout of 1 minute + # only for this mapping. + /myapp=myworker;reply_timeout=60000 + # + # This is an example using multiple extensions + /myapp=myloadbalancer;reply_timeout=60000;stopped=member1 +</source> +Attributes set via rule extensions always overwrite conflicting +configurations in the worker definition file. +</p> +</subsection> +<subsection name="Extension reply_timeout"> +<br/> +<p> +The extension <code>reply_timeout</code> sets a reply timeout for a single mapping rule. +<source> + # Setting a reply_timeout of 1 minute + # only for this mapping. + /myapp=myworker;reply_timeout=60000 +</source> +It overrides any <code>reply_timeout</code> defined for the worker. The extension allows +to set a reasonable default reply timeout to the worker, and a more relaxed +reply timeout to URLs, which are known to start time intensive tasks. +For a general description of reply timeouts see the +<a href="../generic_howto/timeouts.html#Reply Timeout">timeouts</a> documentation. +</p> +</subsection> +<subsection name="Extensions active/disabled/stopped"> +<br/> +<p> +The extensions <code>active</code>, <code>disabled</code>, and <code>stopped</code> +can be used in a load balancer mapping rule to set selected members +of the load balancer into a special activation state. +<source> + # Stop forwarding only for member1 of loadbalancer + /myapp=myloadbalancer;stopped=member1 +</source> +Multiple members must be separated by commas or white space: +<source> + # Stop forwarding for member01 and member02 of loadbalancer + # Disable forwarding for member21 and member22 of loadbalancer + /myapp=myloadbalancer;stopped=member01,member02;disabled=member21,member22 +</source> +For the precise meaning of the activation states see the description of +<a href="../reference/workers.html#Advanced Worker Directives">activation</a>. +</p> +</subsection> +<subsection name="Extension fail_on_status"> +<br/> +<p> +The extension <code>fail_on_status</code> can be used in any rule: +<source> + # Send 503 instead of 404 and 500, + # and if we get a 503 also set the worker to error + /myapp=myworker;fail_on_status=-404,-500,503 +</source> +Multiple status codes must be separated by commas. +For the precise meaning of the attribute see the description of +<a href="../reference/workers.html#Advanced Worker Directives">fail_on_status</a>. +</p> +</subsection> +<subsection name="Extension use_server_errors"> +<br/> +<p> +The extension <code>use_server_errors</code> allows to let the web server +send an error page, instead of the backend (e.g. Tomcat) error page. +This is useful, if one wants to send customized error pages, but those are +not part of all web applications. They can then be put onto the web server. +</p> +<p> +The value of <code>use_server_errors</code> is a positive number. +Any request send to the backend, that returns with an http status +code bigger or equal to <code>use_server_errors</code>, will +be answered to the client with the error page of the web server +for this status code. +<source> + # Use web server error page for all errors + /myapp=myworker;use_server_errors=400 + # Use web server error page only for technical errors + /myotherapp=myworker;use_server_errors=500 +</source> +</p> +</subsection> +</section> + +<section name="Virtual host integration"> +<br/> + +<subsection name="IIS"> +<br/> +<p> +When using IIS you can restrict individual rules to special virtual hosts +by prefixing the URI pattern with the virtual host information. +The rules is that the url must be prefixed with the host name. +<source> + # Use www.foo.org as virtual host + /www.foo.org/myapp/*=myworker + # Use www.bar.org as virtual host + /www.bar.org/myapp/*=myworker + # Normal mapping + /mysecondapp/*=myworker +</source> +</p> +<p> +Note that /mysecondapp/* will be mapped to all virtual hosts present. +In case one needs to prevent the mappings to some particular virtual host then +the exclusion rule must be used +<source> + # Make sure the myapp is accessible by all virtual hosts + /myapp/*=myworker + # Disable mapping myapp for www.foo.org virtual host + !/www.foo.org/myapp/*=myworker +</source> +</p> +</subsection> + +<subsection name="Apache httpd"> +<br/> +<p> +For Apache you can define individual uriworkermap files per virtual host. +The directive JkMountFile can be used in the main server and in each virtual host. +If a virtual host does not use JkMountfile, but JkMountCopy is set to 'On', +then it inherits the JkMountFile from the main server. If you want all vhost to inherit +mounts from the main server, you can set JkMountCopy to 'All' in the main server. +</p> +</subsection> +</section> + +<section name="Dynamic reloading"> +<br/> +<p> +When a request is being processed, tomcat connectors check the file modification time +of the uriworkermap file. To keep the performance penalty low, this happens only, +if the last check happened at least n seconds ago. +</p> +<p> +For Apache you can configure the interval "n" using the directive JkMountFileReload, +for IIS you would use the attribute worker_mount_reload. +The default value is 60 seconds. A value of "0" turns off the reloading. +</p> +<p> +If the file changed, it gets reloaded completely. If there exist rules coming +from other sources than the uriworkermap file (e.g. the workers.properties mount +attribute or JkMount with Apache httpd), the new uriworkermap file gets dynamically +merged with these ones exactly like when you do a web server restart. +</p> +<p> +Until version 1.2.19 reloading behaved slightly differently: it continuously added +the full contents of the uriworkermap file to the rule mapping. The merging rules +were, that duplicated got eliminated and old rules could be disabled, by defining the +rule as disabled in the new file. Rules never got deleted. +</p> +</section> + +<section name="Status worker integration"> +<br/> +<p> +The configuration view of the status worker also shows the various mapping rules. +After each worker's configuration, the rules are listed, that forward to this worker. +The list contains four columns: +<ul> +<li> +the name of the virtual server +</li> +<li> +the URI pattern, prefixed with '-' for a disabled pattern and '!' for an exclusion pattern +</li> +<li> +the type of the rule: Exact or Wildchar +</li> +<li> +and the source of the rule definition: 'worker definition' for the workers.properties file (mount attribute), +'JkMount' for Apache httpd JkMount and it's relatives and finally 'uriworkermap' for the uriworkermap file. +</li> +</ul> +</p> +<p> +<b>Note: </b>The following restriction has been removed starting with version 1.2.26. +<br/> +For Apache httpd, there is an important subtlety: the request going to the status worker +gets executed in the context of some server (main or virtual). The status worker will only show the +mapping rules, that are defined for this server (main or virtual). +<br/> +Until version 1.2.25 the list contained three columns: +<ul> +<li> +the type of the rule: Exact or Wildchar, eventually prefixed with Disabled or Unmount (for exclusion rules) +</li> +<li> +the URI pattern +</li> +<li> +and the source of the rule definition: 'worker definition' for the workers.properties file (mount attribute), +'JkMount' for Apache httpd JkMount and it's relatives and finally 'uriworkermap' for the uriworkermap file. +</li> +</ul> +</p> +</section> + +</body> +</document> diff --git a/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/workers.xml b/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/workers.xml new file mode 100644 index 00000000..543112cf --- /dev/null +++ b/rubbos/app/tomcat-connectors-1.2.32-src/xdocs/reference/workers.xml @@ -0,0 +1,1155 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!DOCTYPE document [ + <!ENTITY project SYSTEM "project.xml"> +]> +<document url="workers.html"> + + &project; + + <properties> + <author email="mturk@apache.org">Mladen Turk</author> + <title>workers.properties configuration</title> + </properties> + +<body> + +<section name="Introduction"> +<br/> +<p> +A <b>Tomcat worker</b> is a Tomcat instance that is waiting to execute servlets or any other content +on behalf of some web server. For example, we can have a web server such as +Apache forwarding servlet requests to a Tomcat process (the worker) running behind it. +</p> +<p> +The scenario described above is a very simple one; +in fact one can configure multiple Tomcat workers to serve servlets on +behalf of a certain web server. +The reasons for such configuration can be: +</p> +<ul> +<li> +We want different contexts to be served by different Tomcat workers to provide a +development environment where all the developers share the same web server but +own a Tomcat worker of their own. +</li> +<li> +We want different virtual hosts served by different Tomcat processes to provide a +clear separation between sites belonging to different companies. +</li> +<li> +We want to provide load balancing, meaning run multiple Tomcat workers each on a +machine of its own and distribute the requests between them. +</li> +</ul> + +<p> +There are probably more reasons for having multiple workers but I guess that this list is enough... +</p> +<p> +Tomcat workers are defined in a properties file dubbed <b>workers.properties</b> and this tutorial +explains how to work with it. +</p> +</section> + +<section name="Configuration File Basics"> +<br/> +<p>Defining workers to the Tomcat web server plugin can be done using a properties file +(a sample file named workers.properties is available in the conf/ directory). +</p> + +<subsection name="Format, Comments, Whitespace"> +<br/> +<p> +The lines in the file define properties. The general format is +</p> +<p><strong><name>=<value></strong></p> +<p> +</p> +Dots are used as part of the name to represent a configuration hierarchy. +<p> +Invalid directives will be logged during web server startup and prevent the web server +from working properly. Some directives have been deprecated. Although they will +still work, you should replace them by their +<a href="#Deprecated Worker Directives">successors</a>. +</p> +<p> +Some directives are allowed multiple times. This will be explicitly +noted in the tables below. +</p> +<p> +Whitespace at the beginning and the end of a property name or value gets ignored. +Comments can be placed in any line and start with a hash sign '#'. +Any line contents behind the hash sign get ignored. +</p> +</subsection> + +<subsection name="Global Properties"> +<br/> +<p> +These directives have global scope. +</p> +<directives> +<directive name="worker.list" default="ajp13" required="true"> +A comma separated list of workers names that the JK will use. When starting up, +the web server plugin will instantiate the workers whose name appears in the +worker.list property, these are also the workers to whom you can map requests. +<p> +This directive can be used multiple times. +</p> +</directive> +<directive name="worker.maintain" default="60" required="false"> +Worker connection pool maintain interval in seconds. If set to the positive +value JK will scan all connections for all workers specified in worker.list +directive and check if connections needs to be recycled. +<p> +Furthermore any load balancer does a global maintenance every worker.maintain +seconds. During global maintenance load counters are decayed and workers +in error are checked for recover_time. +</p> +<p> +This feature has been added in <b>jk 1.2.13</b>. +</p> +</directive> +</directives> +</subsection> + +<subsection name="Worker Properties"> +<br/> +<p> +Each worker configuration directive consists of three words separated by a dot: +</p> +<p><strong>worker.<worker name>.<directive>=<value></strong></p> +<p> +The first word is always <b>worker</b>. +The second word is the worker name you can choose. In the case of load-balancing, +the worker name has an additional meaning. Please consult the +<a href="../generic_howto/loadbalancers.html">Load Balancer HowTo</a>. +</p> +<warn> +The name of the worker can contain only the alphanumeric characters +<b>[a-z][A-Z][0-9][_\-]</b> and is case sensitive. +</warn> +</subsection> + +<subsection name="Variables, Environment Variables"> +<br/> +<p> +You can define and use variables in the workers.properties file. +To define a variable you use the syntax: +</p> +<p><strong><variable_name>=<value></strong></p> +<p> +Dots are allowed in the variable name, but you have to be careful +not to use variable names, that clash with standard directives. +Therefore variable names should never start with "worker.". +</p> +<p> +To use a variable, you can insert "$(variable_name)" at any place +on the value side of a property line. If a variable has not been +defined before its use, we will search the process environment for +a variable with the same name and use their value. +</p> +</subsection> + +<subsection name="Property Inheritance"> +<br/> +<p>Often one wants to use the same property values for various workers. +To reduce duplication of configuration lines and to ease the maintenance of +the file, you can inherit properties from one worker to another, or even +from a template to real workers. +</p> +<p> +The directive "reference" allows to copy configurations between workers +in a hierarchical way. If worker castor sets <b>worker.castor.reference=worker.pollux</b> +then it inherits all properties of <b>pollux</b>, except for the ones that +are explicitly set for <b>castor</b>. +</p> +<p> +Please note, that the value of the directive is not only the name of the referred worker, +but the complete prefix including "worker.". +</p> +<p> +To use a template worker simply define it like a real worker, but do not add it +to the "worker.list" or as a member to any load balancer. Such a template worker +does not have to contain mandatory directives. This approach is especially useful, +if one has a lot of balanced workers in a load balancer +and these workers share most of their properties. You can set all of these properties +in a template worker, e.g. using the prefix "worker.template1", and then simply +reference those common properties in all balanced workers. +</p> +<p> +References can be used to inherit properties over multiple hops in a hierarchical way. +</p> +<p> +This feature has been added in <b>jk 1.2.19</b>. +</p> +</subsection> +</section> + +<section name="List of All Worker Directives"> +<br/> +<subsection name="Mandatory Directives"> +<br/> +<p>Mandatory directives are the one that each worker <b>must</b> contain. Without them the worker will +be unavailable or will misbehave. Those directives will be marked with a <strong>strong</strong> font in the following tables. +</p> +<directives> +<directive name="type" default="ajp13" required="true"> +Type of the worker (can be one of ajp13, ajp14, jni, lb or status). The type of the worker +defines the directives that can be applied to the worker. +<p>AJP13 worker is the preferred worker type that JK uses for communication +between web server and Tomcat. This type of worker uses sockets as communication +channel. For detailed description of the AJP13 protocol stack browse to +<a href="../ajp/ajpv13a.html">AJPv13 protocol specification</a> +</p> +<warn>JNI workers have been deprecated. They will likely not work. Do not use them.</warn> +</directive> +</directives> +</subsection> + +<subsection name="Connection Directives"> +<br/> +<p>Connection directives defines the parameters needed to connect and maintain +the connections pool of persistent connections between JK and remote Tomcat. +</p> +<directives> + +<directive name="host" default="localhost" required="false"> +Host name or IP address of the backend Tomcat instance. The remote Tomcat must +support the ajp13 protocol stack. The host name can have a <b>port</b> number +embedded separated by the colon (':') character. +</directive> + +<directive name="port" default="8009" required="false"> +Port number of the remote Tomcat instance listening for defined protocol requests. +The default value depends on the worker type. For AJP13 workers the default port is +<b>8009</b>, while for AJP14 type of worker that value is <b>8011</b>. +</directive> + +<directive name="socket_timeout" default="0" required="false"> +Socket timeout in seconds used for the communication channel between JK and remote host. +If the remote host does not respond inside the timeout specified, JK will generate an error, +and retry again. If set to zero (default) JK will wait for an infinite amount of time +on all socket operations. +</directive> + +<directive name="socket_connect_timeout" default="socket_timeout*1000" required="false"> +Socket connect timeout in milliseconds used for the communication channel between JK and remote host. +If the remote host does not respond inside the timeout specified, JK will generate an error, +and retry again. +<p> +Note that <code>socket_timeout</code> is in seconds, and +<code>socket_connect_timeout</code> in milliseconds, +so in absolute terms the default <code>socket_connect_timeout</code> is +equal to <code>"socket_timeout</code>. +</p> +<p> +This feature has been added in <b>jk 1.2.27</b>. +</p> +</directive> + +<directive name="socket_keepalive" default="False" required="false"> +This directive should be used when you have a firewall between your webserver +and the Tomcat engine, who tend to drop inactive connections. This flag will tell the Operating System +to send <code>KEEP_ALIVE</code> messages on inactive connections (interval depend on global OS settings, +generally 120 minutes), and thus prevent the firewall to cut inactive connections. +To enable keepalive set this property value to <b>True</b>. +<p> +The problem with Firewall cutting inactive connections is that sometimes, neither webserver or Tomcat +have information about the cut and couldn't handle it. +</p> +</directive> + +<directive name="ping_mode" default="" required="false"> +This flag determines, under which conditions established +connections are probed to ensure they are still working. +The probe is done with an empty AJP13 packet (CPing) and +expects to receive an appropriate answer (CPong) within +some timeout. +<p> +The value of the flag can be any combination of the following +flags (multiple values are combined without any separators): +</p> +<p><b>C</b> (connect): If set, the connection will +be probed once after connecting to the backend. The timeout +can be set by <code>connect_timeout</code>. If it is not set, +the value of <code>ping_timeout</code> will be used instead. +</p> +<p><b>P</b> (prepost): If set, the connection will +be probed before sending each request to the backend. The timeout +can be set by <code>prepost_timeout</code>. If it is not set, +the value of <code>ping_timeout</code> will be used instead. +</p> +<p><b>I</b> (interval): If set, the connection will +be probed during the regular internal maintenance cycle, +but only if it is idle longer than +<code>connection_ping_interval</code>. The timeout +can be set by <code>ping_timeout</code>. +</p> +<p><b>A</b> If set, all of the above probes will be used. +</p> +<p> +This feature has been added in <b>jk 1.2.27</b>. Connect and +prepost probing were already available via <code>connect_timeout</code> +and <code>prepost_timeout</code> since version <b>jk 1.2.6</b>. +</p> +</directive> + +<directive name="ping_timeout" default="10000" required="false"> +Timeout in milliseconds used when waiting for the CPong answer of a +CPing connection probe. The activation of the probes is done via +<code>ping_mode</code>. The timeouts for <code>ping_mode</code> +connect and prepost can be overwritten individually via +<code>connect_timeout</code> and <code>prepost_timeout</code>. +<p> +For compatibility reasons, CPing/CPong is also used, whenever +<code>connect_timeout</code> or <code>prepost_timeout</code> are set, +even if <code>ping_mode</code> is empty. +</p> +<p> +This feature has been added in <b>jk 1.2.27</b>. +</p> +</directive> + +The usage depend on the <code>ping_mode</code> flags used. +directive <code>connection_ping_interval</code> was not set, the +value of <code>(ping_timeout/1000) * 10</code> will be used as +<code>connection_ping_interval</code> value. + +<directive name="connection_ping_interval" default="0 / (ping_timeout/1000)*10" required="false"> +When using interval connection probing, connections idle for longer than this +interval in seconds are probed by CPing packets whether they still work. +<p>Interval probing can be activated either by <code>ping_mode</code>, +or by setting <code>connection_ping_interval</code> to some value bigger +than zero. If you activate interval probing via <code>ping_mode</code>, +then the default value of <code>connection_ping_interval</code> is +<code>(ping_timeout/1000) * 10</code>. Note that <code>ping_timeout</code> +is in milliseconds, and <code>connection_ping_interval</code> in seconds, +so in absolute terms the default <code>connection_ping_interval</code> is +10 times <code>ping_timeout</code>. +</p> +<p> +This feature has been added in <b>jk 1.2.27</b>. +</p> +</directive> + +<directive name="connection_pool_size" default="see text" required="false"> +This defines the number of connections made to the AJP backend that +are maintained as a connection pool. +It will limit the number of those connection that each web server child +process can made. +<p> +Connection pool size property is only used for multi threaded +web servers such as Apache, IIS and Netscape/Sun. The connection_pool_size property +needs to reflect the number of requests one web server process should +be able to send to a backend in parallel. Usually this is the same as +the number of threads per web server process. JK will discover +this number for the Apache web server automatically and set the pool size to +this value. For IIS the default value is 250 (before version 1.2.20: 10), +for Netscape/Sun the default value is 1. +</p> +<p>We strongly recommend adjusting this value for IIS and the Netscape/Sun +to the number of requests one web server process should +be able to send to a backend in parallel. You should measure how many connections +you need during peak activity without performance problems, and then add some +percentage depending on your growth rate. Finally you should check, +whether your web server processes are able to use at least as many threads, +as you configured as the pool size. +</p> +<warn>Do not use connection_pool_size with values higher then 1 on <b>Apache 2.x prefork</b> or <b>Apache 1.3.x</b>!</warn> +</directive> + +<directive name="connection_pool_minsize" default="(pool+1)/2" required="false"> +Minimum size of the connection pool that will be maintained. +<p> +Its default value is (connection_pool_size+1)/2. +</p> +<warn>Do not use connection_pool_size with values higher then 1 on <b>Apache 2.x prefork</b> or <b>Apache 1.3.x</b>!</warn> +<p> +This feature has been added in <b>jk 1.2.16</b>. +</p> +</directive> + +<directive name="connection_pool_timeout" default="0" required="false"> +Cache timeout property should be used with <b>connection_pool_minsize</b> to specify how many seconds JK should keep +an inactive socket in cache before closing it. This property should be used to reduce the number of threads +on the Tomcat web server. The default value zero disables the closing (infinite timeout). +<p> +Each child could open an ajp13 connection if it has to forward a request to Tomcat, creating +a new ajp13 thread on Tomcat side. +</p> +<p> +The problem is that after an ajp13 connection is created, the child won't drop it +until killed. And since the webserver will keep its childs/threads running +to handle high-load, even it the child/thread handle only static contents, you could +finish having many unused ajp13 threads on the Tomcat side. +</p> +<p> +You should keep this time interval in sync with the <b>connectionTimeout</b> attribute +of your AJP connector in Tomcat's server.xml. Note however, that the value +for mod_jk is given in seconds, the one in server.xml has to use milliseconds. +</p> +</directive> + +<directive name="connection_acquire_timeout" default="retries*retry_interval" required="false"> +Timeout the worker will wait for a free socket in cache before giving up. +<p> +Its default value is <b>retries * retry_interval</b>. +</p> +<p> +This feature has been added in <b>jk 1.2.27</b>. +</p> +</directive> + +<directive name="lbfactor" default="1" required="false"> +Only used for a member worker of a load balancer. +<p> +The integer number lbfactor (load-balancing factor) is +<i>how much we expect this worker to work</i>, or +<i>the worker's work quota</i>. Load balancing factor is compared with other workers +that makes the load balancer. For example if one worker has lb_factor 5 times higher then +other worker, then it will receive five times more requests. +</p> +</directive> + +</directives> + +</subsection> + +<subsection name="Load Balancing Directives"> +<br/> +<p>Load balancer is a virtual worker that does not really communicate with Tomcat workers. +Instead it is responsible for the management of several "real" workers. +The worker is supposed to be a load balancer if it's worker type is <b>lb</b>. +See worker's <b>type</b> directive. +</p> +<p>Loadbalancer directives define the parameters needed to create the workers that are +connecting to a remote cluster of backend Tomcat servers. Each cluster node has to +have a worker defined. +</p> +<p> +Load balancer management includes: +</p> + +<ul> +<li> +Instantiating the workers in the web server. +</li> +<li> +Using the worker's load-balancing factor, perform weighed-round-robin load balancing where +high lbfactor means stronger machine (that is going to handle more requests) +</li> +<li> +Keeping requests belonging to the same session executing on the same Tomcat worker. +</li> +<li> +Identifying failed Tomcat workers, suspending requests to them and instead fall-backing on +other workers managed by the lb worker. +</li> +</ul> + +<p> +The overall result is that workers managed by the same lb worker are load-balanced +(based on their lbfactor and current user session) and also fall-backed so a single +Tomcat process death will not "kill" the entire site. +</p> +<warn> +If you want to use session stickiness, you must set different jvmRoute attributes +in the Engine element in Tomcat's server.xml. Furthermore the names of the workers +which are managed by the balancer have to be equal to the jvmRoute of the Tomcat +instance they connect with. +</warn> +<p> +The restriction on the worker names can be lifted, if you use the route attribute for the workers. +</p> +<p> +The following table specifies properties that the lb worker can accept: +</p> + +<directives> +<directive name="balance_workers" default="" required="true"> +A comma separated list of workers that the load balancer +need to manage. +<p> +This directive can be used multiple times for the same load balancer. +</p> +<p> +This directive replaces old <b>balanced_workers</b> directive and +can be used only with mod_jk versions 1.2.7 and up. +</p> +<warn>As long as these workers should only be used via the load balancer worker, +there is no need to also put them into the <b>worker.list</b> property.</warn> +</directive> + +<directive name="sticky_session" default="True" required="false"> +Specifies whether requests with SESSION ID's should be routed back to the same +Tomcat worker. If sticky_session is set to <b>True</b> or <b>1</b> sessions are sticky, otherwise +sticky_session is set to <b>False</b>. Set sticky_session to <b>False</b> when Tomcat +is using a Session Manager which can persist session data across multiple +instances of Tomcat. +</directive> + +<directive name="sticky_session_force" default="False" required="false"> +Specifies whether requests with SESSION ID's for workers that are in error state +should be rejected. If sticky_session_force is set to <b>True</b> or <b>1</b> +and the worker that matches that SESSION ID is in error state, client will +receive 500 (Server Error). If set to <b>False</b> or <b>0</b> failover on +another worker will be issued with loosing client session. This directive is +used only when you set <b>sticky_session=True</b>. +<p> +This feature has been added in <b>jk 1.2.9</b>. +</p> +</directive> + +<directive name="method" default="Request" required="false"> +Specifies what method load balancer is using for electing the best worker. +Please note, that session stickiness and perfect load balancing are +conflicting targets, especially when the number +of sessions is small, or the usage of sessions is extremely varying +For huge numbers of sessions this usually is not a problem. +<p> +Some methods note, that they aggregate in a sliding time window. They add up +accesses, and on each run of the global maintain method, the load counters +get divided by 2. Usually this happens once a minute, depending on the +setting of worker.maintain. The value of the load counters can be inspected +using the status worker. +</p> +<p> +If method is set to <b>R[equest]</b> the balancer will use number of requests +to find the best worker. Accesses will be distributed according to the +lbfactor in a sliding time window. This is the default value and should be +working well for most applications. +</p> +<p> +If method is set to <b>S[ession]</b> the balancer will use number of sessions +to find the best worker. Accesses will be distributed according to the +lbfactor in a sliding time window. Because the balancer does not keep any state, +it actually does not know the number of sessions. Instead it counts each request +without a session cookie or URL encoding as a new session. This method will neither +know, when a session is being invalidated, nor will it correct its load numbers +according to session timeouts or worker failover. This method should be used, +if sessions are your limiting resource, e.g. when you only have limited memory +and your sessions need a lot of memory. +</p> +<p> +If set to <b>T[raffic]</b> the balancer will use +the network traffic between JK and Tomcat to find the best worker. +Accesses will be distributed according to the lbfactor in a sliding time window. +This method should be used, if network to and from the backends is your +limiting resource. +</p> +<p> +If set to <b>B[usyness]</b> the balancer will +pick the worker with the lowest current load, based on how many requests the +worker is currently serving. This number is divided by the workers lbfactor, +and the lowest value (least busy) worker is picked. This method is especially +interesting, if your request take a long time to process, like for a download +application. +</p> +<p> +This feature has been added in <b>jk 1.2.9</b>. +The Session method has been added in <b>jk 1.2.20</b>. +</p> +</directive> + +<directive name="lock" default="Optimistic" required="false"> +Specifies what lock method the load balancer will use for synchronising +shared memory runtime data. +If lock is set to <b>O[ptimistic]</b> balancer will not use shared memory lock +to find the best worker. If set to <b>P[essimistic]</b> balancer will use +shared memory lock. The balancer will work more accurately in case of +Pessimistic locking, but can slow down the average response time. +<p> +This feature has been added in <b>jk 1.2.13</b>. +</p> +</directive> + +<directive name="retries" default="2" required="false"> +<warn>This directive also exists for normal workers. +For those it has a <a href="#Advanced Worker Directives">different meaning</a>.</warn> +If the load balancer can not get a valid member worker or in case of failover, +it will try again a number of times given by <b>retries</b>. +Before each retry, it will make a pause define by <b>retry_interval</b> directive. +<p> +Until version <b>1.2.16</b> the default value was 3. +</p> +</directive> + +</directives> + +</subsection> + +<subsection name="Status Worker Directives"> +<br /> +<p> +The status worker does not communicate with Tomcat. +Instead it is responsible for the load balancer management. +</p> +<directives> +<directive name="css" default="" required="false"> +Specifies the url for cascading stylesheet to use. +</directive> +<directive name="read_only" default="False" required="false"> +A status worker with read_only=True will not allow any operations, +that change the runtime state or configuration of the other workers. +These are edit/update/reset/recover. +<p> +This feature has been added in <b>jk 1.2.20</b>. +</p> +</directive> +<directive name="user" default="" required="false"> +It is a list of users +which gets compared to the user name authenticated by the web server. +If the name is not contained in this list, access is denied. Per +default the list is empty and then access is allowed to anybody. +<p> +This directive can be used multiple times. +</p> +<p> +This feature has been added in <b>jk 1.2.20</b>. +</p> +</directive> +<directive name="user_case_insensitive" default="False" required="false"> +By default, the user names are matched case sensitively. You can set +user_case_insensitive=True to make the comparison case insensitive. +This may be especially useful on the Windows platform. +<p> +This feature has been added in <b>jk 1.2.21</b>. +</p> +</directive> +<directive name="good" default="a.o,a.n,a.b,a.r" required="false"> +For every load balancer worker, the status worker shows a summary +of the state of its members. There are three such states, +"good", "bad" and "degraded". +<p> +These states are determined depending on the activation of the members +(active, disabled, stopped) and their runtime state +(ok, n/a, busy, recovering, probing, forced recovery, error). +By default, members are assumed to be "good", if their activation +is "active" and their runtime state is not "error". +</p> +<p> +You can change this mapping, by assigning a list of values to the +attribute "good". Each value gives a possible match for the members, +and one match suffices. Each value is either a single character, or two +characters combined with a dot ".". The single characters are the +first characters in the words "active", "disabled", "stopped", +"ok", "na", "busy", "recovering", "error". The additional states "probing" +and "forced recovery" are always rated equivalent to "recovering". +If a value consists only +of a single character, then all members with this activation or runtime +state will be assumed good. A combination of an activation and a runtime +state concatenated with a dot "." does only apply to a member, that has +exactly this activation and state. +</p> +<p> +Members of a load balancer will first be matched against the state "bad", +if they don't match, the state "good" will be tried, and if they +still don't match, their state will be "degraded". +</p> +<p> +This directive can be used multiple times. +</p> +<p> +This feature has been added in <b>jk 1.2.20</b>. +</p> +</directive> +<directive name="bad" default="s,e" required="false"> +See: "good". +<p> +By default, members are assumed to be "bad", if their activation +is "stopped" or their runtime state is "error". +</p> +<p> +This directive can be used multiple times. +</p> +<p> +This feature has been added in <b>jk 1.2.20</b>. +</p> +</directive> +<directive name="prefix" default="worker" required="false"> +The prefix, which will be used by the status worker +when producing properties output (mime=prop). +Each property key will be prefixed by this value. +<p> +This feature has been added in <b>jk 1.2.20</b>. +</p> +</directive> +<directive name="ns" default="jk:" required="false"> +This directive can be used to customise the XML output from the +status worker. If set to <b>-</b> no namespace will be used. +<p> +This feature has been added in <b>jk 1.2.20</b>. +</p> +</directive> +<directive name="xmlns" default="" required="false"> +This directive can be used to customise the XML output from the +status worker. If set to <b>-</b> no xmlns will be used. +<p> +Default value is set to xmlns:jk="http://tomcat.apache.org" +</p> +<p> +This feature has been added in <b>jk 1.2.20</b>. +</p> +</directive> +<directive name="doctype" default="" required="false"> +This directive can be used to customise the XML output from the +status worker. This value will be inserted to the output xml +after the xml header. +<p> +This feature has been added in <b>jk 1.2.20</b>. +</p> +</directive> + +</directives> +</subsection> + +<subsection name="Advanced Worker Directives"> +<br /> +<p> +This table lists more advanced configuration options. Most of them only apply to +some types of workers. We use the abbreviations <b>AJP</b> for ajp13/ajp14 workers +used directly via the workers.list, <b>LB</b> for load balancer workers, +and <b>SUB</b> for the workers used indirectly in a load balancer worker +as a sub worker or member. +</p> +<advanceddirectives> +<directive name="connect_timeout" workers="AJP,SUB" default="0" required="false"> +Connect timeout property told webserver to send a PING request on ajp13 connection after +connection is established. The parameter is the delay in milliseconds to wait for the PONG reply. +The default value zero disables the timeout (infinite timeout). +<p> +This features has been added in <b>jk 1.2.6</b> to avoid problem with hung Tomcat's and require ajp13 +ping/pong support which has been implemented on Tomcat <b>3.3.2+, 4.1.28+ and 5.0.13+</b>. +Disabled by default. +</p> +</directive> + +<directive name="prepost_timeout" workers="AJP,SUB" default="0" required="false"> +Prepost timeout property told webserver to send a PING request on ajp13 connection before +forwarding to it a request. The parameter is the delay in milliseconds to wait for the PONG reply. +The default value zero disables the timeout (infinite timeout). +<p> +This features has been added in <b>jk 1.2.6</b> to avoid problem with hung Tomcat's and require ajp13 +ping/pong support which has been implemented on <b>Tomcat 3.3.2+, 4.1.28+ and 5.0.13+</b>. +Disabled by default. +</p> +</directive> + +<directive name="reply_timeout" workers="AJP,SUB" default="0" required="false"> +The parameter is the number of milliseconds to wait for success during a read event. +So this is not a timeout for the complete answer time of a request, but only +for the maximum time between two packets received from Tomcat. Usually the longest +pause is between sending the request and getting the first packet of the response. +<p> +If the timeout passes without any data received from Tomcat, the webserver will +no longer wait for the rest of the response and send an error to the client (browser). +Usually this does not mean, that the request is also aborted on the Tomcat backend. +If the worker is a member of a load balancer, the load balancer might place the +worker into an error state and retry the request on another member. +See also <b>max_reply_timeouts</b>, <b>retries</b> and <b>recovery_options</b>. +</p> +<p> +By default (value zero) the webserver will wait forever which could be an issue for you. +If you set a reply_timeout, adjust it carefully if you have long running servlets. +</p> +<p> +The reply_timeout can be overwritten using the Apache httpd environment variable +JK_REPLY_TIMEOUT. +</p> +<p> +This features has been added in <b>jk 1.2.6</b> to avoid problem with hung Tomcat's and works on all +servlet engines supporting ajp13. The variable JK_REPLY_TIMEOUT has been added in version <b>1.2.27</b>. +</p> +</directive> + +<directive name="retries" workers="AJP,SUB" default="2" required="false"> +<warn>This directive also exists for load balancer workers. +For those it has a <a href="#Load Balancing Directives">different meaning</a>.</warn> +The maximum number of times that the worker will send a request to Tomcat +in case of a communication error. Each retry will be done over another +connection. The first time already gets counted, so retries=2 means +one retry after error. Before a retry, the worker waits for a configurable +sleeping time. +<p> +See also the attribute <b>recovery_options</b> for a more fine-grained control +of retries and <b>retry_interval</b> for the sleep time configuration. +</p> +<p> +Until version <b>1.2.16</b> the default value was 3. +</p> +</directive> + +<directive name="retry_interval" workers="AJP,SUB" default="100" required="false"> +The amount of time in milliseconds the worker sleeps before doing any retry. +<p> +This features has been added in <b>jk 1.2.27</b>. +</p> +</directive> + +<directive name="recovery_options" workers="AJP,SUB" default="0" required="false"> +Recovery options influence, how we should handle retries, +in case we detect a problem with Tomcat. +How often we will retry is controlled by the attribute <b>retries</b>. +<p> +This attribute is a bit mask. The following bits are allowed:<br/> +1: don't recover if Tomcat failed after getting the request<br/> +2: don't recover if Tomcat failed after sending the headers to client<br/> +4: close the connection to Tomcat, if we detect an error when writing back +the answer to the client (browser)<br/> +8: always recover requests for HTTP method HEAD (even if Bits 1 or 2 are set)<br/> +16: always recover requests for HTTP method GET (even if Bits 1 or 2 are set)<br/> +</p> +<p> +This features has been added in <b>jk 1.2.6</b>. +Option 4 has been added in version <b>1.2.16</b>, +options 8 and 16 in version <b>1.2.24</b>. +</p> +</directive> + +<directive name="fail_on_status" workers="AJP,SUB" default="0" required="false"> +Set this value to the HTTP status code that will cause a worker to fail +if returned from Servlet container. Use this directive to deal with +cases when the servlet container can temporary return non-200 responses +for a short amount of time, e.g during redeployment. +<p> +The error page, headers and status codes of the original response will not be send back +to the client. Instead the request will result in a 503 response. +If the worker is a member of a load balancer, the member will +be put into an error state. Request failover and worker recovery will be handled +with the usual load balancer procedures. +</p> +<p> +This feature has been added in <b>jk 1.2.20</b>. +</p> +<p> +Starting with <b>jk 1.2.22</b> it is possible to define multiple +status codes separated by space or comma characters. +For example: <code>worker.xxx.fail_on_status=500,503</code> +</p> +<p> +Starting with <b>jk 1.2.25</b> you can also tell the load +balancer to not put a member into an error state, if a +response returned with one of the status codes in +fail_on_status. This feature gets enabled, by putting a minus sign in +front of those status codes. +For example: <code>worker.xxx.fail_on_status=-404,-500,503</code> +</p> +</directive> + +<directive name="max_packet_size" workers="AJP,SUB" default="8192" required="false"> +This attribute sets the maximal AJP packet size in Bytes. +The maximum value is 65536. If you change it from the default, +you <b>must</b> also change the packetSize attribute of your AJP +connector on the Tomcat side! The attribute packetSize is only available +in Tomcat 5.5.20+ and 6.0.2+. +<p> +Normally it is not necessary to change the maximum packet size. Problems +with the default value have been reported when sending certificates or +certificate chains. +</p> +<p> +This feature has been added in <b>jk 1.2.19</b>. +</p> +</directive> + +<directive name="mount" workers="AJP,LB" default="" required="false"> +Space delimited list of uri maps the worker should handle. It is only used, +if the worker is included in worker.list. +<p> +This directive can be used multiple times for the same worker. +</p> +</directive> + +<directive name="secret" workers="AJP,LB,SUB" default="" required="false"> +You can set a secret keyword on the Tomcat AJP Connector. Then only requests +from workers with the same secret keyword will be accepted. +<p> +Use <b>request.secret="secret key word"</b> in your Tomcat AJP Connector configuration. +</p> +<p> +If you set a secret on a load balancer, all its members will inherit this secret. +</p> +<p> +This feature has been added in <b>jk 1.2.12</b>. +</p> +</directive> + +<directive name="max_reply_timeouts" workers="LB" default="0" required="false"> +If you use a <b>reply_timeout</b> for the members of a load balancer worker, +and you want to tolerate a few requests taking longer than reply_timeout, +you can set this attribute to some positive value. +<p> +Long running requests will still time out after reply_timeout milliseconds waiting for +data, but the corresponding member worker will only be put into an error state, +if more than <b>max_reply_timeouts</b> requests have timed out. +More precisely, the counter for those bad requests will be divided by two, +whenever the load balancer does its internal maintenance (by default every 60 +seconds). +</p> +<p> +This features has been added in <b>jk 1.2.24</b> to make <b>reply_timeout</b> less +sensitive for sporadic long running requests. +</p> +</directive> + +<directive name="recover_time" workers="LB" default="60" required="false"> +The recover time is the time in seconds the load balancer will not try +to use a worker, after it went into error state. Only after this time has passed, +a worker in error state will be marked as in recovering, so that it will be +tried for new requests. +<p> +This interval is not checked every time a request is being processed. +Instead it is being checked during global maintenance. The time between two +runs of global maintenance is controlled by worker.maintain. +</p> +<p> +Do not set recover_time to a very short time unless you understand the implications. +Every recovery attempt for a worker in error is done by a real request! +</p> +</directive> + +<directive name="error_escalation_time" workers="LB" default="recover_time / 2" required="false"> +Setting a member of a load balancer into an error state is quite serious. E.g. +it means that if you need stickyness, all access to the sessions of the +respective node is blocked. +<p> +Some types of error detection do not provide a precise information, whether +a node is completely broken or not. In those cases an LB will not immediately +put the node into the error state. Only when there have been no successful +responses for <b>error_escalation_time</b> seconds after such an error, +will the node be put into error state. +</p> +<p> +This features has been added in <b>jk 1.2.28</b>. +</p> +</directive> + +<directive name="activation" workers="SUB" default="Active" required="false"> +Using this directive, a balanced worker of a load balancer +can be configured as disabled or stopped. A disabled worker only gets +requests, which belong to sessions for that worker. A stopped +worker does not get any requests. Users of a stopped worker will +loose their sessions, unless session replication via clustering is used. +<p> +Use <b>d</b> or <b>D</b> to disable and <b>s</b> or <b>S</b> to stop. +If this directive is not present the deprecated directives +"disabled" or "stopped" are used. +</p> +<p> +This flag can be changed at runtime using status worker. +</p> +<p> +This feature has been added in <b>jk 1.2.19</b>. +</p> +</directive> + +<directive name="route" workers="SUB" default="worker name" required="false"> +Normally the name of a balanced worker in a load balancer is equal to the jvmRoute +of the corresponding Tomcat instance. If you want to include a worker corresponding +to a Tomcat instance into several load balancers with different balancing configuration +(e.g. disabled, stopped) you can use this attribute. +<p> +Define a separate worker per lb and per Tomcat instance with an arbitrary worker name and +set the route attribute of the worker equal to the jvmRoute of the target Tomcat instance. +</p> +<p> +If this attribute is left empty, the name of the worker will be used. +</p> +<p> +This attribute can be changed at runtime using status worker. +</p> +<p> +If the route name contains a period, the part before the first period will be +used as domain name, unless domain is set explicitly. +</p> +<p> +This feature has been added in <b>jk 1.2.16</b>.<br/> +The automatic domain rule has been added in <b>jk 1.2.20</b>.<br/> +The attribute has been renamed from jvm_route to route in <b>jk 1.2.20</b>. +</p> +</directive> + +<directive name="distance" workers="SUB" default="0" required="false"> +An integer number to express preferences between +the balanced workers of an lb worker. +A load balancer will never choose some balanced worker +in case there is another usable worker with lower distance. +<p> +Only in case all workers below a given distance are in error, disabled or stopped, +workers of a larger distance are eligible for balancing. +</p> +<p> +This feature has been added in <b>jk 1.2.16</b>. +</p> +</directive> + +<directive name="domain" workers="SUB" default="" required="false"> +Domain directive can be used only when the worker is a member of the load balancer. +Workers that share the same domain name are treated as single worker. If sticky_session +is used, then the domain name is used as session route. +<p> +This directive is used for large system with more then 6 Tomcats, to be able +to cluster the Tomcats in two groups and thus lowering the session replication +transfer between them. +</p> +<p> +This feature has been added in <b>jk 1.2.8</b>. +</p> +</directive> + +<directive name="redirect" workers="SUB" default="" required="false"> +Set to the name of the preferred failover worker. If worker matching +SESSION ID is in error state then the redirect worker will be used instead. +It will be used even if being disabled, thus offering hot standby. +<p> +If you explicitly set a route via the "route" attribute, you must set "redirect" +to this route of the preferred failover worker and not to its name. +</p> +<p> +This feature has been added in <b>jk 1.2.9</b>. +</p> +</directive> + +<directive name="session_cookie" workers="LB" default="JSESSIONID" required="false"> +The name of the cookie that contains the routing identifier needed for session stickyness. +The routing identifier is everything after a "." character in the value of the cookie. +<p> +This feature has been added in <b>jk 1.2.27</b>. +</p> +</directive> + +<directive name="session_path" workers="LB" default=";jsessionid" required="false"> +The name of the path parameter that contains the routing identifier needed for +session stickyness. The routing identifier is everything after a "." character in the value +of the path parameter. +<p> +This feature has been added in <b>jk 1.2.27</b>. +</p> +</directive> + +</advanceddirectives> +</subsection> + +<subsection name="Deprecated Worker Directives"> +<br/> +<p>The following directives have been deprecated in the past. We include their documentation +in case you need to use an older version of mod_jk. We urge you to update and not use +them any more. Please migrate your existing configurations. +</p> +<deprecations> +<directive name="cachesize" successor="connection_pool_size" default="see text" required="false"> +<warn>This directive has been deprecated since 1.2.16.</warn> +Cachesize defines the number of connections made to the AJP backend that +are maintained as a connection pool. +It will limit the number of those connection that each web server child +process can make. +<p> +Cachesize property is used only for multi threaded +web servers such as Apache 2.0 (worker), IIS and Netscape. The cachesize property +should reflect the number of threads per child process. JK will discover +the number of threads per child process on Apache 2 web server with worker-mpm and set +its default value to match the ThreadsPerChild Apache directive. For IIS the default +value is 10. For other web servers than Apache or IIS this value has to be set manually. +</p> +<warn>Do not use cachesize with values higher then 1 on <b>Apache 2.x prefork</b> or <b>Apache 1.3.x</b>!</warn> +</directive> + +<directive name="cache_timeout" successor="connection_pool_timeout" default="0" required="false"> +<warn>This directive has been deprecated since 1.2.16.</warn> +Cache timeout property should be used with <b>cachesize</b> to specify how to time JK should keep +an open socket in cache before closing it. This property should be used to reduce the number of threads +on the Tomcat web server. +<p> +Each child could open an ajp13 connection if it have to forward a request to Tomcat, creating +a new ajp13 thread on Tomcat side. +</p> +<p> +The problem is that after an ajp13 connection is created, the child won't drop it +until killed. And since the webserver will keep its childs/threads running +to handle high-load, even it the child/thread handle only static contents, you could +finish having many unused ajp13 threads on the Tomcat side. +</p> +</directive> + +<directive name="recycle_timeout" successor="connection_pool_timeout" default="0" required="false"> +<warn>This directive has been deprecated since 1.2.16.</warn> +The number of seconds that told webserver to cut an ajp13 connection after some time of +inactivity. When choosing an endpoint for a request and the assigned socket is open, it will be +closed if it was not used for the configured time. +It's a good way to ensure that there won't too old threads living on Tomcat side, +with the extra cost you need to reopen the socket next time a request be forwarded. +This property is very similar to <b>cache_timeout</b> but works also in non-cache mode. +If set to value zero (default) no recycle will took place. +</directive> + +<directive name="balanced_workers" successor="balance_workers" default="" required="true"> +<warn>This directive has been deprecated since 1.2.7.</warn> +A comma separated list of workers that the load balancer +need to manage. +</directive> + +<directive name="disabled" successor="activation" default="False" required="false"> +<warn>This directive has been deprecated since 1.2.19.</warn> +If set to <b>True</b> or <b>1</b> the worker will be disabled if member +of load balancer. This flag can be changed at runtime using status worker. +<p> +This feature has been added in <b>jk 1.2.9</b>. +</p> +</directive> + +<directive name="stopped" successor="activation" default="False" required="false"> +<warn>This directive has been deprecated since 1.2.19.</warn> +If set to <b>True</b> or <b>1</b> the worker will be stopped if member +of load balancer. The flag is needed for stop complete traffic of a sticky session +worker. It is only useful, when you have a cluster that replicated the sessions. +This flag can be changed at runtime using status worker. +<p> +This feature has been added in <b>jk 1.2.11</b>. +</p> +</directive> + +<directive name="jvm_route" successor="route" default="worker name" required="false"> +<warn>This directive has been deprecated since 1.2.20.</warn> +Normally the name of a balanced worker in a load balancer is equal to the jvmRoute +of the corresponding Tomcat instance. If you want to include a worker corresponding +to a Tomcat instance into several load balancers with different balancing configuration +(e.g. disabled, stopped) you can use this attribute. +<p> +Define a separate worker per lb and per Tomcat instance with an arbitrary worker name and +set the jvm_route attribute of the worker equal to the jvmRoute of the target Tomcat instance. +</p> +<p> +If this attribute is left empty, the name of the worker will be used. +</p> +<p> +This attribute can be changed at runtime using status worker. +</p> +<p> +This feature has been added in <b>jk 1.2.16</b>. +</p> +</directive> + +</deprecations> +</subsection> + +</section> + +</body> +</document> |