From 5c68f2a8c6743a08e8f115f5c53f34ea4c87e2dc Mon Sep 17 00:00:00 2001 From: markt Date: Sun, 10 Feb 2008 21:33:35 +0000 Subject: [PATCH] Add a page to the config docs detailing the various system properties that are available. git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@620335 13f79535-47bb-0310-9956-ffa450edef68 --- webapps/docs/config/project.xml | 4 + webapps/docs/config/systemprops.xml | 295 ++++++++++++++++++++++++++++++++++++ webapps/docs/tomcat-docs.xsl | 26 +++- 3 files changed, 324 insertions(+), 1 deletion(-) create mode 100644 webapps/docs/config/systemprops.xml diff --git a/webapps/docs/config/project.xml b/webapps/docs/config/project.xml index 1139853bc..db556387d 100644 --- a/webapps/docs/config/project.xml +++ b/webapps/docs/config/project.xml @@ -74,6 +74,10 @@ + + + + diff --git a/webapps/docs/config/systemprops.xml b/webapps/docs/config/systemprops.xml new file mode 100644 index 000000000..a841f7145 --- /dev/null +++ b/webapps/docs/config/systemprops.xml @@ -0,0 +1,295 @@ + + + +]> + + + &project; + + + System Properties + + + + +
+

The follow sections list the system properties that may be set to modify + the default Tomcat behaviour.

+
+ + +
+ + + +

If true, the clustering module will attempt to use DNS to + resolve any host names provided in the cluster configuration. If not + specified, the default value of false will be used.

+
+ +
+ +
+ + +
+ + + +

The name of the variable to use for the expression language expression + factory. If not specified, the default value of + _el_expressionfactory will be used.

+
+ + +

The name of the variable to use for the instance manager factory. If + not specified, the default value of _jsp_instancemanager will + be used.

+
+ + +

If true, any tag buffer that expands beyond + org.apache.jasper.Constants.DEFAULT_TAG_BUFFER_SIZE will be + destroyed and a new buffer created of the default size. If not specified, + the default value of false will be used.

+
+ + +

If true, a ThreadLocal PageContext pool will + be used. If not specified, the default value of true will be + used.

+
+ + +

The size of the ThreadLocal PageContext. If not specified, + the default value of 8 will be used.

+
+ + +

The base class of the Servlets generated from the JSPs. If not + specified, the default value of + org.apache.jasper.runtime.HttpJspBase will be used.

+
+ + +

The name of the service method called by the base class. If not + specified, the default value of _jspService will be used.

+
+ + +

The name of the ServletContext attribute that provides the classpath + for the JSP. If not specified, the default value of + org.apache.catalina.jsp_classpath will be used.

+
+ + +

The name of the request attribute for <jsp-file> + element of a servlet definition. If present on a request, this overrides + the value returned by request.getServletPath() to select the + JSP page to be executed. If not specified, the default value of + org.apache.catalina.jsp_file will be used.

+
+ + +

The name of the query parameter that causes the JSP engine to just + pregenerate the servlet but not invoke it. If not specified, the default + value of org.apache.catalina.jsp_precompile will be used.

+
+ + +

The default package name for compiled jsp pages. If not specified, the + default value of org.apache.jsp will be used.

+
+ + +

The default package name for tag handlers generated from tag files. If + not specified, the default value of org.apache.jsp.tag will + be used.

+
+ + +

The servlet context attribute under which the alternate deployment + descriptor for this web application is stored. If not specified, the + default value of org.apache.catalina.deploy.alt_dd will + be used.

+
+ + +

Prefix to use for generated temporary variable names. If not specified, + the default value of _jspx_temp will be used.

+
+ + +

If true, the instance manager is used to obtain tag + handler instances. If not specified, false will be used.

+
+ +
+ +
+ + +
+ + + + +

If this is true or if a security manager is in use a new + facade object will be created for each request. If not specified, the + default value of false will be used.

+
+ + +

If this is true the '\' character will be permitted as a + path delimiter. If not specified, the default value of false + will be used.

+
+ + +

If this is true '%2F' and '%5C' will be permitted as path + delimiters. If not specified, the default value of false will + be used.

+
+ +
+ +
+ + +
+ + + + +

If this is true the following actions will occur: +

    +
  • any wrapped request or response object passed to an application + dispatcher will be checked to ensure that it has wrapped the original + request or response. (SRV.8.2 / SRV.14.2.5.1) +
  • +
  • a call to Response.getWriter() if no character encoding + has been specified will result in subsequent calls to + Response.getCharacterEncoding() returning + ISO-8859-1 and the Content-Type response header + will include a charset=ISO-8859-1 component. (SRV.15.2.22.1) +
  • +
  • every request that is associated with a session will cause the + session's last accessed time to be updated regardless of whether or not + the request explicity accesses the session. (SRV.7.6) +
  • +
+

+
+ + +

If this is true or if + org.apache.catalina.STRICT_SERVLET_COMPLIANCE is + true Tomcat will track the number of active requests for each + session. When determining if a session is valid, any session with at least + one active request will always be considered valid. If not specified, the + default value of false will be used.

+
+ +
+ +
+ + +
+ + + + +

If this is false it will override the + useNaming attribute for all + Context elements.

+
+ + +

Provides a default value for the jvmRoute attribute of the + Engine element. It does not override the a value + configured on the Engine element.

+
+ + +

If true, Tomcat attempts to null out any static or final + fields from loaded classes when a web application is stopped as a work + around for apparent garbage collection bugs and application coding errors. +

+

There have been some issues reported with log4j when this option is + true.

+

Applications without memory leaks using recent JVMs should operate + correctly with this option set to false.

+

If not specified, the default value of true will be used. +

+
+ + +

The URL for the catalina.properties configuration file.

+
+ + +

If true, the String cache is enabled for + ByteChunk. If not specified, the default value of + false will be used.

+
+ + +

If true, the String cache is enabled for + CharChunk. If not specified, the default value of + false will be used.

+
+ + +

The number of times toString() must be called before the + cache is activated. If not specified, the default value of + 20000 will be used.

+
+ + +

The size of the String cache. If not specified, the default value of + 200 will be used.

+
+ + +

The maximum length of String that will be cached. If not specified, the + default value of 128 will be used.

+
+ + +

The size of the cache to use parsed and formatted date value. If not + specified, the default value of 1000 will be used.

+
+ + +

If true, use a shared selector for servlet write/read. If + not specified, the default value of true will be used.

+
+ +
+ +
+ + + +
diff --git a/webapps/docs/tomcat-docs.xsl b/webapps/docs/tomcat-docs.xsl index 473721d8d..8472a260f 100644 --- a/webapps/docs/tomcat-docs.xsl +++ b/webapps/docs/tomcat-docs.xsl @@ -154,7 +154,7 @@ PAGE FOOTER
- Copyright © 1999-2006, Apache Software Foundation + Copyright © 1999-2008, Apache Software Foundation
@@ -297,6 +297,30 @@ + + + + + + + + + + + + + +
+ Property + + Description +
+ + + +
+
+ -- 2.11.0