Modified: tomcat/site/trunk/docs/connectors-doc/reference/status.html URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/connectors-doc/reference/status.html?rev=1848964&r1=1848963&r2=1848964&view=diff ============================================================================== --- tomcat/site/trunk/docs/connectors-doc/reference/status.html (original) +++ tomcat/site/trunk/docs/connectors-doc/reference/status.html Fri Dec 14 17:45:49 2018 @@ -1,6 +1,35 @@ -<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>The Apache Tomcat Connectors - Reference Guide - Status Worker Reference</title><meta name="author" value="Rainer Jung"><meta name="email" value="rj...@apache.org"><link href="../style.css" type="text/css" rel="stylesheet"></head><body bgcolor="#ffffff" text="#000000" link="#525D76" alink="#525D76" vlink="#525D76"><table border="0" width="100%" cellspacing="4"><!--PAGE HEADER--><tr><td colspan="2"><!--TOMCAT LOGO--><a href="http://tomcat.apache.org/";><img src="../images/tomcat.gif" align="left" alt="Apache Tomcat" border="0"></a><!--APACHE LOGO--><a href="http://www.apache.org/";><img src="http://www.apache.org/images/asf-logo.gif"; align="right" alt=" :: Apache Software Foundation" border="0"></a></td></tr><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap="true"><p><strong>Links</strong></p><ul><li><a hre f="../index.html">Docs Home</a></li></ul><p><strong>Common HowTo</strong></p><ul><li><a href="../common_howto/quick.html">For the impatient</a></li><li><a href="../common_howto/workers.html">All about workers</a></li><li><a href="../common_howto/timeouts.html">Timeouts</a></li><li><a href="../common_howto/loadbalancers.html">Load Balancing</a></li><li><a href="../common_howto/proxy.html">Reverse Proxy</a></li></ul><p><strong>Web Server HowTo</strong></p><ul><li><a href="../webserver_howto/apache.html">Apache HTTP Server (mod_jk)</a></li><li><a href="../webserver_howto/iis.html">Microsoft IIS (ISAPI redirector)</a></li><li><a href="../webserver_howto/nes.html">iPlanet Web Server (NSAPI redirector)</a></li></ul><p><strong>Reference Guide</strong></p><ul><li><a href="../reference/workers.html">workers.properties</a></li><li><a href="../reference/uriworkermap.html">uriworkermap.properties</a></li><li><a href="../reference/status.html">Status Worker</a></li><li><a href="../reference/apac he.html">Apache HTTP Server (mod_jk)</a></li><li><a href="../reference/iis.html">Microsoft IIS (ISAPI redirector)</a></li></ul><p><strong>AJP Protocol Reference</strong></p><ul><li><a href="../ajp/ajpv13a.html">AJPv13 (ajp13)</a></li><li><a href="../ajp/ajpv13ext.html">AJPv13 Extension Proposal</a></li></ul><p><strong>Miscellaneous Documentation</strong></p><ul><li><a href="../miscellaneous/faq.html">Frequently asked questions</a></li><li><a href="../miscellaneous/changelog.html">Changelog</a></li><li><a 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=">Current Tomcat Connectors bugs</a></li><li><a href="../miscellaneous/doccontrib.html">Contribute documentation</a></li><li><a href="../miscellaneous/jkstatustasks.html">JK Status Ant Tasks</a></li><li><a href="../miscellaneous/reporttools.html">Reporting Tools</a></li><li><a href="http://tomcat.apache.org/connectors-doc-archive/jk2/index.html";>Old JK/JK2 documentation</a></li></ul><p><strong>News</strong></p><ul><li><a href="../news/20180301.html">2018</a></li><li><a href="../news/20150901.html">2016</a></li><li><a href="../news/20150101.html">2015</a></li><li><a href="../news/20140201.html">2014</a></li><li><a href="../news/20120301.html">2012</a></li><li><a href="../news/20110701.html">2011</a></li><li><a href="../news/20100101.html">2010</a> </li><li><a href="../news/20090301.html">2009</a></li><li><a href="../news/20081001.html">2008</a></li><li><a href="../news/20070301.html">2007</a></li><li><a href="../news/20060101.html">2006</a></li><li><a href="../news/20050101.html">2005</a></li><li><a href="../news/20041100.html">2004</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left"><table border="0" width="100%" cellspacing="4"><tr><td align="left" valign="top"><h1>The Apache Tomcat Connectors - Reference Guide</h1><h2>Status Worker Reference</h2></td><td align="right" valign="top" nowrap="true"><small><a href="printer/status.html"><img src="../images/printer.gif" border="0" alt="Printer Friendly Version"><br>print-friendly<br>version - </a></small></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> -<br> +<!DOCTYPE html SYSTEM "about:legacy-compat"> +<html lang="en"><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><link href="../images/docs-stylesheet.css" rel="stylesheet" type="text/css"><title>The Apache Tomcat Connectors: mod_jk, ISAPI redirector, NSAPI redirector (1.2.x) - Status Worker Reference</title><meta name="author" content="Rainer Jung"><script type="application/javascript" data-comments-identifier=""> + "use strict"; // Enable strict mode + + (function() { + var thisScript = document.currentScript; + if (!thisScript) { // Workaround for IE <= 11 + var scripts = document.getElementsByTagName("script"); + thisScript = scripts[scripts.length - 1]; + } + document.addEventListener("DOMContentLoaded", (function() { + var commentsDiv = document.getElementById("comments_thread"); + var commentsShortname = "tomcat"; + var commentsIdentifier = "https://tomcat.apache.org/"; + + thisScript.getAttribute("data-comments-identifier") + ".html"; + + (function(w, d) { + if (w.location.hostname.toLowerCase() == "tomcat.apache.org") { + var s = d.createElement("script"); + s.type = "application/javascript"; + s.async = true; + s.src = "https://comments.apache.org/show_comments.lua?site="; + + encodeURIComponent(commentsShortname) + + "&page=" + encodeURIComponent(commentsIdentifier); + d.head.appendChild(s); + } else { + commentsDiv.appendChild(d.createTextNode("Comments are disabled for this page at the moment.")); + } + })(window, document); + }), false); + })(); + </script></head><body><div id="wrapper"><header><div id="header"><div><div><div class="logo noPrint"><a href="http://tomcat.apache.org/";><img alt="Tomcat Home" src="../images/tomcat.png"></a></div><div style="height: 1px;"></div><div class="asfLogo noPrint"><a href="https://www.apache.org/"; target="_blank"><img src="../images/asf-logo.svg" alt="The Apache Software Foundation" style="width: 266px; height: 83px;"></a></div><h1>The Apache Tomcat Connectors: mod_jk, ISAPI redirector, NSAPI redirector</h1><div style="height: 1px;"></div><div style="clear: left;"></div></div></div></div></header><div id="middle"><div><div id="mainLeft" class="noprint"><div><nav><div><h2>Links</h2><ul><li><a href="index.html">Docs Home</a></li></ul></div><div><h2>Common HowTo</h2><ul><li><a href="common_howto/quick.html">For the impatient</a></li><li><a href="common_howto/workers.html">All about workers</a></li><li><a href="common_howto/timeouts.html">Timeouts</a></li><li><a href="common_howto/loadbalanc ers.html">Load Balancing</a></li><li><a href="common_howto/proxy.html">Reverse Proxy</a></li></ul></div><div><h2>Web Server HowTo</h2><ul><li><a href="webserver_howto/apache.html">Apache HTTP Server (mod_jk)</a></li><li><a href="webserver_howto/iis.html">Microsoft IIS (ISAPI redirector)</a></li><li><a href="webserver_howto/nes.html">iPlanet Web Server (NSAPI redirector)</a></li></ul></div><div><h2>Reference Guide</h2><ul><li><a href="reference/workers.html">workers.properties</a></li><li><a href="reference/uriworkermap.html">uriworkermap.properties</a></li><li><a href="reference/status.html">Status Worker</a></li><li><a href="reference/apache.html">Apache HTTP Server (mod_jk)</a></li><li><a href="reference/iis.html">Microsoft IIS (ISAPI redirector)</a></li></ul></div><div><h2>AJP Protocol Reference</h2><ul><li><a href="ajp/ajpv13a.html">AJPv13 (ajp13)</a></li><li><a href="ajp/ajpv13ext.html">AJPv13 Extension Proposal</a></li></ul></div><div><h2>Miscellaneous Documentation</h2><ul><l i><a href="miscellaneous/faq.html">Frequently asked questions</a></li><li><a href="miscellaneous/changelog.html">Changelog</a></li><li><a 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=";>Current Tomcat Connectors bugs</a></li><li><a href="miscellaneous/doccontrib.html">Contribute documentation</a></li><li><a href=" miscellaneous/jkstatustasks.html">JK Status Ant Tasks</a></li><li><a href="miscellaneous/reporttools.html">Reporting Tools</a></li><li><a href="http://tomcat.apache.org/connectors-doc-archive/jk2/index.html";>Old JK/JK2 documentation</a></li></ul></div><div><h2>News</h2><ul><li><a href="news/20180301.html">2018</a></li><li><a href="news/20160901.html">2016</a></li><li><a href="news/20150101.html">2015</a></li><li><a href="news/20140201.html">2014</a></li><li><a href="news/20120301.html">2012</a></li><li><a href="news/20110701.html">2011</a></li><li><a href="news/20100101.html">2010</a></li><li><a href="news/20090301.html">2009</a></li><li><a href="news/20081001.html">2008</a></li><li><a href="news/20070301.html">2007</a></li><li><a href="news/20060101.html">2006</a></li><li><a href="news/20050101.html">2005</a></li><li><a href="news/20041100.html">2004</a></li></ul></div></nav></div></div><div id="mainRight"><div id="content"><h2>Status Worker Reference</h2><h3 id="Introduction">Intr oduction</h3><div class="text"> <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 @@ -21,10 +50,8 @@ include the status worker in your automa <p> The documentation of the status worker starts with <b>jk 1.2.20</b> </p> -</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Usage Patterns"><strong>Usage Patterns</strong></a></font></td></tr><tr><td><blockquote> -<br> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Actions"><strong>Actions</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div><h3 id="Usage_Patterns">Usage Patterns</h3><div class="text"> +<div class="subsection"><h4 id="Usage_Patterns/Actions">Actions</h4><div class="text"> <p> The status worker knows about the following actions: <ul> @@ -66,10 +93,9 @@ The dump action has been added in versio </li> </ul> </p> -</blockquote></td></tr></table> +</div></div> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Output Format"><strong>Output Format</strong></a></font></td></tr><tr><td><blockquote> -<br> +<div class="subsection"><h4 id="Usage_Patterns/Output_Format">Output Format</h4><div class="text"> <p> For most actions you can choose between 4 output formats. <ul> @@ -93,10 +119,9 @@ use in workers.properties. It will not p </ul> The "edit" action does only make sense for the HTML output type. </p> -</blockquote></td></tr></table> +</div></div> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="User Interface Features"><strong>User Interface Features</strong></a></font></td></tr><tr><td><blockquote> -<br> +<div class="subsection"><h4 id="User_Interface_Features">User Interface Features</h4><div class="text"> <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 @@ -135,10 +160,9 @@ blocks of information: </ul> The last three minimisation features have been added in version 1.2.27. </p> -</blockquote></td></tr></table> +</div></div> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Special Considerations concerning URL Maps and Virtual Hosts"><strong>Special Considerations concerning URL Maps and Virtual Hosts</strong></a></font></td></tr><tr><td><blockquote> -<br> +<div class="subsection"><h4 id="Special_Considerations_concerning_URL_Maps_and_Virtual_Hosts">Special Considerations concerning URL Maps and Virtual Hosts</h4><div class="text"> <p> <b>Note: </b>The following restriction has been removed starting with version 1.2.26. </p> @@ -150,38 +174,33 @@ for other virtual hosts. Of course you c 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> -</blockquote></td></tr></table> +</div></div> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Logging"><strong>Logging</strong></a></font></td></tr><tr><td><blockquote> -<br> +<div class="subsection"><h4 id="Logging">Logging</h4><div class="text"> <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> -</blockquote></td></tr></table> +</div></div> -</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Configuration"><strong>Configuration</strong></a></font></td></tr><tr><td><blockquote> -<br> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Basic Configuration"><strong>Basic Configuration</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div><h3 id="Configuration">Configuration</h3><div class="text"> +<div class="subsection"><h4 id="Basic_Configuration">Basic Configuration</h4><div class="text"> <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: -<div class="example"><pre> -worker.list=mystatus +<div class="codeBox"><pre><code>worker.list=mystatus worker.mystatus.type=status -</pre></div> +</code></pre></div> 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 JkMount for the Apache HTTP Server. Here's an example for a uriworkermap.properties line: -<div class="example"><pre> -/private/admin/mystatus=mystatus -</pre></div> +<div class="codeBox"><pre><code>/private/admin/mystatus=mystatus +</code></pre></div> The URI pattern is case sensitive. </p> <p> @@ -193,23 +212,20 @@ You can also define multiple instances o For instance you might want to configure them individually and then allow special groups of people to use them </p> -</blockquote></td></tr></table> +</div></div> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Output Customisation"><strong>Output Customisation</strong></a></font></td></tr><tr><td><blockquote> -<br> +<div class="subsection"><h4 id="Output_Customisation">Output Customisation</h4><div class="text"> <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: -<div class="example"><pre> -worker.mystatus.css=/private/admin/static/mystatus.css -</pre></div> +<div class="codeBox"><pre><code>worker.mystatus.css=/private/admin/static/mystatus.css +</code></pre></div> When writing HTML output, the status worker then includes the line -<div class="example"><pre> -<link rel="stylesheet" type="text/css" href="/private/admin/static/mystatus.css" /> -</pre></div> +<div class="codeBox"><pre><code><link rel="stylesheet" type="text/css" href="/private/admin/static/mystatus.css" /> +</code></pre></div> 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 @@ -232,10 +248,9 @@ is xmlns:jk="http://tomcat.apache.org";. 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> -</blockquote></td></tr></table> +</div></div> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Securing Access"><strong>Securing Access</strong></a></font></td></tr><tr><td><blockquote> -<br> +<div class="subsection"><h4 id="Securing_Access">Securing Access</h4><div class="text"> <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 @@ -247,15 +262,14 @@ The default value is <b>false</b>, ie. r <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: -<div class="example"><pre> -worker.list=jk-watch +<div class="codeBox"><pre><code>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 -</pre></div> +</code></pre></div> 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 @@ -274,10 +288,9 @@ The user list can be split over multiple 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 <b>true</b>. Then the comparison will be made case insensitive. </p> -</blockquote></td></tr></table> +</div></div> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Service Availability Rating"><strong>Service Availability Rating</strong></a></font></td></tr><tr><td><blockquote> -<br> +<div class="subsection"><h4 id="Service_Availability_Rating">Service Availability Rating</h4><div class="text"> <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". @@ -340,9 +353,8 @@ The status worker first tries to match a it tries to match against "good", and finally it chooses "degraded", if no "bad" or "good" match can be found. </p> -</blockquote></td></tr></table> -</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Request Parameters"><strong>Request Parameters</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +</div><h3 id="Request_Parameters">Request Parameters</h3><div class="text"> <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 @@ -351,8 +363,7 @@ will keep their original semantics. We a and Text to be kept stable. So please use those, if you want to parse status worker output in your automation scripts. </p> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Actions"><strong>Actions</strong></a></font></td></tr><tr><td><blockquote> -<br> +<div class="subsection"><h4 id="Request_Parameters/Actions">Actions</h4><div class="text"> <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, @@ -362,17 +373,15 @@ All actions except for "list", "refresh" <p> The action "dump" has been added in version 1.2.27. </p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Output Format"><strong>Output Format</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +<div class="subsection"><h4 id="Request_Parameters/Output_Format">Output Format</h4><div class="text"> <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> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Worker Selection"><strong>Worker Selection</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +<div class="subsection"><h4 id="Worker_Selection">Worker Selection</h4><div class="text"> <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. @@ -380,16 +389,14 @@ If an action operates on a member (sub w contains the name of the load balancer worker, and the additional parameter <b>sw</b> contains the name of the sub worker. </p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Automatic Refresh"><strong>Automatic Refresh</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +<div class="subsection"><h4 id="Automatic_Refresh">Automatic Refresh</h4><div class="text"> <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> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Hide Options"><strong>Hide Options</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +<div class="subsection"><h4 id="Hide_Options">Hide Options</h4><div class="text"> <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: @@ -424,9 +431,8 @@ by default no options are activated. The </ul> Values 0x0040-0x0100 have been added in version 1.2.27. </p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Data Parameters for the standard Update Action"><strong>Data Parameters for the standard Update Action</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +<div class="subsection"><h4 id="Data_Parameters_for_the_standard_Update_Action">Data Parameters for the standard Update Action</h4><div class="text"> <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 @@ -525,9 +531,8 @@ Changing settings for ajp workers has al <p> For the details of all parameters, we refer to the <a href="workers.html">workers.properties Reference</a>. </p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Aspect Editing for Load Balancer Members"><strong>Aspect Editing for Load Balancer Members</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +<div class="subsection"><h4 id="Aspect_Editing_for_Load_Balancer_Members">Aspect Editing for Load Balancer Members</h4><div class="text"> <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 @@ -544,7 +549,19 @@ parameter name. The values of the common aspect for all the load balancer members will be given in parameters named "val0", "val1", .... </p> -</blockquote></td></tr></table> -</blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em> - Copyright © 1999-2018, Apache Software Foundation - </em></font></div></td></tr></table></body></html> \ No newline at end of file +</div></div> +</div><div class="noprint"><h3 id="comments_section"> + Comments + </h3><div class="text"><p class="notice"><strong>Notice:</strong> This comments section collects your suggestions + on improving documentation for Apache Tomcat.<br><br> + If you have trouble and need help, read + <a href="https://tomcat.apache.org/findhelp.html";>Find Help</a> page + and ask your question on the tomcat-users + <a href="https://tomcat.apache.org/lists.html";>mailing list</a>. + Do not ask such questions here. This is not a Q&A section.<br><br> + The Apache Comments System is explained <a href="../comments.html">here</a>. + Comments may be removed by our moderators if they are either + implemented or considered invalid/off-topic. + </p><div id="comments_thread"></div></div></div></div></div></div></div><footer><div id="footer"> + Copyright © 1999-yyyy, The Apache Software Foundation + </div></footer></div></body></html> \ No newline at end of file
Modified: tomcat/site/trunk/docs/connectors-doc/reference/uriworkermap.html URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/connectors-doc/reference/uriworkermap.html?rev=1848964&r1=1848963&r2=1848964&view=diff ============================================================================== --- tomcat/site/trunk/docs/connectors-doc/reference/uriworkermap.html (original) +++ tomcat/site/trunk/docs/connectors-doc/reference/uriworkermap.html Fri Dec 14 17:45:49 2018 @@ -1,6 +1,35 @@ -<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>The Apache Tomcat Connectors - Reference Guide - uriworkermap.properties configuration</title><meta name="author" value="Rainer Jung"><meta name="email" value="rj...@apache.org"><meta name="author" value="Mladen Turk"><meta name="email" value="mt...@apache.org"><link href="../style.css" type="text/css" rel="stylesheet"></head><body bgcolor="#ffffff" text="#000000" link="#525D76" alink="#525D76" vlink="#525D76"><table border="0" width="100%" cellspacing="4"><!--PAGE HEADER--><tr><td colspan="2"><!--TOMCAT LOGO--><a href="http://tomcat.apache.org/";><img src="../images/tomcat.gif" align="left" alt="Apache Tomcat" border="0"></a><!--APACHE LOGO--><a href="http://www.apache.org/";><img src="http://www.apache.org/images/asf-logo.gif"; align="right" alt=" :: Apache Software Foundation" border="0"></a></td></tr><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><tr><!--LEFT SIDE N AVIGATION--><td width="20%" valign="top" nowrap="true"><p><strong>Links</strong></p><ul><li><a href="../index.html">Docs Home</a></li></ul><p><strong>Common HowTo</strong></p><ul><li><a href="../common_howto/quick.html">For the impatient</a></li><li><a href="../common_howto/workers.html">All about workers</a></li><li><a href="../common_howto/timeouts.html">Timeouts</a></li><li><a href="../common_howto/loadbalancers.html">Load Balancing</a></li><li><a href="../common_howto/proxy.html">Reverse Proxy</a></li></ul><p><strong>Web Server HowTo</strong></p><ul><li><a href="../webserver_howto/apache.html">Apache HTTP Server (mod_jk)</a></li><li><a href="../webserver_howto/iis.html">Microsoft IIS (ISAPI redirector)</a></li><li><a href="../webserver_howto/nes.html">iPlanet Web Server (NSAPI redirector)</a></li></ul><p><strong>Reference Guide</strong></p><ul><li><a href="../reference/workers.html">workers.properties</a></li><li><a href="../reference/uriworkermap.html">uriworkermap.properties</ a></li><li><a href="../reference/status.html">Status Worker</a></li><li><a href="../reference/apache.html">Apache HTTP Server (mod_jk)</a></li><li><a href="../reference/iis.html">Microsoft IIS (ISAPI redirector)</a></li></ul><p><strong>AJP Protocol Reference</strong></p><ul><li><a href="../ajp/ajpv13a.html">AJPv13 (ajp13)</a></li><li><a href="../ajp/ajpv13ext.html">AJPv13 Extension Proposal</a></li></ul><p><strong>Miscellaneous Documentation</strong></p><ul><li><a href="../miscellaneous/faq.html">Frequently asked questions</a></li><li><a href="../miscellaneous/changelog.html">Changelog</a></li><li><a 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=">Current Tomcat Connectors bugs</a></li><li><a href="../miscellaneous/doccontrib.html">Contribute documentation</a></li><li><a href="../miscellaneous/jkstatustasks.html">JK Status Ant Tasks</a></li><li><a href="../miscellaneous/reporttools.html">Reporting Tools</a></li><li><a href="http://tomcat.apache.org/connectors-doc-archive/jk2/index.html";>Old JK/JK2 documentation</a></li></ul><p><strong>News</strong></p><ul><li><a href="../news/20180301.html">2018</a></li><li><a href="../news/20150901.html">2016</a></li><li><a href="../news/20150101.html">2015</a></li><li><a href="../news/20140201.html">2014</a></li><li><a href="../news/20120301.html">2012</a> </li><li><a href="../news/20110701.html">2011</a></li><li><a href="../news/20100101.html">2010</a></li><li><a href="../news/20090301.html">2009</a></li><li><a href="../news/20081001.html">2008</a></li><li><a href="../news/20070301.html">2007</a></li><li><a href="../news/20060101.html">2006</a></li><li><a href="../news/20050101.html">2005</a></li><li><a href="../news/20041100.html">2004</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left"><table border="0" width="100%" cellspacing="4"><tr><td align="left" valign="top"><h1>The Apache Tomcat Connectors - Reference Guide</h1><h2>uriworkermap.properties configuration</h2></td><td align="right" valign="top" nowrap="true"><small><a href="printer/uriworkermap.html"><img src="../images/printer.gif" border="0" alt="Printer Friendly Version"><br>print-friendly<br>version - </a></small></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> -<br> +<!DOCTYPE html SYSTEM "about:legacy-compat"> +<html lang="en"><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><link href="../images/docs-stylesheet.css" rel="stylesheet" type="text/css"><title>The Apache Tomcat Connectors: mod_jk, ISAPI redirector, NSAPI redirector (1.2.x) - uriworkermap.properties configuration</title><meta name="author" content="Rainer Jung"><meta name="author" content="Mladen Turk"><script type="application/javascript" data-comments-identifier=""> + "use strict"; // Enable strict mode + + (function() { + var thisScript = document.currentScript; + if (!thisScript) { // Workaround for IE <= 11 + var scripts = document.getElementsByTagName("script"); + thisScript = scripts[scripts.length - 1]; + } + document.addEventListener("DOMContentLoaded", (function() { + var commentsDiv = document.getElementById("comments_thread"); + var commentsShortname = "tomcat"; + var commentsIdentifier = "https://tomcat.apache.org/"; + + thisScript.getAttribute("data-comments-identifier") + ".html"; + + (function(w, d) { + if (w.location.hostname.toLowerCase() == "tomcat.apache.org") { + var s = d.createElement("script"); + s.type = "application/javascript"; + s.async = true; + s.src = "https://comments.apache.org/show_comments.lua?site="; + + encodeURIComponent(commentsShortname) + + "&page=" + encodeURIComponent(commentsIdentifier); + d.head.appendChild(s); + } else { + commentsDiv.appendChild(d.createTextNode("Comments are disabled for this page at the moment.")); + } + })(window, document); + }), false); + })(); + </script></head><body><div id="wrapper"><header><div id="header"><div><div><div class="logo noPrint"><a href="http://tomcat.apache.org/";><img alt="Tomcat Home" src="../images/tomcat.png"></a></div><div style="height: 1px;"></div><div class="asfLogo noPrint"><a href="https://www.apache.org/"; target="_blank"><img src="../images/asf-logo.svg" alt="The Apache Software Foundation" style="width: 266px; height: 83px;"></a></div><h1>The Apache Tomcat Connectors: mod_jk, ISAPI redirector, NSAPI redirector</h1><div style="height: 1px;"></div><div style="clear: left;"></div></div></div></div></header><div id="middle"><div><div id="mainLeft" class="noprint"><div><nav><div><h2>Links</h2><ul><li><a href="index.html">Docs Home</a></li></ul></div><div><h2>Common HowTo</h2><ul><li><a href="common_howto/quick.html">For the impatient</a></li><li><a href="common_howto/workers.html">All about workers</a></li><li><a href="common_howto/timeouts.html">Timeouts</a></li><li><a href="common_howto/loadbalanc ers.html">Load Balancing</a></li><li><a href="common_howto/proxy.html">Reverse Proxy</a></li></ul></div><div><h2>Web Server HowTo</h2><ul><li><a href="webserver_howto/apache.html">Apache HTTP Server (mod_jk)</a></li><li><a href="webserver_howto/iis.html">Microsoft IIS (ISAPI redirector)</a></li><li><a href="webserver_howto/nes.html">iPlanet Web Server (NSAPI redirector)</a></li></ul></div><div><h2>Reference Guide</h2><ul><li><a href="reference/workers.html">workers.properties</a></li><li><a href="reference/uriworkermap.html">uriworkermap.properties</a></li><li><a href="reference/status.html">Status Worker</a></li><li><a href="reference/apache.html">Apache HTTP Server (mod_jk)</a></li><li><a href="reference/iis.html">Microsoft IIS (ISAPI redirector)</a></li></ul></div><div><h2>AJP Protocol Reference</h2><ul><li><a href="ajp/ajpv13a.html">AJPv13 (ajp13)</a></li><li><a href="ajp/ajpv13ext.html">AJPv13 Extension Proposal</a></li></ul></div><div><h2>Miscellaneous Documentation</h2><ul><l i><a href="miscellaneous/faq.html">Frequently asked questions</a></li><li><a href="miscellaneous/changelog.html">Changelog</a></li><li><a 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=";>Current Tomcat Connectors bugs</a></li><li><a href="miscellaneous/doccontrib.html">Contribute documentation</a></li><li><a href=" miscellaneous/jkstatustasks.html">JK Status Ant Tasks</a></li><li><a href="miscellaneous/reporttools.html">Reporting Tools</a></li><li><a href="http://tomcat.apache.org/connectors-doc-archive/jk2/index.html";>Old JK/JK2 documentation</a></li></ul></div><div><h2>News</h2><ul><li><a href="news/20180301.html">2018</a></li><li><a href="news/20160901.html">2016</a></li><li><a href="news/20150101.html">2015</a></li><li><a href="news/20140201.html">2014</a></li><li><a href="news/20120301.html">2012</a></li><li><a href="news/20110701.html">2011</a></li><li><a href="news/20100101.html">2010</a></li><li><a href="news/20090301.html">2009</a></li><li><a href="news/20081001.html">2008</a></li><li><a href="news/20070301.html">2007</a></li><li><a href="news/20060101.html">2006</a></li><li><a href="news/20050101.html">2005</a></li><li><a href="news/20041100.html">2004</a></li></ul></div></nav></div></div><div id="mainRight"><div id="content"><h2>uriworkermap.properties configuration</h2><h3 id="Intr oduction">Introduction</h3><div class="text"> <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, @@ -47,109 +76,95 @@ Integration with the status worker. </ul> The following sections describe these aspects in more detail. </p> -</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Syntax"><strong>Syntax</strong></a></font></td></tr><tr><td><blockquote> -<br> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Line format"><strong>Line format</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div><h3 id="Syntax">Syntax</h3><div class="text"> +<div class="subsection"><h4 id="Line_format">Line format</h4><div class="text"> <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 '=': -<div class="example"><pre> - /myapp=myworker -</pre></div> +<div class="codeBox"><pre><code>/myapp=myworker +</code></pre></div> The URI pattern is case sensitive. </p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Comments, white space"><strong>Comments, white space</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +<div class="subsection"><h4 id="Comments,_white_space">Comments, white space</h4><div class="text"> <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: -<div class="example"><pre> - # This is a white space example +<div class="codeBox"><pre><code># This is a white space example +/myapp=myworker /myapp=myworker - /myapp=myworker - /myapp = myworker -</pre></div> +/myapp = myworker +</code></pre></div> </p> -</blockquote></td></tr></table> +</div></div> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="URI patterns"><strong>URI patterns</strong></a></font></td></tr><tr><td><blockquote> -<br> +<div class="subsection"><h4 id="URI_patterns">URI patterns</h4><div class="text"> <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). -<div class="example"><pre> - # 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 -</pre></div> +<div class="codeBox"><pre><code># 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 +</code></pre></div> Since the first case of mapping a certain location and everything inside it is very common, the character '|' gives a handy shortcut: -<div class="example"><pre> - # Mapping the URI /myapp1 and everything under /myapp1/: - /myapp1|/*=myworker-a -</pre></div> +<div class="codeBox"><pre><code># Mapping the URI /myapp1 and everything under /myapp1/: +/myapp1|/*=myworker-a +</code></pre></div> The pattern 'X|Y' is exactly equivalent to the two maps 'X' and 'XY'. </p> -</blockquote></td></tr></table> -</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Exclusion, Disabling and Priorities"><strong>Exclusion, Disabling and Priorities</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +</div><h3 id="Exclusion,_Disabling_and_Priorities">Exclusion, Disabling and Priorities</h3><div class="text"> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Exclusions and rule disabling"><strong>Exclusions and rule disabling</strong></a></font></td></tr><tr><td><blockquote> -<br> +<div class="subsection"><h4 id="Exclusions_and_rule_disabling">Exclusions and rule disabling</h4><div class="text"> <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 '!': -<div class="example"><pre> - # Mapping the URI /myapp and everything under /myapp/: - /myapp|/*=myworker - # Exclude the subdirectory static: - !/myapp/static|/*=myworker - # Exclude some suffixes: - !*.html=myworker -</pre></div> +<div class="codeBox"><pre><code># Mapping the URI /myapp and everything under /myapp/: +/myapp|/*=myworker +# Exclude the subdirectory static: +!/myapp/static|/*=myworker +# Exclude some suffixes: +!*.html=myworker +</code></pre></div> 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. -<div class="example"><pre> - # 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=* -</pre></div> +<div class="codeBox"><pre><code># 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=* +</code></pre></div> </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 '-': -<div class="example"><pre> - # We are not in maintenance. - # The maintenance rule got defined somewhere else. - -/*=maintenance -</pre></div> +<div class="codeBox"><pre><code># We are not in maintenance. +# The maintenance rule got defined somewhere else. +-/*=maintenance +</code></pre></div> Exclusion rules can get disabled as well, then the rule starts with '-!'. </p> -</blockquote></td></tr></table> +</div></div> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Mapping priorities"><strong>Mapping priorities</strong></a></font></td></tr><tr><td><blockquote> -<br> +<div class="subsection"><h4 id="Mapping_priorities">Mapping priorities</h4><div class="text"> <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 @@ -169,56 +184,49 @@ There is no defined behaviour, for the f using literally the same URI pattern in the same defining source but with different worker targets. </p> -</blockquote></td></tr></table> -</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Rule extensions"><strong>Rule extensions</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +</div><h3 id="Rule_extensions">Rule extensions</h3><div class="text"> <p> Rule extensions were added in version 1.2.27 and are not available in earlier versions. </p> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Syntax"><strong>Syntax</strong></a></font></td></tr><tr><td><blockquote> -<br> +<div class="subsection"><h4 id="Rule_extensions/Syntax">Syntax</h4><div class="text"> <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: -<div class="example"><pre> - # 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 -</pre></div> +<div class="codeBox"><pre><code># 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 +</code></pre></div> Attributes set via rule extensions always overwrite conflicting configurations in the worker definition file. </p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Extension reply_timeout"><strong>Extension reply_timeout</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +<div class="subsection"><h4 id="Extension_reply_timeout">Extension reply_timeout</h4><div class="text"> <p> -The extension <b class="code">reply_timeout</b> sets a reply timeout for a single mapping rule. -<div class="example"><pre> - # Setting a reply_timeout of 1 minute - # only for this mapping. - /myapp=myworker;reply_timeout=60000 -</pre></div> -It overrides any <b class="code">reply_timeout</b> defined for the worker. The extension allows +The extension <code>reply_timeout</code> sets a reply timeout for a single mapping rule. +<div class="codeBox"><pre><code># Setting a reply_timeout of 1 minute +# only for this mapping. +/myapp=myworker;reply_timeout=60000 +</code></pre></div> +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="../common_howto/timeouts.html#Reply Timeout">timeouts</a> documentation. </p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Extension sticky_ignore"><strong>Extension sticky_ignore</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +<div class="subsection"><h4 id="Extension_sticky_ignore">Extension sticky_ignore</h4><div class="text"> <p> -The extension <b class="code">sticky_ignore</b> will disable session stickyness for a single +The extension <code>sticky_ignore</code> will disable session stickyness for a single mapping rule. -<div class="example"><pre> - # Disable session stickyness - # only for this mapping. - /myapp/loginform.jsp=myworker;sticky_ignore=1 -</pre></div> +<div class="codeBox"><pre><code># Disable session stickyness +# only for this mapping. +/myapp/loginform.jsp=myworker;sticky_ignore=1 +</code></pre></div> This extension can be useful to optimize load balancing when using cookie based session stickyness. In this case, as long as she keeps her browser open, any request by a user who started a session will @@ -230,128 +238,113 @@ to ensure, that this initial session req <p> This extension is available since version 1.2.33. </p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Extension stateless"><strong>Extension stateless</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +<div class="subsection"><h4 id="Extension_stateless">Extension stateless</h4><div class="text"> <p> -The extension <b class="code">stateless</b> is only useful when using session based +The extension <code>stateless</code> is only useful when using session based load balancing. In this case normally any request which does not come with a session id counts as a new session. If you mark a mapping rule with -the <b class="code">stateless</b> extension, then the requests matching the mapping +the <code>stateless</code> extension, then the requests matching the mapping rule will not count as a new session, even if they do not come with a session id. -<div class="example"><pre> - # Don't let static content trash our session balancing - /myapp/static/*=myworker;stateless=1 -</pre></div> +<div class="codeBox"><pre><code># Don't let static content trash our session balancing +/myapp/static/*=myworker;stateless=1 +</code></pre></div> This extension is available since version 1.2.33. </p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Extensions active/disabled/stopped"><strong>Extensions active/disabled/stopped</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +<div class="subsection"><h4 id="Extensions_active/disabled/stopped">Extensions active/disabled/stopped</h4><div class="text"> <p> -The extensions <b class="code">active</b>, <b class="code">disabled</b>, and <b class="code">stopped</b> +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. -<div class="example"><pre> - # Stop forwarding only for member1 of loadbalancer - /myapp=myloadbalancer;stopped=member1 -</pre></div> +<div class="codeBox"><pre><code># Stop forwarding only for member1 of loadbalancer +/myapp=myloadbalancer;stopped=member1 +</code></pre></div> Multiple members must be separated by commas or white space: -<div class="example"><pre> - # Stop forwarding for member01 and member02 of loadbalancer - # Disable forwarding for member21 and member22 of loadbalancer - /myapp=myloadbalancer;stopped=member01,member02;disabled=member21,member22 -</pre></div> +<div class="codeBox"><pre><code># Stop forwarding for member01 and member02 of loadbalancer +# Disable forwarding for member21 and member22 of loadbalancer +/myapp=myloadbalancer;stopped=member01,member02;disabled=member21,member22 +</code></pre></div> For the precise meaning of the activation states see the description of <a href="../reference/workers.html#Advanced Worker Directives">activation</a>. </p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Extension fail_on_status"><strong>Extension fail_on_status</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +<div class="subsection"><h4 id="Extension_fail_on_status">Extension fail_on_status</h4><div class="text"> <p> -The extension <b class="code">fail_on_status</b> can be used in any rule: -<div class="example"><pre> - # 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 -</pre></div> +The extension <code>fail_on_status</code> can be used in any rule: +<div class="codeBox"><pre><code># 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 +</code></pre></div> 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> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Extension use_server_errors"><strong>Extension use_server_errors</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +<div class="subsection"><h4 id="Extension_use_server_errors">Extension use_server_errors</h4><div class="text"> <p> -The extension <b class="code">use_server_errors</b> allows to let the web server +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 <b class="code">use_server_errors</b> is a positive number. +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 <b class="code">use_server_errors</b>, will +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. -<div class="example"><pre> - # 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 -</pre></div> +<div class="codeBox"><pre><code># 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 +</code></pre></div> </p> -</blockquote></td></tr></table> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Extensions controlling load balancer stickyness"><strong>Extensions controlling load balancer stickyness</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +<div class="subsection"><h4 id="Extensions_controlling_load_balancer_stickyness">Extensions controlling load balancer stickyness</h4><div class="text"> <p> The extensions <ul> -<li><b class="code">session_cookie</b></li> -<li><b class="code">session_path</b></li> -<li><b class="code">set_session_cookie</b></li> -<li><b class="code">session_cookie_path</b></li> +<li><code>session_cookie</code></li> +<li><code>session_path</code></li> +<li><code>set_session_cookie</code></li> +<li><code>session_cookie_path</code></li> </ul> allow to define the load balancer worker attributes of the same name per mount. See their descriptions in the <a href="../reference/workers.html">worker.properties configuration reference</a>. </p> -</blockquote></td></tr></table> -</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Virtual host integration"><strong>Virtual host integration</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +</div><h3 id="Virtual_host_integration">Virtual host integration</h3><div class="text"> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="ISAPI redirector for Microsoft IIS"><strong>ISAPI redirector for Microsoft IIS</strong></a></font></td></tr><tr><td><blockquote> -<br> +<div class="subsection"><h4 id="ISAPI_redirector_for_Microsoft_IIS">ISAPI redirector for Microsoft IIS</h4><div class="text"> <p> When using the ISAPI redirector for Microsoft 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. -<div class="example"><pre> - # 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 -</pre></div> +<div class="codeBox"><pre><code># 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 +</code></pre></div> </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 -<div class="example"><pre> - # 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 -</pre></div> +<div class="codeBox"><pre><code># 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 +</code></pre></div> </p> -</blockquote></td></tr></table> +</div></div> -<table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="mod_jk for Apache HTTP Server"><strong>mod_jk for Apache HTTP Server</strong></a></font></td></tr><tr><td><blockquote> -<br> +<div class="subsection"><h4 id="mod_jk_for_Apache_HTTP_Server">mod_jk for Apache HTTP Server</h4><div class="text"> <p> For the Apache HTTP Server you can define individual uriworkermap files per virtual host. The directive JkMountFile can be used in the main server and in each virtual host. @@ -359,9 +352,8 @@ If a virtual host does not use JkMountfi 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> -</blockquote></td></tr></table> -</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Dynamic reloading"><strong>Dynamic reloading</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div></div> +</div><h3 id="Dynamic_reloading">Dynamic reloading</h3><div class="text"> <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, @@ -384,8 +376,7 @@ the full contents of the uriworkermap fi 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> -</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Status worker integration"><strong>Status worker integration</strong></a></font></td></tr><tr><td><blockquote> -<br> +</div><h3 id="Status_worker_integration">Status worker integration</h3><div class="text"> <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. @@ -427,6 +418,18 @@ and the source of the rule definition: ' </li> </ul> </p> -</blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em> - Copyright © 1999-2018, Apache Software Foundation - </em></font></div></td></tr></table></body></html> \ No newline at end of file +</div><div class="noprint"><h3 id="comments_section"> + Comments + </h3><div class="text"><p class="notice"><strong>Notice:</strong> This comments section collects your suggestions + on improving documentation for Apache Tomcat.<br><br> + If you have trouble and need help, read + <a href="https://tomcat.apache.org/findhelp.html";>Find Help</a> page + and ask your question on the tomcat-users + <a href="https://tomcat.apache.org/lists.html";>mailing list</a>. + Do not ask such questions here. This is not a Q&A section.<br><br> + The Apache Comments System is explained <a href="../comments.html">here</a>. + Comments may be removed by our moderators if they are either + implemented or considered invalid/off-topic. + </p><div id="comments_thread"></div></div></div></div></div></div></div><footer><div id="footer"> + Copyright © 1999-yyyy, The Apache Software Foundation + </div></footer></div></body></html> \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org
![http://www.apache.org/images/asf-logo.gif"](http://www.apache.org/images/asf-logo.gif"){kind=link}