rubbos/app/tomcat-connectors-1.2.32-src/docs/reference/status.html

   1 <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>The Apache Tomcat Connector - Reference Guide - Status Worker Reference</title><meta name="author" value="Rainer Jung"><meta name="email" value="rjung@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 Logo" 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 href="../index.html">Docs Home</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</a></li><li><a href="../reference/iis.html">IIS</a></li></ul><p><strong>Generic HowTo</strong></p><ul><li><a href="../generic_howto/quick.html">For the impatient</a></li><li><a href="../generic_howto/workers.html">All about workers</a></li><li><a href="../generic_howto/timeouts.html">Timeouts</a></li><li><a href="../generic_howto/loadbalancers.html">Load Balancing</a></li><li><a href="../generic_howto/proxy.html">Reverse Proxy</a></li></ul><p><strong>Webserver HowTo</strong></p><ul><li><a href="../webserver_howto/apache.html">Apache HTTP Server</a></li><li><a href="../webserver_howto/iis.html">IIS</a></li><li><a href="../webserver_howto/nes.html">Netscape/SunOne/Sun</a></li></ul><p><strong>AJP Protocol Reference</strong></p><ul><li><a href="../ajp/ajpv13a.html">AJPv13</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&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;product=Tomcat+Connectors&amp;long_desc_type=substring&amp;long_desc=&amp;bug_file_loc_type=allwordssubstr&amp;bug_file_loc=&amp;keywords_type=allwords&amp;keywords=&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;emailassigned_to1=1&amp;emailtype1=substring&amp;email1=&amp;emailassigned_to2=1&amp;emailreporter2=1&amp;emailcc2=1&amp;emailtype2=substring&amp;email2=&amp;bugidtype=include&amp;bug_id=&amp;votes=&amp;chfieldfrom=&amp;chfieldto=Now&amp;chfieldvalue=&amp;cmdtype=doit&amp;order=Reuse+same+sort+as+last+time&amp;field0-0-0=noop&amp;type0-0-0=noop&amp;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/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 Connector - 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
   2                     </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>
   3 <br>
   4 <p>
   5 Tomcat Connectors has a special type of worker, the so-called status worker.
   6 The status worker does not forward requests to Tomcat instances. Instead it allows
   7 to retrieve status and configuration information at runtime,
   8 and furthermore to change many configuration items dynamically. This can be done
   9 via a simple embedded web interface.
  10 </p>
  11 <p>
  12 The status worker is especially powerful, when used together with load balancing workers.
  13 </p>
  14 <p>
  15 This document does not explain the HTML user interface of the status worker.
  16 Until now it is very simple, so just go ahead and use it. This doc instead
  17 tries to explain the less obvious features of the status worker. We also will give a
  18 complete coverage of the various request parameters and their meaning, so that you can
  19 include the status worker in your automation scripts.
  20 </p>
  21 <p>
  22 The documentation of the status worker starts with <b>jk 1.2.20</b>
  23 </p>
  24 </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>
  25 <br>
  26 <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>
  27 <br>
  28 <p>
  29 The status worker knows about six actions.
  30 <ul>
  31 <li>
  32 <b>list</b>: lists the configurations and runtime information of all configured workers.
  33 The output will be grouped by global information first (version data), then load balancer
  34 information, after that AJP worker information and finally the legend. For load balancers,
  35 there will be a summary part, and after that details for each member worker. For all workers,
  36 we also include the URL mappings (forward definitions).
  37 </li>
  38 <li>
  39 <b>show</b>: the same as list, but only shows data for one chosen worker
  40 </li>
  41 <li>
  42 <b>edit</b>: produces a form to edit configuration data for a chosen worker. There is a
  43 special subtype of "edit", that makes it easy to change one attribute for all members of
  44 a load balancer, e.g. their activation state.
  45 </li>
  46 <li>
  47 <b>update</b>: commit changes made in an edit form. <b>Caution</b>: the changes will not be
  48 persisted to the configuration files. As soon as your restart your web server, all changes
  49 made through the status worker will be lost! On the other hand, the changes done by the status
  50 worker will be applied during runtime without a restart of the web server.
  51 </li>
  52 <li>
  53 <b>reset</b>: reset all runtime statistics for a worker.
  54 </li>
  55 <li>
  56 <b>recover</b>: Mark a member of a load balancer, that is in error state, for immediate recovery.
  57 </li>
  58 <li>
  59 <b>version</b>: only show version information of the web server and the JK software
  60 </li>
  61 <li>
  62 <b>dump</b>: list the original workers configuration. <b>Caution</b>: the dump will only contain
  63 the configuration that was used during startup. Any changes applied later by the dynamic management
  64 interface of the status worker itself will not be contained in this dump.
  65 The dump action has been added in version 1.2.27.
  66 </li>
  67 </ul>
  68 </p>
  69 </blockquote></td></tr></table>
  70
  71 <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>
  72 <br>
  73 <p>
  74 For most actions you can choose between 4 output formats.
  75 <ul>
  76 <li>
  77 <b>HTML</b>: Used interactively with a browser
  78 </li>
  79 <li>
  80 <b>XML</b>: Mostly useful for automation, when your scripting environment is XML friendly.
  81 This format has rich structure information, but does not work line based, so you would really
  82 like to use it together with XML tools.
  83 </li>
  84 <li>
  85 <b>Properties</b>: This format is a line based format, that conforms to the rules of Java
  86 property files. Most structure information is contained in the hierarchical key. For information,
  87 that is of configuration nature, the format should produce lines very similar to the ones you can
  88 use in workers.properties. It will not produce a complete configuration file!
  89 </li>
  90 <li>
  91 <b>Text</b>: A simple textual output format.
  92 </li>
  93 </ul>
  94 The "edit" action does only make sense for the HTML output type.
  95 </p>
  96 </blockquote></td></tr></table>
  97
  98 <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>
  99 <br>
 100 <p>
 101 In the HTML view, there is an <b>automatic refresh</b> feature, implemented via the meta refresh
 102 option of HTML. Once you start the automatic refresh, the UI will will respect it for all actions
 103 except edit, update and maintain. Even if you navigate through one of those, the automatic refresh
 104 will start again as soon as you come back to one of the other actions.
 105 </p>
 106 <p>
 107 Many parts of the HTML page can be minimised, if they are not interesting for you. There are a couple
 108 of "Hide" links, which will collapse parts of the information. The feature exists for the following
 109 blocks of information:
 110 <ul>
 111 <li>
 112 <b>Legend</b>: Do not show the legend for the information presented in "list" and "show" actions
 113 </li>
 114 <li>
 115 <b>URI mappings</b>: Do not show the URI mapping for the workers
 116 </li>
 117 <li>
 118 <b>Load Balancing Workers</b>: Do not show workers of type "lb"
 119 </li>
 120 <li>
 121 <b>AJP Workers</b>: Do not show workers of type ajp
 122 </li>
 123 <li>
 124 <b>Balancer Members</b>: Do not show detailed information concerning each member of load balancers
 125 </li>
 126 <li>
 127 <b>Load Balancer Configuration</b>: Do not show configuration data for load balancers
 128 </li>
 129 <li>
 130 <b>Load Balancer Summary</b>: Do not show status summary for load balancers
 131 </li>
 132 <li>
 133 <b>AJP Configuration</b>: Do not show configuration data for ajp workers load balancer members
 134 </li>
 135 </ul>
 136 The last three minimisation features have been added in version 1.2.27.
 137 </p>
 138 </blockquote></td></tr></table>
 139
 140 <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>
 141 <br>
 142 <p>
 143 <b>Note: </b>The following restriction has been removed starting with version 1.2.26.
 144 </p>
 145 <p>
 146 The Apache module mod_jk makes use of the internal Apache httpd infrastructure concerning
 147 virtual hosts. The downside of this is, that the status worker can only show URL maps, for
 148 the virtual host it is defined in. It is not able to reach the configuration objects
 149 for other virtual hosts. Of course you can define a status worker in any virtual host you
 150 are using. All information presented apart from the URL maps will be the same, independent
 151 of the virtual host the status worker has been called in.
 152 </p>
 153 </blockquote></td></tr></table>
 154
 155 <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>
 156 <br>
 157 <p>
 158 The status worker will log changes made to the configuration with log level "info" to the usual
 159 JK log file. Invalid requests will be logged with log level "warn". If you want to report some
 160 broken behaviour, log file content of level "debug" or even "trace" will be useful.
 161 </p>
 162 </blockquote></td></tr></table>
 163
 164 </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>
 165 <br>
 166 <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>
 167 <br>
 168 <p>
 169 The basic configuration of a status worker is very similar to that of a usual ajp worker.
 170 You need to specify a name for the worker, and the URLs you want to map to it. The first
 171 part of the configuration happens in the workers.properties file. We define a worker named
 172 mystatus of type status:
 173 <div class="example"><pre>
 174 worker.list=mystatus
 175 worker.mystatus.type=status
 176 </pre></div>
 177 Then we define a URL, which should be mapped to this worker, i.e. the URL we use
 178 to reach the functionality of the status worker. You can use any method mod_jk supports
 179 for the web server of your choice. Possibilities are maps inside uriworkermap.properties,
 180 an additional mount attribute in workers.properties, or in Apache JkMount. Here's an
 181 example for a uriworkermap.properties line:
 182 <div class="example"><pre>
 183 /private/admin/mystatus=mystatus
 184 </pre></div>
 185 The URI pattern is case sensitive.
 186 </p>
 187 <p>
 188 As you will learn in the following sections, the status worker is very powerful. You should
 189 use the usual authentication and authorisation methods of your web server to secure this URL.
 190 </p>
 191 <p>
 192 You can also define multiple instances of the status worker, by using different names and URL mappings.
 193 For instance you might want to configure them individually
 194 and then allow special groups of people to use them
 195 </p>
 196 </blockquote></td></tr></table>
 197
 198 <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>
 199 <br>
 200 <p>
 201 There are a couple of attributes for the workers.properties entries, which allow to customise
 202 various aspects of the output of the status worker.
 203 </p>
 204 <p>
 205 The attribute <b>css</b> can be set to the URL of a stylesheet:
 206 <div class="example"><pre>
 207 worker.mystatus.css=/private/admin/static/mystatus.css
 208 </pre></div>
 209 When writing HTML output, the status worker then includes the line
 210 <div class="example"><pre>
 211 &lt;link rel="stylesheet" type="text/css" href="/private/admin/static/mystatus.css" /&gt;
 212 </pre></div>
 213 There is no sample stylesheet included with the mod_jk release, and by default the attribute css
 214 is empty, so no stylesheet reference will be included in the pages. The HTML code
 215 of the status worker output pages does not include any class attributes. If you like to contribute a
 216 stylesheet or improvements to the HTML layout, please contact us on the tomcat developers list.
 217 </p>
 218 <p>
 219 The properties output format can be customised via the attribute <b>prefix</b>. The names of all
 220 properties the status worker does output, will begin with this prefix. The default is "worker".
 221 </p>
 222 <p>
 223 Several attributes influence the format when writing XML output.
 224 The attribute <b>ns</b> allows to set a namespace prefix, that will be used for every status worker+element.
 225 The default is "jk:". Setting it to "-" disables the namespace prefix.
 226 </p>
 227 <p>
 228 With the attribute xmlns you can map the prefix to a namespace URL. The default value
 229 is xmlns:jk="http://tomcat.apache.org". Setting it to "-" disables the output of the URL.
 230 </p>
 231 <p>
 232 Finally you can specify an XML document type via the attribute doctype. The specified string will
 233 be inserted at the beginning of the document, directly after the xml header. The default is empty.
 234 </p>
 235 </blockquote></td></tr></table>
 236
 237 <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>
 238 <br>
 239 <p>
 240 We urge you to use the builtin access control features of your web server to control
 241 access to the status worker URLs you have chosen. Nevertheless two configuration
 242 attributes of status workers are helpful. The attribute "read_only" disables all features of
 243 the status worker, that can be used to change configurations or runtime status of the other workers.
 244 A read_only status worker will not allow access to the edit, update, reset or recover actions.
 245 The default value is "False", ie. read/write. To enable read_only you need to set it to "True".
 246 </p>
 247 <p>
 248 You could configure two status workers, one has read_only and will be made available to a larger
 249 admin group, the other one will be used fully featured, but only by fewer people:
 250 <div class="example"><pre>
 251 worker.list=jk-watch
 252 worker.jk-watch.type=status
 253 worker.jk-watch.read_only=True
 254 worker.jk-watch.mount=/user/status/jk
 255 worker.list=jk-manage
 256 worker.jk-manage.type=status
 257 worker.jk-manage.mount=/admin/status/jk
 258 </pre></div>
 259 Starting with version 1.2.21, a read/write status worker can also be switched temporarily
 260 into read-only mode by the user via a link in the HTML GUI. The user can always switch it
 261 back to read/write. Only a status worker configured as read-only via the "read_only" attribute
 262 is completely safe from applying any changes.
 263 </p>
 264 <p>
 265 The other attribute you can use is <b>user</b>. By default this list is empty, which means
 266 no limit on the users. You can set "user" to a comma separated list of user names. If your
 267 web server is configured such that it sends the user names with the request, the status worker
 268 will check, if the name attached with the request is contained in it's "user" list.
 269 </p>
 270 <p>
 271 The user list can be split over multiple occurrences of the "user" attribute.
 272 </p>
 273 <p>
 274 By default, the user names are matched case sensitively. Starting with version 1.2.21 you can set
 275 the attribute <b>user_case_insensitive</b> to "True". Then the comparison will be made case insensitive.
 276 </p>
 277 </blockquote></td></tr></table>
 278
 279 <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>
 280 <br>
 281 <p>
 282 For load balancing workers the status worker shows some interesting overview information.
 283 It categorises the members of the load balancer into the classes "good", "bad" and degraded".
 284 This feature can be combined with external escalation procedures. Depending on your global
 285 system design and your operating practises your preferred categorisation might vary.
 286 </p>
 287 <p>
 288 The categorisation is based on the activation state of the workers (active, disabled or stopped),
 289 which is a pure configuration state, and the runtime state
 290 (OK or ERR with possible substates idle, busy, recovering, probing, and forced recovery)
 291 which only depends on the runtime situation.
 292 </p>
 293 <p>
 294 The runtime substates have the following meaning:
 295 <ul>
 296 <li>
 297 <b>OK (idle)</b>: This worker didn't receive any request since the last balancer
 298 maintenance. By default balancer maintenance runs every 60 seconds. The
 299 worker should be OK, but since we didn't have to use it for some time, we
 300 can't be sure. This state has been called N/A before version 1.2.24.
 301 </li>
 302 <li>
 303 <b>OK (busy)</b>: All connections for this worker are in use for requests.
 304 </li>
 305 <li>
 306 <b>ERROR (recovering)</b>: The worker was in error state for some time and is now
 307 marked for recovery. The next request suitable for this worker will use it.
 308 </li>
 309 <li>
 310 <b>ERROR (probing)</b>: After setting the worker to recovering, we received a request
 311 suitable for this worker. This request is now using the worker.
 312 </li>
 313 <li>
 314 <b>ERROR (forced recovery)</b>: The worker is in error, but we don't have an alternative
 315 worker, so we keep using it.
 316 </li>
 317 </ul>
 318 </p>
 319 <p>
 320 By default the status worker groups into "good" all members, that have activation "active" and
 321 runtime state not equal to "error" with empty substate.
 322 The "bad" group consists of the members, that have either activation
 323 "stopped", or are in runtime state "error" with empty substate.
 324 </p>
 325 <p>
 326 Workers that fit neither of the two groups, are considered to be "degraded".
 327 </p>
 328 <p>
 329 You can define other rules for the grouping into good, bad and degraded.
 330 The two attributes "good" and "bad" can be populated by a comma-separated list ob single characters or
 331 dot-separated pairs. Each character stands for the first character of one of the possible states "active",
 332 "disabled", "stopped", "ok", "idle", "busy", "recovering" and "error". The additional states "probing"
 333 and "forced recovery" are always rated equivalent to "recovering".
 334 Comma-separated entries will be combined
 335 with logical "or", if you combine a configuration and a runtime state with a dot. the are combined with logical
 336 "and". So the default value for "good" is "a.o,a.i,a.b,a.r", for "bad" it is "e,s".
 337 </p>
 338 <p>
 339 The status worker first tries to match against the "bad" definitions, if this doesn't succeed
 340 it tries to match against "good", and finally it chooses "degraded", if no "bad" or "good" match
 341 can be found.
 342 </p>
 343 </blockquote></td></tr></table>
 344 </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>
 345 <br>
 346 <p>
 347 This section should help you building automation scripts based on the jk status
 348 management interface. This interface is stable in the sense, that we only expect
 349 to add further parameters in the future. Existing parameters from previous versions
 350 will keep their original semantics. We also expect the output formats XML, Properties
 351 and Text to be kept stable. So please use those, if you want to parse status worker
 352 output in your automation scripts.
 353 </p>
 354 <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>
 355 <br>
 356 <p>
 357 The action is determined by the parameter <b>cmd</b>. It can have the values "list", "show",
 358 "edit", "update", "reset", "recover", "version" and "dump". If you omit the <b>cmd</b> parameter,
 359 the default "list" will be used.
 360 All actions except for "list", "refresh", "version" and "dump" need additional parameters.
 361 </p>
 362 <p>
 363 The action "dump" has been added in version 1.2.27.
 364 </p>
 365 </blockquote></td></tr></table>
 366 <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>
 367 <br>
 368 <p>
 369 The format is determined by the parameter <b>mime</b>. It can have the values "html", "xml",
 370 "txt" and "prop". If you omit the <b>mime</b> parameter, the default "html"
 371 will be used. The action "edit" (the edit form) does only make sense for "mime=html".
 372 </p>
 373 </blockquote></td></tr></table>
 374 <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>
 375 <br>
 376 <p>
 377 Actions that operate on a single worker need one or two additional parameters to select
 378 this worker. The parameter <b>w</b> contains the name of the worker from the worker list.
 379 If an action operates on a member (sub worker) of a load balancer, the parameter <b>w</b>
 380 contains the name of the load balancer worker, and the additional parameter <b>sw</b> contains the
 381 name of the sub worker.
 382 </p>
 383 </blockquote></td></tr></table>
 384 <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>
 385 <br>
 386 <p>
 387 During automatic refresh, the parameter <b>re</b> contain the refresh interval in seconds.
 388 If you omit this parameter, automatic refresh will be off.
 389 </p>
 390 </blockquote></td></tr></table>
 391 <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>
 392 <br>
 393 <p>
 394 The parameter <b>opt</b> contains a bit mask of activated options. The default is 0, so
 395 by default no options are activated. The following options exist:
 396 <ul>
 397 <li>
 398 <b>0x0001</b>: hide members of lb workers
 399 </li>
 400 <li>
 401 <b>0x0002</b>: hide URL maps
 402 </li>
 403 <li>
 404 <b>0x0004</b>: hide the legend
 405 </li>
 406 <li>
 407 <b>0x0008</b>: hide load balancer workers
 408 </li>
 409 <li>
 410 <b>0x0010</b>: hide ajp workers
 411 </li>
 412 <li>
 413 <b>0x0020</b>: only allow read_only actions for a read/write status worker.
 414 </li>
 415 <li>
 416 <b>0x0040</b>: hide load balancer configuration
 417 </li>
 418 <li>
 419 <b>0x0080</b>: hide load balancer status summary
 420 </li>
 421 <li>
 422 <b>0x0100</b>: hide configuration for ajp and load balancer member workers
 423 </li>
 424 </ul>
 425 Values 0x0040-0x0100 have been added in version 1.2.27.
 426 </p>
 427 </blockquote></td></tr></table>
 428 <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>
 429 <br>
 430 <p>
 431 You can use the edit action with a final click to the update button, to change settings of workers.
 432 But you can also make direct calls to the update action. The following request parameters
 433 contain the configuration information, you want to change. First the list for load balancer workers:
 434 <ul>
 435 <li>
 436 <b>vlr</b>: retries (number)
 437 </li>
 438 <li>
 439 <b>vlt</b>: recover_time (seconds)
 440 </li>
 441 <li>
 442 <b>vlee</b>: error_escalation_time (seconds)
 443 </li>
 444 <li>
 445 <b>vlx</b>: max_reply_timeouts (number)
 446 </li>
 447 <li>
 448 <b>vls</b>: sticky_session (0/f/n/off=off, 1/t/y/on=on; case insensitive)
 449 </li>
 450 <li>
 451 <b>vlf</b>: sticky_session_force (0/f/n/off=off, 1/t/y/on=on; case insensitive)
 452 </li>
 453 <li>
 454 <b>vlm</b>: method (0/r="Requests", 1/t="Traffic", 2/b="Busyness", 3/s="Sessions"; case insensitive, only first character is used)
 455 </li>
 456 <li>
 457 <b>vll</b>: lock (0/o="Optimistic", 1/p="Pessimistic"; case insensitive, only first character is used)
 458 </li>
 459 </ul>
 460 And now the list of parameters you can use to change settings for load balancer members:
 461 <ul>
 462 <li>
 463 <b>vwa</b>: activation flag (0/a="active", 1/d="disabled", 2/s="stopped"; case insensitive, only first character is used)
 464 </li>
 465 <li>
 466 <b>vwf</b>: load balancing factor (integer weight)
 467 </li>
 468 <li>
 469 <b>vwn</b>: route for use with sticky sessions (string)
 470 </li>
 471 <li>
 472 <b>vwr</b>: redirect to define simple failover rules (string)
 473 </li>
 474 <li>
 475 <b>vwc</b>: domain to tell JK about your replication design (string)
 476 </li>
 477 <li>
 478 <b>vwd</b>: distance to express preferences (integer)
 479 </li>
 480 </ul>
 481 Finally the list of parameters you can use to change settings for ajp workers and ajp load balancer members:
 482 <ul>
 483 <li>
 484 <b>vahst</b>: host (string)
 485 </li>
 486 <li>
 487 <b>vaprt</b>: port (number)
 488 </li>
 489 <li>
 490 <b>vacpt</b>: connection_pool_timeout (number)
 491 </li>
 492 <li>
 493 <b>vact</b>: connect_timeout (number)
 494 </li>
 495 <li>
 496 <b>vapt</b>: prepost_timeout (number)
 497 </li>
 498 <li>
 499 <b>vart</b>: reply_timeout (number)
 500 </li>
 501 <li>
 502 <b>var</b>: retries (number)
 503 </li>
 504 <li>
 505 <b>varo</b>: recovery_options (number)
 506 </li>
 507 <li>
 508 <b>vamps</b>: max_packet_size (number)
 509 </li>
 510 </ul>
 511 Note that changing the host name or port will only take effect for new connections.
 512 Already established connections to the old address will still be used.
 513 Nevertheless this feature is interesting, because you can provision load balancer
 514 members with port "0", which will automatically be stopped during startup. Later
 515 when you know the final names and ports, you can set them and they will be
 516 automatically activated.
 517 </p>
 518 <p>
 519 The leading character "v" has been added to the parameters in version 1.2.27.
 520 Changing settings for ajp workers has also been introduced in version 1.2.27.
 521 </p>
 522 <p>
 523 For the details of all parameters, we refer to the <a href="workers.html">workers.properties Reference</a>.
 524 </p>
 525 </blockquote></td></tr></table>
 526 <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>
 527 <br>
 528 <p>
 529 You can use the edit action to edit all settings for a load balancer or for a
 530 member of a load balancer respectively on one page. If you want to edit one
 531 configuration aspect for all members of a load balancer simultaneously, this
 532 will be triggered by the parameter <b>att</b>. The value of the parameter indicates,
 533 which aspect you want to edit. The list is the same as in the previous section,
 534 except for "vahst" and "vaprt":
 535 "vwa", "vwf", "vwn", "vwr", "vwc", "vwd", "vacpt", "vact", "vapt", "vart", "var",
 536 "varo" and "vamps". But here you
 537 need to put the name into the parameter <b>att</b>, instead of using it as a request
 538 parameter name.
 539 </p>
 540 <p>
 541 The values of the common aspect for all the load balancer members will be given
 542 in parameters named "val0", "val1", ....
 543 </p>
 544 </blockquote></td></tr></table>
 545 </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>
 546         Copyright &copy; 1999-2011, Apache Software Foundation
 547         </em></font></div></td></tr></table></body></html>