3.4. Tomcat Server
Overview
| Description: | Tomcat Server |
| Singleton: | no |
| Plugin: | Tomcat |
Configuring the Tomcat Server for Discovery
A Tomca server is discovery automatically on Linux and Unix systems, but it requires additional configuration to be discovered on Windows systems.
- Run
regedit. - Navigate to Java preferences key for the Tomcat server,
HKEY_LOCAL_MACHINE\SOFTWARE\Apache Software Foundation\Procrun2.0\TomcatVer#\Parameters\Java. - Edit the Options attribute, and add these parameters:
-Dcom.sun.management.jmxremote.port=9876 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false
- Restart the Tomcat service.
After a few minutes, the Tomcat instance should show up in the Discovery Queue.
Parent Resource Types
Child Resource Types
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 Properties
| 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 |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Server Identifier | trait | Tomcat server release identifier | Catalina:type=Server:serverInfo |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
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. |
Package Types
none
3.4.1. Tomcat Connector Service
Overview
| Description: | |
| Singleton: | no |
| Plugin: | Tomcat |
Parent Resource Types
Child Resource Types
none
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Port | Port on which this connector is configured to listen. | yes | port |
| Handler | Connector protocol handler. | yes | handler |
| Address | For servers with more than one IP address, this attribute specifies which address will be used for listening on the specified port. By default, this port will be used on all IP addresses associated with the server. | no | address |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Maximum Request Time | measurement | Maximum time it took to process a request. | Catalina:type=GlobalRequestProcessor,name=%handler%%address%-%port%:maxTime |
| Request count | measurement | Total number of requests processed since last restart. | Catalina:type=GlobalRequestProcessor,name=%handler%%address%-%port%:requestCount |
| Request count per Minute | measurement | Total number of requests processed since last restart. | Catalina:type=GlobalRequestProcessor,name=%handler%%address%-%port%:requestCount |
| Error count | measurement | Number of errors while processing since last restart. | Catalina:type=GlobalRequestProcessor,name=%handler%%address%-%port%:errorCount |
| Error count per Minute | measurement | Number of errors while processing since last restart. | Catalina:type=GlobalRequestProcessor,name=%handler%%address%-%port%:errorCount |
| Threadpool Threads Active | measurement | Number of current busy threads. | Catalina:type=ThreadPool,name=%handler%%address%-%port%:currentThreadsBusy |
| Threadpool Threads Allocated | measurement | Number of current threads. | Catalina:type=ThreadPool,name=%handler%%address%-%port%:currentThreadCount |
| Threadpool Max Threads | measurement | Maximum number of threads that can be allocated for the ThreadPool. | Catalina:type=ThreadPool,name=%handler%%address%-%port%:maxThreads |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Allow Trace | A boolean value which can be used to enable or disable the TRACE HTTP method. If not specified, this attribute is set to false. | yes | allowTrace |
| Buffer Size | HTTP: The size (in bytes) of the buffer to be provided for input streams created by this connector. By default, buffers of 2048 bytes will be provided. AJP: The size of the output buffer to use. If less than or equal to zero, then output buffering is disabled. The default value is -1 (i.e. buffering disabled) | yes | bufferSize |
| Connection Timeout | HTTP: The number of milliseconds this Connector will wait, after accepting a connection, for the request URI line to be presented. The default value is 60000 (i.e. 60 seconds). AJP: The number of milliseconds this Connector will wait, after accepting a connection, for the request URI line to be presented. The default value is infinite (i.e. no timeout). | no | connectionTimeout |
| Empty Session Path | If set to true, all paths for session cookies will be set to /. This can be useful for portlet specification implementations, but will greatly affect performance if many applications are accessed on a given server by the client. If not specified, this attribute is set to false. | yes | emptySessionPath |
| Enable Lookups | Set to true if you want calls to request.getRemoteHost() to perform DNS lookups in order to return the actual host name of the remote client. Set to false to skip the DNS lookup and return the IP address in String form instead (thereby improving performance). By default, DNS lookups are enabled. | yes | enableLookups |
| Keep Alive Timeout | Ignored prior to Tomcat 6. HTTP: The number of milliseconds this Connector will wait for another HTTP request before closing the connection. The default value is to use the value that has been set for the connectionTimeout attribute. AJP: The number of milliseconds this Connector will wait for another AJP request before closing the connection. The default value is to use the value that has been set for the connectionTimeout attribute. | no | keepAliveTimeout |
| Max Post Size | The maximum size in bytes of the POST which will be handled by the container FORM URL parameter parsing. The limit can be disabled by setting this attribute to a value less than or equal to 0. If not specified, this attribute is set to 2097152 (2 megabytes). | yes | maxPostSize |
| Max Threads | HTTP: The maximum number of request processing threads to be created by this Connector, which therefore determines the maximum number of simultaneous requests that can be handled. If not specified, this attribute is set to 40. If an executor is associated with this connector, this attribute is ignored as the connector will execute tasks using the executor rather than an internal thread pool. AJP: The maximum number of request processing threads to be created by this Connector, which therefore determines the maximum number of simultaneous requests that can be handled. If not specified, this attribute is set to 200. If an executor is associated with this connector, this attribute is ignored as the connector will execute tasks using the executor rather than an internal thread pool. | no | maxThreads |
| Protocol | The protocol to handle incoming traffic. | yes | protocol |
| Proxy Name | If this Connector is being used in a proxy configuration, configure this attribute to specify the server name to be returned for calls to request.getServerName(). | no | proxyName |
| Proxy Port | If this Connector is being used in a proxy configuration, configure this attribute to specify the server port to be returned for calls to request.getServerPort(). | no | proxyPort |
| Redirect Port | If this Connector is supporting non-SSL requests, and a request is received for which a matching security-constraint requires SSL transport, Catalina will automatically redirect the request to the port number specified here. | yes | redirectPort |
| Scheme | The name of the protocol you wish to have returned by calls to request.getScheme(). For example, you would set this attribute to 'https' for an SSL Connector. The default value is 'http' | yes | scheme |
| Secure | Set this attribute to true if you wish to have calls to request.isSecure() to return true for requests received by this Connector. You would want this on an SSL Connector or a non SSL connector that is receiving data from a SSL accelerator, like a crypto card, a SSL appliance or even a webserver. The default value is false | no | secure |
| TCP NoDelay | If set to true, the TCP_NO_DELAY option will be set on the server socket, which improves performance under most circumstances. This is set to true by default. | no | tcpNoDelay |
| URI Encoding | This specifies the character encoding used to decode the URI bytes, after %xx decoding the URL. If not specified, ISO-8859-1 will be used. | no | URIEncoding |
| Use Body Encoding for URI | This specifies if the encoding specified in contentType should be used for URI query parameters, instead of using the URIEncoding. This setting is present for compatibility with Tomcat 4.1.x. | yes | useBodyEncodingForURI |
| X-Powered-By | Set this attribute to true to cause Tomcat to advertise support for the Servlet specification using the header recommended in the specification. The default value is false. | yes | xpoweredBy |
| Accept Count | The maximum queue length for incoming connection requests when all possible request processing threads are in use. Any requests received when the queue is full will be refused. The default value is 10. | no | acceptCount |
| Compression | The Connector may use HTTP/1.1 GZIP compression in an attempt to save server bandwidth. The acceptable values for the parameter is 'off' (disable compression), 'on' (allow compression, which causes text data to be compressed), 'force' (forces compression in all cases), or a numerical integer value (which is equivalent to 'on', but specifies the minimum amount of data before the output is compressed). If the content-length is not known and compression is set to 'on' or more aggressive, the output will also be compressed. If not specified, this attribute is set to 'off'. | no | compression |
| Connection Linger | The number of milliseconds during which the sockets used by this Connector will linger when they are closed. (-1 socket linger is disabled). | no | connectionLinger |
| Disable Upload Timeout | This flag allows the servlet container to use a different, longer connection timeout while a servlet is being executed, which in the end allows either the servlet a longer amount of time to complete its execution, or a longer timeout during data upload. If not specified, this attribute is set to true. | no | disableUploadTimeout |
| Max Http Header Size | The maximum size of the request and response HTTP header, specified in bytes. If not specified, this attribute is set to 4096 (4 KB). | no | maxHttpHeaderSize |
| Max Keep Alive Requests | The maximum number of HTTP requests which can be pipelined until the connection is closed by the server. Setting this attribute to 1 will disable HTTP/1.0 keep-alive, as well as HTTP/1.1 keep-alive and pipelining. Setting this to -1 will allow an unlimited amount of pipelined or keep-alive HTTP requests. If not specified, this attribute is set to 100. | no | maxKeepAliveRequests |
| Max Spare Threads | The maximum number of unused request processing threads that will be allowed to exist until the thread pool starts stopping the unnecessary threads. The default value is 50. | no | maxSpareThreads |
| Min Spare Threads | The number of request processing threads that will be created when this Connector is first started. The connector will also make sure it has the specified number of idle processing threads available. This attribute should be set to a value smaller than that set for maxThreads. The default value is 4. | no | minSpareThreads |
| Strategy | The thread pooling strategy which will be used. The default strategy does not use a master thread, but a more conventional strategy using a master listener thread can be used by setting 'ms' as this attribute's value. The master strategy will work significantly better using the threadPriority attribute, which will apply only to the thread which listens on the server socket. This is set to 'lf' by default. | no | strategy |
| Thread Priority | The priority of the request processing threads within the JVM. The default value is java.lang.Thread#NORM_PRIORITY. See the JavaDoc for the java.lang.Thread class for more details on what this priority means. | no | threadPriority |
| Algorithm | The certificate encoding algorithm to be used. This defaults to the Sun implementation (SunX509). For IBM JVMs you should use the value IbmX509. For other vendors, consult the JVM documentation for the correct value. | no | algorithm |
| Ciphers | The comma separated list of encryption ciphers that this socket is allowed to use. By default, the default ciphers for the JVM will be used. Note that this usually means that the weak export grade ciphers will be included in the list of available ciphers. The ciphers are specified using the JSSE cipher naming convention. | no | ciphers |
| Client Authentication | Set to true if you want the SSL stack to require a valid certificate chain from the client before accepting a connection. Set to want if you want the SSL stack to request a client Certificate, but not fail if one isn't presented. A false value (which is the default) will not require a certificate chain unless the client requests a resource protected by a security constraint that uses CLIENT-CERT authentication. | no | clientAuth |
| Key Alias | The alias used to for the server certificate in the keystore. If not specified the first key read in the keystore will be used. | no | keyAlias |
| Keystore Password | The password used to access the server certificate from the specified keystore file. | no | keystorePass |
| Keystore File | Path to the keystore file used to validate client certificates. | no | keystoreFile |
| Keystore Type | The type of keystore file to be used for the server certificate. If not specified, the default value is 'JKS'. | no | keystoreType |
| SSL Protocol | The version of the SSL protocol to use. If not specified, the default is 'TLS'. | no | sslProtocol |
| Trust Store File | Path to the trust store file used to validate client certificates. | no | trustStoreFile |
| Trust Store Password | The password to access the TrustStore. This defaults to the value of Keystore Password. | no | trustStorePass |
| Trust Store Type | Add this element if your are using a different format for the TrustStore then you are using for the KeyStore. | no | trustStoreType |
| Tomcat Authentication | If set to true, the authentication will be done in Tomcat. Otherwise, the authenticated principal will be propagated from the native web server and used for authorization in Tomcat. The default value is true. | no | tomcatAuthentication |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
| Name | Description |
|---|---|
| Start | Starts this connector |
| Stop | Stops this connector |
| Pause | Pauses this connector |
| Resume | Resumes this connector |
Package Types
none
3.4.2. Tomcat User Database Service
Overview
| Description: | Tomcat User Database |
| Singleton: | yes |
| Plugin: | Tomcat |
Parent Resource Types
Child Resource Types
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
| Name | Description |
|---|---|
| Save | Save current users and groups to persistent storage. |
Package Types
none
3.4.2.1. Tomcat Group Service
Overview
| Description: | Tomcat User Group |
| Singleton: | no |
| Plugin: | Tomcat |
Parent Resource Types
Child Resource Types
none
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| groupname | ObjectName groupname value. | yes | name |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Group Name | The Group name. | yes | groupname |
| Description | The Group description. | no | description |
| Roles | Roles assigned to the Group. When editing, roles are case sensitive, must exist, and be on a new line. | no | roles |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.2. Tomcat Role Service
Overview
| Description: | Tomcat User Role |
| Singleton: | no |
| Plugin: | Tomcat |
Parent Resource Types
Child Resource Types
none
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| rolename | ObjectName rolename value. | yes | name |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Role Name | The Role name. | yes | rolename |
| Description | The Role description. | no | description |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.3. Tomcat User Service
Overview
| Description: | Tomcat User |
| Singleton: | no |
| Plugin: | Tomcat |
Parent Resource Types
Child Resource Types
none
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| username | ObjectName username value. | yes | name |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Username | The username | yes | username |
| Password | The credentials used to authenticate the username. | no | password |
| Full Name | The full name of the User | no | fullName |
| Groups | Groups assigned to the User. When editing, groups are case sensitive, must exist, and be on a new line. | no | groups |
| Roles | Roles assigned to the User. When editing, roles are case sensitive, must exist, and be on a new line. | no | roles |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.3. Tomcat Virtual Host Service
Overview
| Description: | A virtual host in the web container |
| Singleton: | no |
| Plugin: | Tomcat |
Parent Resource Types
Child Resource Types
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name | The virtual host | yes | name |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| App Base | The Application Base directory for this virtual host. | yes | appBase |
| Auto Deploy | Does this host deploy new applications dropped in appBase at runtime? | yes | autoDeploy |
| Deploy On Startup | Does this host deploy applications in appBase at startup? | yes | deployOnStartup |
| Deploy XML | deploy Context XML config files? | yes | deployXML |
| Unpack WARs | Does this Host automatically unpack deployed WAR files? | yes | unpackWARs |
| Aliases | Aliases assigned to the Host. When editing, each alias must be on a new line. Aliases are automatically lowercased. | no | aliases |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.3.1. Tomcat Web Application (WAR) Service
Overview
| Description: | Tomcat deployed Web Application |
| Singleton: | no |
| Plugin: | Tomcat |
Parent Resource Types
Child Resource Types
Connection Properties
| 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 |
Note
You must use the internal name to reference Configuration 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 |
Note
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 |
Note
You must use the internal name to reference Configuration 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 |
3.4.3.1.1. Tomcat Cache Service
Overview
| Description: | A Tomcat Application (WAR) Cache |
| Singleton: | yes |
| Plugin: | Tomcat |
Parent Resource Types
Child Resource Types
none
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Host | The cache host | yes | host |
| Path | The cache application path | yes | path |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Access Count | measurement | Number of cache accesses | accessCount |
| Hits Count | measurement | Number of cache hits | hitsCount |
| Cache Size | measurement | Number of cache entries | cacheSize |
| Cache Max Size | measurement | Maximum number of cache entries | cacheMaxSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
