undeploy
- Copy Page Tree
- Emily Simon
- Brian Draheim (Unlicensed)
Undeploys a web application (WAR) from a running Tomcat server.
Environment/Instance Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
| Tomcat Catalina Home |
| Yes | The CATALINA_HOME directory for the Tomcat installation. |
| Tomcat Catalina Base | FDTOM_CATALINA_BASE | No | The CATALINA_BASE directory for the Tomcat server for Instance specific information like conf, bin, webapps etc. Defaults to Tomcat Catalina Home. |
| Tomcat Manager URL |
| No | The url of the Manager web application within the Tomcat server. In Tomcat 6, the manager url is likely http://localhost:8080/manager. In Tomcat 7+, the manager url is likely http://localhost:8080/manager/text. |
| Tomcat Username |
| No | The name of the Tomcat user with which to connect to the Manager web application. This user must be configured with the manager-script role. |
| Tomcat Password |
| No | The password for the |
Project Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
| Tomcat Context Root |
| Yes | The context root to configure for the web application being deployed. |
| Tomcat War Name | FDTOM_WAR_NAME | Yes | The name of the web application archive in the artifacts directory (e.g. sample.war) or directory containing the unpacked war contents. If a relative path is provided, it is assumed relative to the Host appBase directory. |
Inputs
Input Name | Input Code | Required | Description |
|---|---|---|---|
Outputs
Output Name | Required | Description |
|---|---|---|
Artifacts
This operation doesn't consume or produce any artifacts.
Endpoint Selection
This operation will select all available endpoints associated to the Environment/Instance.
@Since 5.1.0.1 This operation delegates the selection to the workflow developer to determine.
Endpoint Execution
This operation will randomly execute on one of the endpoint identified during selection.
@Since 5.1.0.1 This operation delegates the execution to the workflow developer to determine.
Special Considerations
This plugin has the following pre-requisites:
- The
JAVA_HOMEenvironment variable must be set to a supported JDK for the version of Tomcat being used. - The Tomcat user specified by property
FDTOM_USERNAMEmust be granted the manager (Tomcat 6.0.x) or manager-script (Tomcat 7+) role. - The target Tomcat server must be running prior to calling this operation.
The undeploy operation will exit without failure if the application specified by FDTOM_CONTEXT_ROOT is not installed.
- style