JBoss Community Archive (Read Only)

RHQ 4.9

Tomcat - Web Application (WAR) Service

Tomcat - Web Application (WAR) Service

Overview

Internal Name:

Tomcat Web Application (WAR)

Description:

Tomcat deployed Web Application

Singleton:

no

Plugin:

Tomcat

Connection Settings

Name

Description

Required

Internal Name

Object Name

 

yes

objectName

Context Root

The unique path prefix for URLs corresponding to this WAR

no

contextRoot

Virtual Host

The (virtual) host for this deployed application. If no host is set, this defaults to 'localhost'

no

vHost

Filename

The deployment root file name (.war or directory)

yes

filename

Response Time Log File

the absolute path to the log file containing response-time statistics for this web application

no

responseTimeLogFile

Response Time Url Excludes

a space-delimited list of regular expressions matching URLs to exclude from response-time statisics

no

responseTimeUrlExcludes

Response Time Url Transforms

a space-delimited list of Perl-style substitution expressions to apply to URLs actively collecting response-time statistics (e.g. |^/dept/finance/.*|/dept/finance/*|)

no

responseTimeUrlTransforms

Name

The name of this Web Module (WAR)

yes

name

Name Template

Resource name template

yes

nameTemplate

Description Template

Resource description template

yes

descriptionTemplate

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

Metrics

Name

Type

Description

Internal Name

Exploded deployment

trait

Whether deployed as a .war file or an exploded directory

Application.exploded

Requests served

measurement

Number of requests served by servlets

Servlet.NumRequests

Requests served per Minute

measurement

Number of requests served by servlets

Servlet.NumRequests

Processing Errors

measurement

Number of errors while processing servlets

Servlet.NumErrors

Processing Errors per Minute

measurement

Number of errors while processing servlets

Servlet.NumErrors

Currently Active Sessions

measurement

Number active sessions for the webapp right now

Session.activeSessions

Maximum number of Active Sessions

measurement

Maximum number of active sessions for the webapp

Session.maxActive

Sessions created

measurement

Number of sessions created for the webapp

Session.sessionCounter

Sessions created per Minute

measurement

Number of sessions created for the webapp

Session.sessionCounter

Expired Sessions

measurement

Number of expired sessions for the webapp

Session.expiredSessions

Expired Sessions per Minute

measurement

Number of expired sessions for the webapp

Session.expiredSessions

Rejected Sessions

measurement

Number of sessions rejected for the webapp

Session.rejectedSessions

Rejected Sessions per Minute

measurement

Number of sessions rejected for the webapp

Session.rejectedSessions

Session Average alive time

measurement

Average alive time of a Session

Session.sessionAverageAliveTime

Max Session alive time

measurement

Maximum alive time of a Session

Session.sessionMaxAliveTime

Virtual Hosts

trait

Virtual hosts this app runs on

VHost.name

HTTP Response Time

calltime

the minimum, maximum, and average response times for HTTP requests serviced by this web application

ResponseTime

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

Configuration Properties

Name

Description

Required

Internal Name

Allow Linking

If the value of this flag is true, symlinks will be allowed inside the web application, pointing to resources outside the web application base path. If not specified, the default value of the flag is false. NOTE: This flag MUST NOT be set to true on the Windows platform (or any other OS which does not have a case sensitive filesystem), as it will disable case sensitivity checks, allowing JSP source code disclosure, among other security problems.

yes

allowLinking

Anti Jar Locking

If true, the Tomcat classloader will take extra measures to avoid JAR file locking when resources are accessed inside JARs through URLs. This will impact startup time of applications, but could prove to be useful on platforms or configurations where file locking can occur. If not specified, the default value is false.

yes

antiJarLocking

Anti Resource Locking

If true, Tomcat will prevent any file locking. This will significantly impact startup time of applications, but allows full webapp hot deploy and undeploy on platforms or configurations where file locking can occur. If not specified, the default value is false. Please note that setting this to true has some side effects, including the disabling of JSP reloading in a running server: see Bugzilla 37668. Please note that setting this flag to true in applications that are outside the appBase for the Host (the webapps directory by default) will cause the application to be deleted on Tomcat shutdown. You probably don't want to do this, so think twice before setting antiResourceLocking=true on a webapp that's outside the appBase for its Host.

yes

antiResourceLocking

Caching Allowed

If the value of this flag is true, the cache for static resources will be used. If not specified, the default value of the flag is true.

yes

cachingAllowed

Cache TTL

Amount of time in milliseconds between cache entries revalidation. If not specified, the default value is 5000 (5 seconds).

yes

cacheTTL

Cache Max Size

Maximum size of the static resource cache in kilobytes. If not specified, the default value is 10240 (10 megabytes).

yes

cacheMaxSize

Case Sensitive

If the value of this flag is true, all case sensitivity checks will be disabled. If not specified, the default value of the flag is true. NOTE: This flag MUST NOT be set to false on the Windows platform (or any other OS which does not have a case sensitive filesystem), as it will disable case sensitivity checks, allowing JSP source code disclosure, among other security problems.

yes

caseSensitive

Cookies

Set to true if you want cookies to be used for session identifier communication if supported by the client (this is the default). Set to false if you want to disable the use of cookies for session identifier communication, and rely only on URL rewriting by the application.

yes

cookies

Compiler Classpath

The compiler classpath to use

no

compilerClasspath

Config File

The location of the context.xml resource or file

yes

configFile

Cross Context

Set to true if you want calls within this application to ServletContext.getContext() to successfully return a request dispatcher for other web applications running on this virtual host. Set to false (the default) in security conscious environments, to make getContext() always return null.

yes

crossContext

Doc Base

The docBase set for this application

yes

docBase

Event Provider

Event provider support for this managed object?

yes

eventProvider

Privileged

Set to true to allow this context to use container servlets, like the manager servlet. Use of the privileged attribute will change the context's parent class loader to be the Server class loader rather than the Shared class loader. Note that in a default installation, the Common class loader is used for both the Server and the Shared class loaders.

yes

privileged

Reloadable

Set to true if you want Catalina to monitor classes in /WEB-INF/classes/ and /WEB-INF/lib for changes, and automatically reload the web application if a change is detected. This feature is very useful during application development, but it requires significant runtime overhead and is not recommended for use on deployed production applications. That's why the default setting for this attribute is false.

yes

reloadable

Save Config

Write the configuration as needed on startup?

yes

saveConfig

State Manageable

State management support for this managed object?

yes

stateManageable

Statistics Provider

Performance statistics support for this managed object?

yes

statisticsProvider

Swallow Output

If the value of this flag is true, the bytes output to System.out and System.err by the web application will be redirected to the web application logger. If not specified, the default value of the flag is false.

yes

swallowOutput

Unload Delay

Amount of ms that the container will wait for servlets to unload. If not specified, the default value of the flag is 2000 ms.

yes

unloadDelay

Use Naming

Set to true (the default) to have Catalina enable a JNDI InitialContext for this web application that is compatible with Java2 Enterprise Edition (J2EE) platform conventions.

yes

useNaming

Work Directory

Pathname to a scratch directory to be provided by this Context for temporary read-write use by servlets within the associated web application. This directory will be made visible to servlets in the web application by a servlet context attribute (of type java.io.File) named javax.servlet.context.tempdir as described in the Servlet Specification. If not specified, a suitable directory underneath $CATALINA_BASE/work will be provided.

no

workDir

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

Operations

Name

Description

Start

starts this web application.

Stop

stops this web application.

Reload

reloads this web application.

Package Types

Name

Category

Description

WAR File

Deployable

 

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