## The Cluster Deployer object

### Table of Contents

- Introduction
- org.apache.catalina.ha.deploy.FarmWarDeployer
  1. Attributes

### Introduction

The Farm War Deployer can deploy and undeploy web applications on the other nodes in the cluster.

Note: FarmWarDeployer can be configured at host level cluster only.

### org.apache.catalina.ha.deploy.FarmWarDeployer

#### Attributes

Attribute | Description
--- | ---
`className` | The cluster deployer class, currently only one is available, `org.apache.catalina.ha.deploy.FarmWarDeployer.`
`deployDir` | Deployment directory. This is the pathname of a directory where deploy the web applications. You may specify an absolute pathname, or a pathname that is relative to the $CATALINA_BASE directory. In the current implementation, this attribute must be the same value as the Host's appBase.
`tempDir` | The temporaryDirectory to store binary data when downloading a war from the cluster. You may specify an absolute pathname, or a pathname that is relative to the $CATALINA_BASE directory.
`watchDir` | This is the pathname of a directory where watch for changes(add/modify/remove) of web applications. You may specify an absolute pathname, or a pathname that is relative to the $CATALINA_BASE directory. Note: if watchEnabled is false, this attribute will have no effect.
`watchEnabled` | Set to true if you want to watch for changes of web applications. Only when this attribute set to true, you can trigger a deploy/undeploy of web applications. The flag's value defaults to false.
`processDeployFrequency` | Frequency of the Farm watchDir check. Cluster wide deployment will be done once for the specified amount of backgroundProcess calls (ie, the lower the amount, the most often the checks will occur). The minimum value is 1, and the default value is 2. Note: if watchEnabled is false, this attribute will have no effect.
`maxValidTime` | The maximum valid time(in seconds) of FileMessageFactory. FileMessageFactory will be removed immediately after receiving the complete WAR file but when failing to receive a FileMessage which was sent dividing, FileMessageFactory will leak without being removed. FileMessageFactory that is leaking will be automatically removed after maxValidTime. If a negative value specified, FileMessageFactory will never be removed. If the attribute is not provided, a default of 300 seconds (5 minutes) is used.