JBoss Community Archive (Read Only)

RHQ 4.9

Tomcat - Server

Tomcat - Server

Overview

Internal Name:

Tomcat Server

Description:

Tomcat Server

Singleton:

no

Plugin:

Tomcat

Autodiscovery Process Scans

Name

Query

WindowsEWSTomcat

process|basename|match=^tomcat(5|6)\.exe

Tomcat

process|basename|match=^java.*,arg|org.apache.catalina.startup.Bootstrap|match=.*

Connection Settings

Name

Description

Required

Internal Name

Catalina Home

The home directory path of the Tomcat installation.

yes

installationPath

Catalina Base

The base directory path of the Tomcat instance. Defaults to Catalina Home.

yes

catalinaBase

Manager URL

The RMI URL with which to connect to the Tomcat Server (e.g. service:jmx:rmi:///jndi/rmi://localhost:8999/jmxrmi).

yes

connectorAddress

Principal

The name of the principal (i.e. user) to authenticate.

no

principal

Credentials

The credentials (i.e. password) that should be used to authenticate the principal.

no

credentials

Control Method

The method used to execute the control operations. When set to RPM the system will use a System V init script via the 'service' command. The script properties will be ignored.

no

controlMethod

Script Prefix

A prefix applied to script execution commands; this prefix is applied verbatim. The full path of the executable is required (e.g. /usr/bin/sudo). For applicable platforms, this is typically a sudo command, so a sudo user must be configured appropriately for the specified command. Ignored if not set.

no

scriptPrefix

Start Script

The path to the script used by the 'Start' operation to start this Tomcat server; if the path is not absolute it will be resolved relative to {installationPath}.

no

startScript

Shutdown Script

The path to the script used by the 'Shutdown' operation to shutdown this Tomcat server; if the path is not absolute it will be resolved relative to {installationPath}.

no

shutdownScript

Start Wait Max

The time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to start up. The default is 5 minutes.

no

startWaitMax

Stop Wait Max

The time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to stop. The default is 2.5 minutes.

no

stopWaitMax

Start Script Environment Variables

Define the environment variables to be set when executing the start script.

no

startScriptEnvironment

Shutdown Script Environment Variables

Define the environment variables to be set when executing the shutdown script.

no

shutdownScriptEnvironment

Type

The type used to establish the EMS connection to the Tomcat server.

yes

type

You must use the internal name to reference properties in Dynamic Group Definition expressions.

Metrics

Name

Type

Description

Internal Name

Server Identifier

trait

Tomcat server release identifier

Catalina:type=Server:serverInfo

You must use the internal name to reference traits in Dynamic Group Definition expressions.

Operations

Name

Description

Start

Start this Tomcat server. The script used is specified in the Control section of Connection Properties.

Shutdown

Shutdown this Tomcat server. The script used is specified in the Control section of Connection Properties.

Restart

Restart this Tomcat server. The scripts used are specified in the Control section of Connection Properties.

Store Configuration

Save current state to the server.xml file.

JBoss.org Content Archive (Read Only), exported from JBoss Community Documentation Editor at 2020-03-13 08:40:46 UTC, last content change 2013-09-18 19:42:32 UTC.