stopServer

Signals a running Tomcat server to shutdown.

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 Manager URL

FDTOM_MANAGER_URL

Yes

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

Yes

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

Yes

The password for the FDTOM_USERNAME user.

Tomcat Java Home

FDTOM_JAVA_HOME

No

The JAVA_HOME directory used by the Tomcat server.

Tomcat Catalina BaseFDTOM_CATALINA_BASENoThe CATALINA_BASE directory for the Tomcat server.

Project Properties

Property Name

Property Code

Required

Description





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.

Endpoint Execution

This operation will randomly execute on one of the endpoints identified during selection.

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 FDTOM_CATALINA_BASE property must be set to the value of the CATALINA_BASE environment variable if using a multi-server Tomcat configuration.
  • The Tomcat user specified by property FDTOM_USERNAME must be granted the manager (Tomcat 6.0.x) or manager-script (Tomcat 7+) role.


If the stopServer operation is invoked on a server in the stopped status an error will be logged, but that error will be ignored.

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