Tomcat

Configuration Name

Name of the configuration to be used for retrieving Admin Server’s URL and credentials.

Catalina Path

Provide the absolute path to Catalina’s home to locate the catalina.bat (or catalina.sh) needed to start or stop the application servers. For example, C:\Program Files\tomcat.

Startup Script Path

Provide the absolute path to the startup server script. Include filename and extension. For example, C:\Program Files\tomcat\bin\startup.bat.

Catalina Path

Provide the absolute path to Catalina’s home to locate the catalina.bat (or catalina.sh) needed to start or stop the application servers. For example, C:\Program Files\tomcat. (Required)

Shutdown Script Path

Provide the absolute path to the shutdown server script. Include filename and extension. For example, C:\Program Files\tomcat\bin\shutdown.bat. (Required)

Service Name

Provide the name of the Tomcat service to start. (Required)

Service Name

Provide the name of the Tomcat service to stop. (Required)

Context Configuration Path

Provide the context configuration file path.

Context Path

Context Path to use. In one sentence, the context path is the name after slash, by which your application is accessible.

Configuration Name

Name of the configuration to be used for retrieving Admin Server’s URL and credentials.

Update Application

Check this checkbox if the existing application in the supplied context path must be overridden.

WAR File/Exploded Directory Path

Provide the path to the WAR file or exploded directory to upload to the server. If this parameter is sent empty, the plugin will look into the appBase directory of Tomcat for the .war file that match with th Context Path provided to make the deploy. Acceptable formats: file - use the prefix file: and the absolute path of the WAR file or directory. For example, file:/absolute/path/to/a/directory or file:c:/mydir/webapp.war --- jar - use the prefix jar:. The URL to a local WAR file. You can use any syntax that is valid for the JarURLConnection class for reference to an entire JAR file. --- no prefix - if no prefix is entered, the Tomcat Manager will look in the host`s application base directory for either a WAR file or a directory, relative to the mentioned path. --- no prefix and remote deploy - if no prefix is entered and Remote Deployment is checked, the Tomcat Manager will look into the war path entered for the WAR file.

Context Path

Context Path to use. In one sentence, the context path is the name after slash, by which your application is accessible.

Configuration Name

Name of the configuration to be used for retrieving Admin Server’s URL and credentials.

Configuration Name

Name of the configuration to be used for retrieving Tomcat Home.

Application Warfile Location

Name of the War file which consists of the Web Application to be deployed, with absolute path. For example, /var/downloads/hello.war.

Request URL Context Path

The Context path of the URL at which Tomcat serves the application.

For example, if Tomcat should serve the Application at http://host:port/ws this value should be /ws and if Tomcat should serve the Application at http://host:port, /abc/ws, this value should be /abc/ws.

VirtualHost Name

Hostname of the Tomcat Server or the virtual host to which the application should be deployed. If this field is left empty, application will be deployed to Tomcat default host (localhost). Warning will be shown if provided name is not defined in conf/server.xml.

Host Application Directory location

This is the pathname of a directory where web applications for this host are located (Tomcat calls it appBase folder). If this field is left empty, it will be read from corresponding Host (specified by HostName) appBase attribute in conf/server.xml. A warning is returned if directory does not exist. The procedure also fails if it cannot retrieve the value either from the input or conf/server.xml.

Web Application Context Element

The full XML content for the <Context> element of the Context Descriptor. (You can read more about possible attributes in Tomcat documentation). If no value is provided, default value will be formed dynamically according to values given for Application Warfile Location and Request URL Context Path. <?xml version="1.0" encoding="UTF-8"?> <Context docBase="hello.war" path="/hello" unpackWAR="true"> </Context> Here docBase is path where deployed application warfile lives - /path/to/hello.war (relative to Host’s appBase) and path is the same as "Request URL Context Path" /hello

Update Action

Controls if Tomcat should override and deploy over an existing deployment.

No Action - If the war already exists do not copy over.

Remove and recreate - If the war exists, copy over and redeploy.

Server Restart Options

Controls if Server should be restarted or not. Values are:

Restart Unconditionally If this option is chosen, Server is restarted regardless of whether the previous steps are successful or not. Also, if the there is a deployment failure after the Restart no action is taken.

Do not Restart If this option is chosen, Server will not be restarted. This is a use case where in Server Restarts happen as part of a deferred schedule or Host "autoDeploy" attribute is set to true.

Stop Restarted Server upon failure. If this option is chosen, server will be restarted except that it will be stopped if the deployment fails.

Configuration Name

Name of the configuration to be used for retrieving Tomcat Home.

Request URL Context Path

The Context path of the URL at which Tomcat serves the application. For example, if Tomcat should serve the Application at http://host:port/ws this value should be /ws and if Tomcat should serve the Application at http://host:port /abc/ws , this value should be /abc/ws

Host Application Directory location

This is the pathname of a directory where web applications for this host are located (Tomcat calls it appBase folder). If this field is left empty, it will be read from corresponding Host (specified by HostName) appBase attribute in conf/server.xml. A warning is returned if the directory does not exist. Also, the procedure fails if it cannot retrieve the value either from input or conf/server.xml.

VirtualHost Name

Hostname of the Tomcat Server or the virtual host to which the application should be deployed. If this field is left empty, application will be deployed to Tomcat default host (localhost). Warning will be shown if provided name is not defined in conf/server.xml.

Specific Deployment Files

If specified procedure will remove context XML file with given Request URL Context Path and any given file paths. If empty, the procedure reads the docBase attribute from context XML with given Request URL Context Path, then if this is .war file will check for extracted folder and remove both.

Server Restart Options

Controls if Server should be restarted or not. Values are:

Restart Unconditionally If this option is chosen, Server is restarted regardless of whether the previous steps are successful or not. Also if the there is a deployment failure after the Restart no action is taken.

Do not Restart If this option is chosen, Server will not be restarted. This is a use case where in Server Restarts happen as part of a deferred schedule or Host "autoDeploy" attribute is set to true.

Stop Restarted Server upon failure. If this option is chosen, server will be restarted except that it will be stopped if the deployment fails.

Context Configuration Path

Absolute path of "context.xml", including filename and extension. For example, $CATALINA_BASE/conf/context.xml or C:\apache-tomcat-6.0.35\conf\context.xml.

Datasource Name

The name of the datasource. For example, jdbc/MyTest.

URL

Connection URL to be passed to our JDBC driver. For example, jdbc:mysql://hostname:3306/databaseName.

Max Active Connections

The maximum number of connections that can be allocated from this pool at the same time. Default is 8.

Max Idle Connections

The maximum number of connections that can sit idle in this pool at the same time. Default is 8.

Maximum Wait for Connections

The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception. Default is -1 (infinite).

Minimum Wait for Connections

The minimum number of connections that will sit idle in this pool at the same time.

Additional Attributes

Enter additional attributes for the resource. Use this format: attributeName="value";attributeName2="value2" where ; is used to separate the attributes. Note the "" around the values.

Driver Class Name

Fully qualified Java class name of the JDBC driver to be used. For example, com.mysql.jdbc.Driver.

Datasource credential

Specify credential that contains username and password for data source.

Context Configuration Path

Absolute path of "context.xml", including filename and extension. For example, $CATALINA_BASE/conf/context.xml or C:\apache-tomcat-6.0.35\conf\context.xml.

Datasource Name

The name of the datasource. For example, jdbc/MyTest.

Config Name

Unique name for the configuration for the Tomcat server

VirtualHost Name

Hostname of the Tomcat Server or the virtual host where application is deployed

Request URL Context Path

The Context path of the URL at which Tomcat serves the application.

JNDI Name

Name used to look up the resource in JNDI

Provider

Select provider for the JMS resources

ActiveMQ Broker URL

The URI is assumed to be a composite uri with multiple uris that are used to bind the connectors of the broker. Parameter is required if selected provider Apache ActiveMQ.

ActiveMQ Broker Name

Broker Name. Parameter is required when Provider is Apache ActiveMQ.

WebsphereMQ Connection Factory Type

Type of resource that is controlled by WebsphereMQ connection factory. Parameter is required when Provider is IBM WebSphereMQ.

WebsphereMQ Server Hostname

Network hostname where Websphere MQ provider is located. Parameter is required when Provider is IBM WebSphereMQ.

WebsphereMQ Server Port

TCP Port (1 - 65535) on server where Websphere MQ provider is located. Parameter is required when Provider is IBM WebSphereMQ.

WebsphereMQ Channel

Name for a channel on WebsphereMQ. Parameter is required when Provider is IBM WebSphereMQ.

WebsphereMQ Queue Manager

Name of a queue manager on WebsphereMQ. Parameter is required when Provider is IBM WebSphereMQ.

Custom Connection Factory Class

Fully qualified name of the Java class to use. For example, org.apache.activemq.ActiveMQConnectionFactory. Parameter is required when Provider is Custom.

Custom Connection Factory Class

Fully qualified name of the Factory Java class to use. For example, org.apache.activemq.JNDIRefferenceFactory. Parameter is required when Provider is Custom

Custom Connection Factory Attributes

Enter additional attributes for the resource. Use this format: attributeName="value";attributeName2="value2" where ; is used to separate the attributes. Note the "" around the values.

Description

Description for this Connection factory

Update Action

This parameter controls as to what the Update Action should be done when resource element with the same JNDI name exists.

Config Name

Unique name for the configuration for the Tomcat server

VirtualHost Name

Hostname of the Tomcat Server or the virtual host where application is deployed

Request URL Context Path

The Context path of the URL at which Tomcat serves the application.

JNDI Name

Name used to look up the resource in JNDI

Provider

Select provider for the JMS resources

Custom JMS Queue Class

Fully qualified name of the Java class to use. For example, org.apache.activemq.ActiveMQQueue.

Custom JMS Queue Factory Class

Fully qualified name of the Factory Java class to use. For example, org.apache.activemq.ActiveMQConnectionFactory.

Custom JMS Queue Attributes

Enter additional attributes for the resource. Use this format: attributeName="value";attributeName2="value2" where ; is used to separate the attributes. Note the "" around the values.

Description

Description for this JMS Queue

Update Action

This parameter controls as to what the Update Action should be done when resource element with the same JNDI name exists.

Config Name

Unique name for the configuration for the Tomcat server

VirtualHost Name

Hostname of the Tomcat Server or the virtual host where application is deployed

Request URL Context Path

The Context path of the URL at which Tomcat serves the application.

JNDI Name

Name used to look up the resource in JNDI

Provider

Select provider for the JMS Resources

Custom JMS Topic Class

Fully qualified name of the Java class to use. For example, org.apache.activemq.ActiveMQTopic.

Custom JMS Topic Factory Class

Fully qualified name of the Factory Java class to use. For example, org.apache.activemq.JNDIReferenceFactory.

Custom JMS Topic Attributes

Enter additional attributes for the resource. Use this format: attributeName="value";attributeName2="value2" where ; is used to separate the attributes. Note the "" around the values.

Description

Description for this JMS Topic

Update Action

This parameter controls as to what the Update Action should be done when resource element with the same JNDI name exists.

Config Name

Unique name for the configuration for the Tomcat server

VirtualHost Name

Hostname of the Tomcat Server or the virtual host where application is deployed

Request URL Context Path

The Context path of the URL at which Tomcat serves the application.

JNDI Name

The JNDI name for this Mail session (should be unique for context)

SMTP Host

The server that provides SMTP service for your network

Description

Description for this Mail session resource element

Update Action

This parameter controls as to what the Update Action should be done when resource element with the same JNDI name exists.

Config Name

Unique name for the configuration for the Tomcat server.

VirtualHost Name

Hostname of the Tomcat Server or the virtual host where application is deployed.

Request URL Context Path

The Context path of the URL at which Tomcat serves the application.

JNDI Name

JNDI name of the Resource delete.

Context Path

Context Path to use. In one sentence, the context path is the name after slash, by which your application is accessible.

Configuration Name

Name of the configuration to be used for retrieving Admin Server’s URL and credentials.

Context Path

Context Path to use. In one sentence, the context path is the name after slash, by which your application is accessible.

Configuration Name

Name of the configuration to be used for retrieving Admin Server’s URL and credentials.

Context Path

Context Path to use. In one sentence, the context path is the name after slash, by which your application is accessible.

Configuration Name

Name of the configuration to be used for retrieving Admin Server’s URL and credentials.

Configuration Name

Name of the configuration to be used for retrieving Admin Server’s URL and credentials.

Maximum Elapsed Time

Defines the maximum time in seconds that the job will try to check into the server. Blank implies no wait time (URL only checked one time).

Success Criteria

Indicate the status of the page that must be matched, either a Page found or a Page not found status. If the indicated success criteria matches the returned status at the end of the analysis, it is considered a success. Otherwise, it is an error in the job.

Credentials

Credentials to be entered.

Maximum Elapsed Time

Defines the maximum time in seconds that the job will try to check into the server (max of 180 seconds). Blank implies no wait time (0 seconds).

Success Criteria

Indicate the status of the page that must be matched, either a Page found or a Page not found status. If the indicated success criteria matches the returned status at the end of the analysis, it is considered a success. Otherwise, it is an error in the job. (Required)

Page URL

URL of the page to be checked. For example, http://localhost/examples/jsp/index.html. (Required)

Command

Provide the command to pass to the Tomcat Manager. For example, start, stop, run.

Configuration Name

Name of the configuration to be used for retrieving Admin Server’s URL and credentials.

Parameters

Provide additional parameters received by Tomcat Manager. Enter as URL parameters. For example, path=/Calendario&war=file:C:\Calendar.war.

Config Name

Unique name for the configuration for the Tomcat server.

Destination Filepath

Absolute path where deployed library file should appear after procedure run.

Local Filepath

Absolute path to a local file that should be deployed.

Overwrite

Controls action that should be made if "Destination Filepath" already exists.

Config Name

Unique name for the configuration for the Tomcat server.

Destination Filepath

Absolute path where configuration XML file should be copied to.

Local Filepath

Absolute path to where the configuration XML file is copied from.

Configuration File Content

XML content for config file that should be deployed (ignored if "Local Filepath" is given).

Overwrite

Controls action to be taken if file already exists in the destination.

Config Name

Unique name for the configuration for the Tomcat server.

Destination Filepath

Absolute path to the library file that should be deleted.