Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 771 | blopes | 1 | <!DOCTYPE html SYSTEM "about:legacy-compat"> |
| 2 | <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>Apache Tomcat 9 Configuration Reference (9.0.112) - The Cluster Deployer object</title></head><body><div id="wrapper"><header><div id="header"><div><div><div class="logo noPrint"><a href="https://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>Apache Tomcat 9 Configuration Reference</h1><div class="versionInfo"> |
||
| 3 | Version 9.0.112, |
||
| 4 | <time datetime="2025-11-06">Nov 6 2025</time></div><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><li><a href="index.html">Config Ref. Home</a></li><li><a href="https://cwiki.apache.org/confluence/display/TOMCAT/FAQ">FAQ</a></li><li><a href="#comments_section">User Comments</a></li></ul></div><div><h2>Top Level Elements</h2><ul><li><a href="server.html">Server</a></li><li><a href="service.html">Service</a></li></ul></div><div><h2>Executors</h2><ul><li><a href="executor.html">Executor</a></li></ul></div><div><h2>Connectors</h2><ul><li><a href="http.html">HTTP/1.1</a></li><li><a href="http2.html">HTTP/2</a></li><li><a href="ajp.html">AJP</a></li></ul></div><div><h2>Containers</h2><ul><li><a href="context.html">Context</a></li><li><a href="engine.html">Engine</a></li><li><a href="host.html">Host</a></li><li><a href="cluster.html">Cluster</a></li></ul></div><div><h2>Nested Components</h2><ul><li><a href="cookie-processor.html">CookieProcessor</a></li><li><a href="credentialhandler.html">CredentialHandler</a></li><li><a href="globalresources.html">Global Resources</a></li><li><a href="jar-scanner.html">JarScanner</a></li><li><a href="jar-scan-filter.html">JarScanFilter</a></li><li><a href="listeners.html">Listeners</a></li><li><a href="loader.html">Loader</a></li><li><a href="manager.html">Manager</a></li><li><a href="realm.html">Realm</a></li><li><a href="resources.html">Resources</a></li><li><a href="sessionidgenerator.html">SessionIdGenerator</a></li><li><a href="valve.html">Valve</a></li></ul></div><div><h2>Cluster Elements</h2><ul><li><a href="cluster.html">Cluster</a></li><li><a href="cluster-manager.html">Manager</a></li><li><a href="cluster-channel.html">Channel</a></li><li><a href="cluster-membership.html">Channel/Membership</a></li><li><a href="cluster-sender.html">Channel/Sender</a></li><li><a href="cluster-receiver.html">Channel/Receiver</a></li><li><a href="cluster-interceptor.html">Channel/Interceptor</a></li><li><a href="cluster-valve.html">Valve</a></li><li><a href="cluster-deployer.html">Deployer</a></li><li><a href="cluster-listener.html">ClusterListener</a></li></ul></div><div><h2>web.xml</h2><ul><li><a href="filter.html">Filter</a></li></ul></div><div><h2>Other</h2><ul><li><a href="runtime-attributes.html">Runtime attributes</a></li><li><a href="systemprops.html">System properties</a></li><li><a href="jaspic.html">JASPIC</a></li></ul></div></nav></div></div><div id="mainRight"><div id="content"><h2>The Cluster Deployer object</h2><h3 id="Table_of_Contents">Table of Contents</h3><div class="text"> |
||
| 5 | <ul><li><a href="#Introduction">Introduction</a></li><li><a href="#org.apache.catalina.ha.deploy.FarmWarDeployer">org.apache.catalina.ha.deploy.FarmWarDeployer</a><ol><li><a href="#Attributes">Attributes</a></li></ol></li></ul> |
||
| 6 | </div><h3 id="Introduction">Introduction</h3><div class="text"> |
||
| 7 | <p>The Farm War Deployer can deploy and undeploy web applications on the other |
||
| 8 | nodes in the cluster.</p> |
||
| 9 | <p><strong>Note:</strong> FarmWarDeployer can be configured at host level |
||
| 10 | cluster only. |
||
| 11 | </p> |
||
| 12 | </div><h3 id="org.apache.catalina.ha.deploy.FarmWarDeployer">org.apache.catalina.ha.deploy.FarmWarDeployer</h3><div class="text"> |
||
| 13 | |||
| 14 | <div class="subsection"><h4 id="Attributes">Attributes</h4><div class="text"> |
||
| 15 | |||
| 16 | <table class="defaultTable"><tr><th style="width: 15%;"> |
||
| 17 | Attribute |
||
| 18 | </th><th style="width: 85%;"> |
||
| 19 | Description |
||
| 20 | </th></tr><tr id="org.apache.catalina.ha.deploy.FarmWarDeployer_Attributes_className"><td><strong><code class="attributeName">className</code></strong></td><td> |
||
| 21 | The cluster deployer class, currently only one is available, |
||
| 22 | <code>org.apache.catalina.ha.deploy.FarmWarDeployer.</code> |
||
| 23 | </td></tr><tr id="org.apache.catalina.ha.deploy.FarmWarDeployer_Attributes_deployDir"><td><strong><code class="attributeName">deployDir</code></strong></td><td> |
||
| 24 | Deployment directory. This is the pathname of a directory where deploy |
||
| 25 | the web applications. You may specify an absolute pathname, or a |
||
| 26 | pathname that is relative to the $CATALINA_BASE directory. In the |
||
| 27 | current implementation, this attribute must be the same value as the |
||
| 28 | <strong>Host's appBase</strong>. |
||
| 29 | </td></tr><tr id="org.apache.catalina.ha.deploy.FarmWarDeployer_Attributes_tempDir"><td><strong><code class="attributeName">tempDir</code></strong></td><td> |
||
| 30 | The temporaryDirectory to store binary data when downloading a war from |
||
| 31 | the cluster. You may specify an absolute pathname, or a pathname that is |
||
| 32 | relative to the $CATALINA_BASE directory. |
||
| 33 | </td></tr><tr id="org.apache.catalina.ha.deploy.FarmWarDeployer_Attributes_watchDir"><td><code class="attributeName">watchDir</code></td><td> |
||
| 34 | This is the pathname of a directory where watch for changes(add/modify/remove) |
||
| 35 | of web applications. You may specify an absolute pathname, or a pathname |
||
| 36 | that is relative to the $CATALINA_BASE directory. |
||
| 37 | <strong>Note: </strong> if <strong>watchEnabled</strong> is false, this |
||
| 38 | attribute will have no effect. |
||
| 39 | </td></tr><tr id="org.apache.catalina.ha.deploy.FarmWarDeployer_Attributes_watchEnabled"><td><code class="attributeName">watchEnabled</code></td><td> |
||
| 40 | Set to true if you want to watch for changes of web applications. |
||
| 41 | Only when this attribute set to true, you can trigger a deploy/undeploy |
||
| 42 | of web applications. The flag's value defaults to false. |
||
| 43 | </td></tr><tr id="org.apache.catalina.ha.deploy.FarmWarDeployer_Attributes_processDeployFrequency"><td><code class="attributeName">processDeployFrequency</code></td><td> |
||
| 44 | Frequency of the Farm watchDir check. Cluster wide deployment will be |
||
| 45 | done once for the specified amount of backgroundProcess calls (ie, the |
||
| 46 | lower the amount, the most often the checks will occur). The minimum |
||
| 47 | value is 1, and the default value is 2. |
||
| 48 | <strong>Note: </strong> if <strong>watchEnabled</strong> is false, this |
||
| 49 | attribute will have no effect. |
||
| 50 | </td></tr><tr id="org.apache.catalina.ha.deploy.FarmWarDeployer_Attributes_maxValidTime"><td><code class="attributeName">maxValidTime</code></td><td> |
||
| 51 | FileMessageFactory instances used by the FarmWarDeployer are only |
||
| 52 | retained while they are required. When receiving a WAR file, the |
||
| 53 | associated FileMessageFactory instance is deleted once the WAR file has |
||
| 54 | been fully received. To avoid memory leaks under various error |
||
| 55 | conditions (part of the file never received, very slow message transfer, |
||
| 56 | etc.), this attribute defines the maximum time permitted between |
||
| 57 | receiving valid messages that contain part of the WAR file. If that |
||
| 58 | maximum time is exceeded, the FileMessageFactory will be deleted and the |
||
| 59 | WAR file transfer will fail for that node. If a negative value is |
||
| 60 | specified, the FileMessageFactory will only be removed once the WAR file |
||
| 61 | is fully received. If not specified, the default value of 300 (5 |
||
| 62 | minutes) will be used. |
||
| 63 | </td></tr></table> |
||
| 64 | |||
| 65 | </div></div> |
||
| 66 | |||
| 67 | </div></div></div></div></div><footer><div id="footer"> |
||
| 68 | Copyright © 1999-2025, The Apache Software Foundation |
||
| 69 | <br> |
||
| 70 | Apache Tomcat, Tomcat, Apache, the Apache Tomcat logo and the Apache logo |
||
| 71 | are either registered trademarks or trademarks of the Apache Software |
||
| 72 | Foundation. |
||
| 73 | </div></footer></div></body></html> |