undeploy

Undeploys a web application (WAR) from a running Tomcat server.

Environment/Instance Properties

Property Name

Property Code

Required

Description

Tomcat Catalina Home

FDTOM_CATALINA_HOME

Yes

The CATALINA_HOME directory for the Tomcat installation.

Tomcat Catalina BaseFDTOM_CATALINA_BASENoThe CATALINA_BASE directory for the Tomcat server for Instance specific information like conf, bin, webapps etc. Defaults to Tomcat Catalina Home.
Tomcat Manager URL

FDTOM_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

FDTOM_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

FDTOM_PASSWORD

No

The password for the FDTOM_USERNAME user.

Project Properties

Property Name

Property Code

Required

Description

Tomcat Context Root

FDTOM_CONTEXT_ROOT

Yes

The context root to configure for the web application being deployed.

Tomcat War NameFDTOM_WAR_NAMENoThe name of the web application archive in the artifacts directory (e.g. sample.war). If a relative path is provided, it is assumed relative to the Host appBase directory. If not provided, then it will search for a single war file in the artifacts 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 delegates the selection to the workflow developer to determine.

Endpoint Execution

This operation delegates the execution to the workflow developer to determine.

Special Considerations

This plugin has the following pre-requisites:

  • The JAVA_HOME environment variable must be set to a supported JDK for the version of Tomcat being used.
  • The Tomcat user specified by property FDTOM_USERNAME must 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.

The following macros are not currently supported in the footer:
  • style