Apache Tomcat is an open-source web server and servlet container that is developed by the Apache Software Foundation (ASF). Tomcat implements the Java Servlet and the JavaServer Pages (JSP) specifications from Oracle Corporation and provides a pure Java HTTP web server environment for Java code to run.
The Apache Tomcat plugin includes steps to deploy web applications to the Apache Tomcat server and remove applications from the server. The plugin also includes steps to start and stop the Apache Tomcat server.
Apache Tomcat is an open source web server and servlet container that the Apache Software Foundation (ASF) developed. Apache Tomcat implements the Java Servlet and the JavaServer Pages (JSP) specifications from Oracle Corporation, and provides a Java HTTP web server environment for Java code to run.
This plugin includes one or more steps, click Steps for step details and properties.
This plug-in requires HCL Launch version 6.0 or later.
This plug-in works with versions of Apache Tomcat 6.0 or later.
This plug-in runs on all operating systems that HCL Launch supports.
The following table describes the changes made in each plugin version.
| Version | Description |
|---|---|
| 8.11 |
|
If you have multiple Tomcat instances, you can specify the instance to use in the Start Tomcat step. The step includes properties for specifying the CATALINA_BASE and CATALINA_HOME variables.
For Tomcat 7 and later, ${p:tomcat.manager.url} needs to contain /text at the end, such as ManagerURL : https://localhost:8080/manager/text. The manager user must also be added to the role manager-script in order to run ant tasks without CSRF denial (403 Errors).
To access this plug-in in the palette, click Application Server > Java > Tomcat.
The following process steps are available in the Apache Tomcat plugin.
Check the status of a deployed application against an expected status.
| Name | Type | Description | Required |
|---|---|---|---|
| Expected Status | Enumeration | The expected status of the application. If the application does not have this status, this step will fail. | Yes |
| Tomcat Application | String | The path of the application to check the status of. This is case-sensitive. For example: /docs | Yes |
| Tomcat Manager Password | Password | The password to use to log in to the Tomcat Manager interface. | Yes |
| Tomcat Manager URL | String | The URL of the Tomcat Manager interface. | Yes |
| Tomcat Manager User Name | String | The user name to use to log in to the Tomcat Manager interface. | Yes |
Deploy a web application to Tomcat.
| Name | Type | Description | Required |
|---|---|---|---|
| Context Name | String | The context that is being deployed. | Yes |
| Context XML path | String | The path of the context configuration file for this application, if any. | No |
| Tomcat Manager Password | Password | The password to use to log in to the Tomcat Manager interface. | Yes |
| Tomcat Manager URL | String | The URL of the Tomcat Manager interface. | Yes |
| Tomcat Manager User Name | String | The user name to use to log in to the Tomcat Manager interface. | Yes |
| War File Path | String | The path to the WAR file to be deployed. | Yes |
Start a web application that is deployed on Tomcat.
| Name | Type | Description | Required |
|---|---|---|---|
| Context Name | String | The context that is being deployed. | Yes |
| Tomcat Manager Password | Password | The password to use to log in to the Tomcat Manager interface. | Yes |
| Tomcat Manager URL | String | The URL of the Tomcat Manager interface. | Yes |
| Tomcat Manager User Name | String | The user name to use to log in to the Tomcat Manager interface. | Yes |
Start Tomcat on the agent machine.
| Name | Type | Description | Required |
|---|---|---|---|
| Catalina Base | String | The path name of the Tomcat instance to be used. Provide a value if you want to overwrite the CATALINA_BASE environment variable or no value is available. | No |
| Catalina Home | String | The path name to the Tomcat installation directory. Provide a value if you want to overwrite the CATALINA_HOME environment variable or no value is available. | No |
| Hostname | String | The host server that the specified Tomcat instance is listening on. If the instance is not listening on localhost, provide the hostname where the host server can be reached when it is running. Use this property only if you are waiting for Tomcat to complete the boot sequence. The default value of localhost is used if no value is specified. | No |
| Java Home | String | The location of the Java installation. Provide a value if you want to overwrite the JAVA_HOME environment variable or no value is available. | No |
| Launcher | String | The location of the Tomcat startup script, for example, /opt/tomcat/bin/startup.sh. |
Yes |
| Options | String | A new line separated list of additional options to pass to the startup script. | No |
| Port | String | The port that the step uses to detect when the Tomcat instance is running. You can specify any of the connector ports that your instance is configured with. | No |
| Startup timeout (in seconds) | String | The value that the step uses to wait for the Tomcat instance to complete the boot process before continuing. You must provide a port value, which is used to detect when the boot process is complete. | No |
Stop a deployed web application on Tomcat.
| Name | Type | Description | Required |
|---|---|---|---|
| Context Name | String | The context that is being stopped. | Yes |
| Tomcat Manager Password | Password | The password to use to log in to the Tomcat Manager interface. | Yes |
| Tomcat Manager URL | String | The URL of the Tomcat Manager interface. | Yes |
| Tomcat Manager User Name | String | The user name to use to log in to the Tomcat Manager interface. | Yes |
Stop Tomcat on the agent computer.
| Name | Type | Description | Required |
|---|---|---|---|
| Catalina Base | String | Provide a value if you want to overwrite the CATALINA_BASE environment variable or if one is not available. | No |
| Catalina Home | String | Provide a value if you want to overwrite the CATALINA_HOME environment variable or if one is not available. | No |
| Hostname | String | If your Tomcat instance is not listening on localhost then provide the hostname where it can be reached when its running. Use this property only if you are waiting for Tomcat to complete the shutdown sequence. The default value of localhost is used if no value is specified. | No |
| Java Home | String | Provide a value if you want to overwrite the JAVA_HOME environment variable or if one is not available. | No |
| Launcher | String | The location of the shutdown executable file, for example, /opt/tomcat/bin/shutdown.sh. |
Yes |
| Options | String | A new line separated list of command line options to pass to the launcher. | No |
| Port | String | Enter a port for the step to use to detect when the Tomcat instance is stopped. You can specify any of the connector ports that your instance is configured with. | No |
| Shutdown timeout (in seconds) | String | Enter a value to have the step to wait for the Tomcat instance to complete the shutdown sequence before continuing. You have to provide a port value lower than the port value used to detect when the shutdown process is complete. | No |
Undeploy a web application on Tomcat.
| Name | Type | Description | Required |
|---|---|---|---|
| Context Name | String | The context that is being deployed. | Yes |
| Tomcat Manager Password | Password | The password to use to log in to the Tomcat Manager interface. | Yes |
| Tomcat Manager URL | String | The URL of the Tomcat Manager interface. | Yes |
| Tomcat Manager User Name | String | The user name to use to log in to the Tomcat Manager interface. | Yes |
Summary
Usage
Steps
