Package org.apache.catalina.ant

This package contains a set of Task implementations for Ant (version 1.4 or later) that can be used to interact with the Manager application to install, reload, and remove web applications from a running instance of Tomcat.

See:
          Description

Class Summary
AbstractCatalinaTask Abstract base class for Ant tasks that interact with the Manager web application for dynamically deploying and undeploying applications.
DeployTask Ant task that implements the /deploy command, supported by the Tomcat manager application.
InstallTask Ant task that implements the /install command, supported by the Tomcat manager application.
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.
RemoveTask Ant task that implements the /remove command, supported by the Tomcat manager application.
ResourcesTask Ant task that implements the /resources command, supported by the Tomcat manager application.
RolesTask Ant task that implements the /roles 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.
UndeployTask Ant task that implements the /undeploy command, supported by the Tomcat manager application.
 

Package org.apache.catalina.ant Description

This package contains a set of Task implementations for Ant (version 1.4 or later) that can be used to interact with the Manager application to install, reload, and remove web applications from a running instance of Tomcat. For more information, see http://jakarta.apache.org/tomcat/tomcat-4.0-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:

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 (which corresponds to a standard installation of Tomcat 4).
username The username of a Tomcat user that has been configured with the manager 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 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.



Copyright 2000-2002 Apache Software Foundation. All Rights Reserved.