org.apache.catalina.ant (Apache Tomcat 10.1.55 API Documentation)
Description: declaration: package: org.apache.catalina.ant

# Package org.apache.catalina.ant

package org.apache.catalina.ant

This package contains a set of `Task` implementations for Ant (version 1.6.x or later) that can be used to interact with the Manager application to deploy, undeploy, list, reload, start and stop web applications from a running instance of Tomcat. For more information, see https://tomcat.apache.org/tomcat-10.1-doc/manager-howto.html.

The attributes of each task element correspond exactly to the request parameters that are included with an HTTP request sent directly to the Manager application. They are summarized as follows:

Task attributes
Attribute | Description
--- | ---
url | The URL of the Manager web application you will use to perform the requested operations. If not specified, defaults to `http://localhost:8080/manager/text` (which corresponds to a standard installation of Tomcat 7).
username | The username of a Tomcat user that has been configured with the `manager-script` role, as required to execute Manager application commands. This attribute is required.
password | The password of a Tomcat user that has been configured with the `manager-script` role, as required to execute Manager application commands. This attribute is required.
config | A URL pointing at the context configuration file (i.e. a file containing only the `<Context>` element, and its nested elements, from `server.xml` for a particular web application). This attribute is supported only on the `install` target, and is required only if you wish to install an application with non-default configuration characteristics.
path | The context path (including the leading slash) of the web application this command is intended to manage, or a zero-length string for the ROOT web application. This attribute is valid for the `install`, `reload`, `remove`, `start`, and `stop` tasks only, and is required in all of those cases.
war | A `jar:` URL that points at a web application archive (WAR) file, or a `file:` URL that points at an unpacked directory containing the web application. This attribute is supported only on the `install` target. You must specify at least one of the `config` and `war` attributes; if you specify both, the `war` attribute overrides the `docBase` attribute in the context configuration file.

NOTE - Commands executed through the Manager application are NOT reflected in updates to the Tomcat `server.xml` configuration file, so they do not persist past the next time you restart the entire Tomcat container.

- Related Packages
  Package
  Description
  org.apache.catalina
  org.apache.catalina.ant.jmx
  This package contains a set of `JMX Task` implementations for Ant (version 1.6 or later) that can be used to interact with the Remote JMX JSR 160 RMI Adaptor to get/set attributes, invoke MBean operations and query for Mbeans inside a running instance of Tomcat.
- Classes
  Class
  Description
  AbstractCatalinaCommandTask
  Abstract task for Catalina commands.
  AbstractCatalinaTask
  Abstract base class for Ant tasks that interact with the Manager web application for dynamically deploying and undeploying applications.
  BaseRedirectorHelperTask
  Abstract base class to add output redirection support for Catalina Ant tasks.
  DeployTask
  Ant task that implements the `/deploy` command, supported by the Tomcat manager application.
  FindLeaksTask
  Ant task that implements the `/findleaks` command, supported by the Tomcat manager application.
  JKStatusUpdateTask
  Ant task that implements the `/status` command, supported by the mod_jk status (1.2.9) application.
  JMXGetTask
  Ant task that implements the JMX Get command (`/jmxproxy/?`
  JMXQueryTask
  Ant task that implements the JMX Query command (`/jmxproxy/?`
  JMXSetTask
  Ant task that implements the JMX Set command (`/jmxproxy/?`
  ListTask
  Ant task that implements the `/list` command, supported by the Tomcat manager application.
  ReloadTask
  Ant task that implements the `/reload` command, supported by the Tomcat manager application.
  ResourcesTask
  Ant task that implements the `/resources` command, supported by the Tomcat manager application.
  ServerinfoTask
  Ant task that implements the `/serverinfo` command supported by the Tomcat manager application.
  SessionsTask
  Ant task that implements the `/sessions` command supported by the Tomcat manager application.
  SslConnectorCiphersTask
  Ant task that implements the `/sslConnectorCiphers` command supported by the Tomcat manager application.
  StartTask
  Ant task that implements the `/start` command, supported by the Tomcat manager application.
  StopTask
  Ant task that implements the `/stop` command, supported by the Tomcat manager application.
  ThreaddumpTask
  Ant task that implements the `/threaddump` command supported by the Tomcat manager application.
  UndeployTask
  Ant task that implements the `/undeploy` command, supported by the Tomcat manager application.
  ValidatorTask
  Task for validating a web application deployment descriptor, using XML schema validation.
  VminfoTask
  Ant task that implements the `/vminfo` command supported by the Tomcat manager application.