Runtime Context Variables

The following is a comprehensive list of all runtime context variables used by the Tomcat enabler.

Variable

Type

Description

ALLOW_NAME_ONLY_COOKIE_FLAG Environment Specify if non-specification compliant name-only cookies are accepted by Tomcat. (7.0 and later version only)
APR_LIB_PATH Environment HTTP/2 protocol requires the Apache Portable Runtime (APR) library installed on the enabler to work. The variable points to the directory where the APR library is installed. This variable is set with default values /usr/local/apr/lib for Linux and Solaris, and it is set as ${CATALINA_HOME}/bin for Windows. New values can be set for this variable to point it to a custom directory.
ARCHIVE_DEPLOYMENT_TIMEOUT String The amount of time in seconds to allow for each archive deployment to finish in standalone mode. Valid only if VERIFY_ARCHIVE_DEPLOYMENT_SUCCESS is true.
ARCHIVE_DETECTION_ENABLED String Archive detection is enabled only if this variable is defined and set to true.
ARCHIVE_DETECTION_FREQUENCY String Frequency in seconds at which archive detection is triggered. This variable is used only when ARCHIVE_DETECTION_ENABLED is true. Minimum allowed value is 30. If the value specified is lower than the minimum allowed, it resets to the minimum (30 seconds).
BIND_ON_ALL_LOCAL_ADDRESSES Environment Set to true to have Tomcat bind to all local IP addresses.
CAPTURE_AS_PROPERTY String A file ending with one of these comma separated list of trailing names is considered a properties file at capture time.
CAPTURE_INCLUDES String Directories that require to be captured. Generally these directories contain configuration, applications, and so forth.
CATALINA_HOME Environment Tomcat App server home
CATALINA_OPTS Environment Additional Catalina options to be used in startup and shutdown scripts.
CERTIFICATE_FILE Environment File location of the server certificate.
CERTIFICATE_KEY_FILE Environment File location of the server certificate key.
CLIENT_KEY_STORE_FILE String

Client keystore file used when connecting to the JMX server when TWO_WAY_SSL_ENABLED is true.

CLIENT_KEY_STORE_PASSWORD String Client keystore password used when connecting to the JMX server when TWO_WAY_SSL_ENABLED is true.
CLIENT_TRUST_STORE_FILE String Trust store file used when connecting to the JMX server
CLIENT_TRUST_STORE_PASSWORD String Client trust store password used when connecting to the JMX server.
CLUSTER_DISTRIBUTABLE_FLAG String True or False flag which enables/disables session replication at the global context level.
CLUSTER_MCAST_ADDR String MCast address to use for cluster membership broadcasts.
CLUSTER_MCAST_PORT String Port to use with MCast address for cluster membership broadcast.
CLUSTER_REPL_LISTENER_PORT String Port to use when listening for session replication requests.
CLUSTER_STICKY_SESSION_SUPPORT_ATTR String The attribute to be added to the engine element with name=Catalina to allow/disallow sticky session.
COMPONENT_NAME Environment

Tomcat Component name

DEFAULT_SSL_ALGORITHM String Default algorithm for the SSL/TLS Connector
DISTRIBUTION_NAME Environment Use this variable to change the distribution name on grid-library.xml.
DISTRIBUTION_VERSION Environment Use this variable to change the distribution version on grid-library.xml
ENABLE_JMX_AUTH Environment True if security is used when connecting to Tomcat JMX server instance.
HOST_AJP_PORT String IP port number used for AJP/1.3 protocol
HOST_JMX_PORT Environment IP port number used for JMX connector
HOST_SHUTDOWN_PORT String IP port number used to shut down app server
HTTPS_PORT Environment HTTPS listen port
HTTP_PORT Environment HTTP listen port
HTTP2_ENABLED Environment If HTTP2 protocol is supported
J2EE_ARCHIVE_DEPLOY_DIRECTORY String Location of deployed applications
JDK_NAME String The name of the required JDK
JDK_VERSION String The version of the required JDK
JMX_MONITOR_ROLE String Role name to use when connecting to the Tomcat JMX server instance.
JMX_MONITOR_ROLE_PWD String Role name password to use when connecting to the Tomcat JMX server instance.
LISTEN_ADDRESS_NET_MASK Environment A comma-delimited list of net masks in CIDR notation. The first IP address found that matches one of the net masks is used as the listen address. Note that BIND_ON_ALL_LOCAL_ADDRESSES overrides this setting.
ROOT_CONTEXT_WEBAPP String Specify the name of the archive, including file extension, to run as the ROOT context.
SERVER_KEY_STORE_FILE Environment Server keystore file location for incoming SSL connections.
SERVER_KEY_STORE_PASSWORD Environment Password for the server keystore
SERVER_TRUST_STORE_FILE Environment Server trust store file location for outgoing SSL connections
SERVER_TRUST_STORE_PASSWORD Environment Password for the server trust store
SESSION_COOKIE_NAME Environment Specify the name of the cookie used for session tracking
TWO_WAY_SSL_ENABLED Environment If clientAuth is enabled in the SSL or TLS Connector
USE_HTTP_ONLY_COOKIE_FLAG String Specify if the HttpOnly flag is set on session cookies to prevent client-side script accessing session ID. (7.0 and later version only)
VERIFY_ARCHIVE_DEPLOYMENT_SUCCESS String Whether or not to verify successful deployment of J2EE archives. This must be set to true for archive ordering.
VIRTUAL_HOST_NAME String The name associated with the server.xml host element