Back to Top

Deploy Tomcat Configuration

Class Name com.midvision.rapiddeploy.orchestration.tasks.tomcat.DeployConfigurationTask
Category Apache Tomcat 7

Tomcat Deploy Configuration Task.

Description

This task deploys all the configuration contained within the deployment archive template into the Tomcat server. It copies the files into the following location: installationPath specified in the task resources.

Data Dictionary and Example

All variables in files under the templateDirectoryRelativePath that match the pattern @@VARIABLE_NAME@@ will be replaced in the target in-situ environment with the corresponding value from the data dictionary.

For example if an server.xml file in the template has:
                     			<Connector port="8780" protocol="HTTP/1.1"
                     		connectionTimeout="20000"
                     		redirectPort="8443"
                     		maxPostSize="@@MAX_POST_SIZE@@"/>
                     			
and the project or target specific data dictionary value:
                     			@@MAX_POST_SIZE@@=0
                     			
is set, then at deployment time the server.xml will be deployed with
                     			<Connector port="8780" protocol="HTTP/1.1"
                     		connectionTimeout="20000"
                     		redirectPort="8443"
                     		maxPostSize="0"/>
                     			

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installationPath java.lang.String @@installationPath@@ false The top level directory of the Tomcat 7 installation.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
templateDirectoryRelativePath java.lang.String tomcat/templates false This is the relative path to the configuration files within the deployment archive to copy onto the Tomcat server.


Back to Top

Find Memory Leaks

Class Name com.midvision.rapiddeploy.orchestration.tasks.tomcat.TomcatFindLeaksTask
Category Apache Tomcat 7

Tomcat Find Leaks Task.

Description

The find leaks diagnostic attempts to identify web applications that have caused memory leaks when they were stopped, reloaded or undeployed. Results should always be confirmed with a profiler. The diagnostic uses additional functionality provided by the StandardHost implementation. It will not work if a custom host is used that does not extend StandardHost.
Explicitly triggering a full garbage collection from Java code is documented to be unreliable. Furthermore, depending on the JVM used, there are options to disable explicit GC triggering, like -XX:+DisableExplicitGC. If you want to make sure, that the diagnostics were successfully running a full GC, you will need to check using tools like GC logging, JConsole or similar.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
adminUrl java.lang.String @@adminUrl@@ false The administrative Url to connect to for operations against the Tomcat domain.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the tomcat instance.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false The admin username to use for authenticating against the tomcat instance.


Back to Top

Snapshot Tomcat Server

Class Name com.midvision.rapiddeploy.orchestration.tasks.tomcat.SnapshotTask
Category Apache Tomcat 7

Create a snapshot of an Apache Tomcat 7 server

Description

This task creates a snapshot ZIP file of an Apache Tomcat 7 instance consisting on the specified included and excluded configuration files of the Tomcat installation location.

Usage

Using ANT fileset patterns set the included and excluded configuration files you want to be into the snapshot ZIP file.
By default the snapshot file will be saved in the RapidDeploy server in the location specified in the field 'Snapshots Path' of the environment configuration panel. If you want to use a different location (not recommended) you can set it using the 'snapshotDirectory' resource.
If you select to save the snapshot file in the target server ('saveOnTarget') you need to specify the 'snapshotDirectory' resource with the location in the target server where you want to save the snapshot file.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
binaryFilesetExcludes java.lang.String **/tmp*,**/temp* true ANT based comma separated fileset patterns to exclude in a snapshot.
binaryFilesetIncludes java.lang.String **/*.jar,**/*.war,**/*.zip true ANT based comma separated fileset patterns to include in a snapshot.
configFilesetExcludes java.lang.String **/tmpworklog*.log, **/*.jar, **/*.war, **/*.rar true ANT based comma separated fileset patterns to exclude in a snapshot.
configFilesetIncludes java.lang.String conf/*.xml,conf/**/*.xml,conf/*.properties,conf/**/*.properties true ANT based comma separated fileset patterns to include in a snapshot.
downloadBinaries java.lang.Boolean false true When set to true, the binaries filtered by the 'binaryFilesetIncludes' and 'binaryFilesetExcludes' resources will be downloaded as part of the snapshot.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installationPath java.lang.String @@installationPath@@ false The top level directory of the Tomcat installation. The ANT fileset patterns will be used to select files recursively below this directory to include in a snapshot.
rapiddeployUrl java.lang.String   true The URL of the RapidDeploy server that performs the call to the target server. This URL needs to be complete, including port and context path, e.g.: http://localhost:8080/MidVision. This resource is used to send back the snapshot file to the host server running the RapidDeploy web application. It does NOT need to be set in most cases.
saveOnTarget java.lang.Boolean false true If set to 'true' the snapshot file will be saved in the target server and not sent back to the RapidDeploy server. This option is not recommended as RapidDeploy can not keep track of the snapshots taken and the snapshot comparison feature can not be used.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
snapshotDirectory java.lang.String   true The directory location where the snapshots should be stored. This option should be used only when 'saveOnTarget' is set to 'true' or if you want to set a specific snapshot location on the RapidDeploy server (not recommended).


Back to Top

Start Tomcat Application

Class Name com.midvision.rapiddeploy.orchestration.tasks.tomcat.StartTomcatApplicationTask
Category Apache Tomcat 7

Start Tomcat Application Task.

Description

This task starts the specified Tomcat application in the Tomcat server.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
adminUrl java.lang.String @@adminUrl@@ false The administrative Url to connect to for operations against the Tomcat domain.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the tomcat instance.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false The admin username to use for authenticating against the tomcat instance.
warFileRelativePath java.lang.String resources/examplesWebApp.war false The path relative to archive root to the war file to start.


Back to Top

Start Tomcat Server

Class Name com.midvision.rapiddeploy.orchestration.tasks.tomcat.StartTomcatServerTask
Category Apache Tomcat 7

Start Tomcat Server Task.

Description

This task starts a Tomcat server (JVM) using the startup script. The script is searched for in the installationPath specified in the task resources.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installationPath java.lang.String @@installationPath@@ false The top level directory of the Tomcat 7 installation.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

Stop Tomcat Application

Class Name com.midvision.rapiddeploy.orchestration.tasks.tomcat.StopTomcatApplicationTask
Category Apache Tomcat 7

Stop Tomcat Application Task.

Description

This task stops the specified Tomcat application that is running in the Tomcat server.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
adminUrl java.lang.String @@adminUrl@@ false The administrative Url to connect to for operations against the Tomcat domain.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the tomcat instance.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false The admin username to use for authenticating against the tomcat instance.
warFileRelativePath java.lang.String resources/examplesWebApp.war false The path relative to archive root to the war file to stop.


Back to Top

Stop Tomcat Server

Class Name com.midvision.rapiddeploy.orchestration.tasks.tomcat.StopTomcatServerTask
Category Apache Tomcat 7

Stop Tomcat Server Task.

Description

This task stops a Tomcat server (JVM) using the shutdown script. The script is searched for in the installationPath specified in the task resources.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installationPath java.lang.String @@installationPath@@ false The top level directory of the Tomcat 7 installation.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

Tomcat Binary Install

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.tomcat.BinaryInstallTask
Category Apache Tomcat 7

Binary Install Task.

Description

This task install the TOMCAT binary files from the deployment archive on to the server.

Usage

The deployment archive should contain a directory or zip containing the tomcat files. This will be deployed to the installationPath on the target server.

Example

Setting the installation path in the resources to:
installationPath = /usr/apps/Tomcat
installs tomcat into
/usr/apps/Tomcat/
on the target server.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installationPath java.lang.String @@installationPath@@ false The top level directory of the Tomcat 7 installation to be created.
installerFileRegEx java.lang.String (?i)apache true The regular expression to filter the files within deployment package and look up the installer one.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

Tomcat War file Deployment

Class Name com.midvision.rapiddeploy.orchestration.tasks.tomcat.TomcatDeploymentTask
Category Apache Tomcat 7

Tomcat Deployment Task.

Depends on: archiveRoot

Description

Deploys a War file into an Apache Tomcat instance.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
adminUrl java.lang.String @@adminUrl@@ false The administrative Url to connect to for operations against the Tomcat domain.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the tomcat instance.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false The admin username to use for authenticating against the tomcat instance.
warFileRelativePath java.lang.String resources/examplesWebApp.war false The path relative to archive root to the war file to deploy.


Back to Top

Tomcat War file Undeployment

Class Name com.midvision.rapiddeploy.orchestration.tasks.tomcat.TomcatUndeploymentTask
Category Apache Tomcat 7

Tomcat Undeployment Task.

Description

Undeploys a War file from an Apache Tomcat instance.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
adminUrl java.lang.String @@adminUrl@@ false The administrative Url to connect to for operations against the Tomcat domain.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the tomcat instance.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false The admin username to use for authenticating against the tomcat instance.
warFileName java.lang.String examplesWebApp.war false The name of the war file to undeploy.


Back to Top

Tomcat Install - Apt/Yum Package (Linux)

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.tomcat.LinuxInstallerTask
Category Apache Tomcat Linux Installers

Apache Tomcat Install using Linux Package installer.

Description

This task installs the Tomcat binary files on Linux from the package management repositories for each Linux platform.

Usage

The task will determine which package installer is available for the platform.
yum will be used on Red Hat and Centos.
apt-get will be used on Ubuntu.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
aptPackage java.lang.String tomcat7 tomcat7-docs tomcat7-admin tomcat7-examples true The Apt (Ubuntu) Package name to install. Defaults to tomcat7. Choose: 'tomcat7 tomcat7-docs tomcat7-admin tomcat7-examples' to install tomcat and its default and admin webapps.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${installerOutput} false The name of the output parameter, which holds the text string output from the task. The output will be the result of the 'apt-get/yum' command on the platform. Typically this will be blank if the user creation succeeds. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (later tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${installerOutput}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sudoPassword java.lang.String   true The sudo password, if required, to run the install through sudo. Only required if non-root user requiring sudo password.
verbose java.lang.Boolean false true Verbose mode. Equivalent to the -v/-V option.
yumPackage java.lang.String tomcat-webapps tomcat-admin-webapps true The Yum (RHEL/CentOs )Package name to install. Defaults to 'tomcat'. Choose: 'tomcat-webapps tomcat-admin-webapps' to install tomcat and its default and admin webapps.


Back to Top

Tomcat Start - Apt/Yum Package (Linux)

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.tomcat.StartTomcatTask
Category Apache Tomcat Linux Installers

Apache Tomcat Start from Apt/Yum Package Install.

Description

This task starts the Tomcat server for an install from a Linux Package manager (Yum/Apt) only.

Usage

The task will determine which start sequence is available for the platform.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${startOutput} false The name of the output parameter, which holds the text string output from the task. The output will be the result of the 'start' command on the platform. Typically this will be blank if the user creation succeeds. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (later tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${startOutput}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sudoPassword java.lang.String   true The sudo password, if required, to run the start through sudo. Only required if non-root user requiring sudo password.


Back to Top

Tomcat Stop - Apt/Yum Package (Linux)

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.tomcat.StopTomcatTask
Category Apache Tomcat Linux Installers

Apache Tomcat Stop from Apt/Yum Package Install.

Description

This task stops the Tomcat server for an install from a Linux Package manager (Yum/Apt) only.

Usage

The task will determine which start sequence is available for the platform.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${stopOutput} false The name of the output parameter, which holds the text string output from the task. The output will be the result of the 'stop' command on the platform. Typically this will be blank if the user creation succeeds. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (later tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${stopOutput}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sudoPassword java.lang.String   true The sudo password, if required, to run the stop through sudo. Only required if non-root user requiring sudo password.


Back to Top

Tomcat Uninstall - Apt/Yum Package (Linux)

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.tomcat.LinuxUnInstallerTask
Category Apache Tomcat Linux Installers

Apache Tomcat uninstall using Linux Package installer.

Description

This task uninstalls Tomcat files on Linux.

Usage

The task will determine which package installer is available for the platform.
yum will be used on Red Hat and Centos.
apt-get will be used on Ubuntu.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
aptPackage java.lang.String   true The Apt (Ubuntu) Package name to uninstall. Defaults to tomcat7.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${uninstallerOutput} false The name of the output parameter, which holds the text string output from the task. The output will be the result of the 'apt-get/yum' command on the platform. Typically this will be blank if the user creation succeeds. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (later tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${uninstallerOutput}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sudoPassword java.lang.String   true The sudo password, if required, to run the uninstall through sudo. Only required if non-root user requiring sudo password.
verbose java.lang.Boolean false true Verbose mode. Equivalent to the -v/-V option.
yumPackage java.lang.String   true The Yum (RHEL/CentOs )Package name to uninstall. Defaults to tomcat.