From: markt
Date: Tue, 1 Jan 2008 15:38:38 +0000 (+0000)
Subject: Align docs for Jasper options. Put in alphabetical order, add some missing ones,...
X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=1f1598622f8231aa51426f8835ae8ec57d7297c3;p=tomcat7.0
Align docs for Jasper options. Put in alphabetical order, add some missing ones, remove an unused one and address feedback provided on users list.
git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@607860 13f79535-47bb-0310-9956-ffa450edef68
---
diff --git a/conf/web.xml b/conf/web.xml
index 4d35a42f1..679abd72f 100644
--- a/conf/web.xml
+++ b/conf/web.xml
@@ -136,21 +136,8 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
@@ -159,18 +146,53 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -185,41 +207,27 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
-
+
+
-
-
-
-
+
+
-
-
-
-
+
+
diff --git a/java/org/apache/jasper/EmbeddedServletOptions.java b/java/org/apache/jasper/EmbeddedServletOptions.java
index bfcb9aa34..5c1211efe 100644
--- a/java/org/apache/jasper/EmbeddedServletOptions.java
+++ b/java/org/apache/jasper/EmbeddedServletOptions.java
@@ -78,13 +78,6 @@ public final class EmbeddedServletOptions implements Options {
private boolean mappedFile = true;
/**
- * Do you want stack traces and such displayed in the client's
- * browser? If this is false, such messages go to the standard
- * error or a log file if the standard error is redirected.
- */
- private boolean sendErrorToClient = false;
-
- /**
* Do we want to include debugging information in the class file?
*/
private boolean classDebugInfo = true;
@@ -223,13 +216,6 @@ public final class EmbeddedServletOptions implements Options {
}
/**
- * Should errors be sent to client or thrown into stderr?
- */
- public boolean getSendErrorToClient() {
- return sendErrorToClient;
- }
-
- /**
* Should class files be compiled with debug information?
*/
public boolean getClassDebugInfo() {
@@ -466,19 +452,6 @@ public final class EmbeddedServletOptions implements Options {
}
}
- String senderr = config.getInitParameter("sendErrToClient");
- if (senderr != null) {
- if (senderr.equalsIgnoreCase("true")) {
- this.sendErrorToClient = true;
- } else if (senderr.equalsIgnoreCase("false")) {
- this.sendErrorToClient = false;
- } else {
- if (log.isWarnEnabled()) {
- log.warn(Localizer.getMessage("jsp.warning.sendErrToClient"));
- }
- }
- }
-
String debugInfo = config.getInitParameter("classdebuginfo");
if (debugInfo != null) {
if (debugInfo.equalsIgnoreCase("true")) {
diff --git a/java/org/apache/jasper/JspC.java b/java/org/apache/jasper/JspC.java
index 52435ba0b..d21fbb782 100644
--- a/java/org/apache/jasper/JspC.java
+++ b/java/org/apache/jasper/JspC.java
@@ -414,11 +414,6 @@ public class JspC implements Options {
return null;
}
- public boolean getSendErrorToClient() {
- // implied send to System.err
- return true;
- }
-
public void setClassDebugInfo( boolean b ) {
classDebugInfo=b;
}
diff --git a/java/org/apache/jasper/Options.java b/java/org/apache/jasper/Options.java
index 3148255cb..cff52c855 100644
--- a/java/org/apache/jasper/Options.java
+++ b/java/org/apache/jasper/Options.java
@@ -56,11 +56,6 @@ public interface Options {
public boolean getMappedFile();
/**
- * Should errors be sent to client or thrown into stderr?
- */
- public boolean getSendErrorToClient();
-
- /**
* Should we include debug information in compiled class?
*/
public boolean getClassDebugInfo();
diff --git a/java/org/apache/jasper/resources/LocalStrings.properties b/java/org/apache/jasper/resources/LocalStrings.properties
index e2a22f7f6..9cdba8867 100644
--- a/java/org/apache/jasper/resources/LocalStrings.properties
+++ b/java/org/apache/jasper/resources/LocalStrings.properties
@@ -166,7 +166,6 @@ jsp.warning.xpoweredBy=Warning: Invalid value for the initParam xpoweredBy. Will
jsp.warning.enablePooling=Warning: Invalid value for the initParam enablePooling. Will use the default value of \"true\"
jsp.warning.invalidTagPoolSize=Warning: Invalid value for the init parameter named tagPoolSize. Will use default size of {0}
jsp.warning.mappedFile=Warning: Invalid value for the initParam mappedFile. Will use the default value of \"false\"
-jsp.warning.sendErrToClient=Warning: Invalid value for the initParam sendErrToClient. Will use the default value of \"false\"
jsp.warning.classDebugInfo=Warning: Invalid value for the initParam classdebuginfo. Will use the default value of \"false\"
jsp.warning.checkInterval=Warning: Invalid value for the initParam checkInterval. Will use the default value of \"300\" seconds
jsp.warning.modificationTestInterval=Warning: Invalid value for the initParam modificationTestInterval. Will use the default value of \"4\" seconds
diff --git a/java/org/apache/jasper/resources/LocalStrings_es.properties b/java/org/apache/jasper/resources/LocalStrings_es.properties
index ec1799209..45ea654c0 100644
--- a/java/org/apache/jasper/resources/LocalStrings_es.properties
+++ b/java/org/apache/jasper/resources/LocalStrings_es.properties
@@ -153,7 +153,6 @@ jsp.warning.xpoweredBy=Aviso: valor incorrecto para el initParam xpoweredBy. Se
jsp.warning.enablePooling=Aviso: valor incorrecto para el initParam enablePooling. Se usará el valor por defecto de \"true\"
jsp.warning.invalidTagPoolSize=Aviso: valor incorrecto para el parámetro init llamado tagPoolSize. Se usará la medida por defecto de {0}
jsp.warning.mappedFile=Aviso: valor incorrecto para el initParam mappedFile. Se usará el valor por defecto de \"false\"
-jsp.warning.sendErrToClient=Aviso: valor incorrecto para el initParam sendErrToClient. Se usará el valor por defecto de \"false\"
jsp.warning.classDebugInfo=Aviso: valor incorrecto para el initParam classdebuginfo. Se usará el valor por defecto de \"false\"
jsp.warning.checkInterval=Aviso: valor incorrecto para el initParam checkInterval. Se usará el valor por defecto de \"300\" segundos
jsp.warning.development=Aviso: valor incorrecto para el initParam development. Se usará el valor por defecto de \"true\"
diff --git a/java/org/apache/jasper/resources/LocalStrings_fr.properties b/java/org/apache/jasper/resources/LocalStrings_fr.properties
index bd57d4c3c..28c68e8b4 100644
--- a/java/org/apache/jasper/resources/LocalStrings_fr.properties
+++ b/java/org/apache/jasper/resources/LocalStrings_fr.properties
@@ -122,7 +122,6 @@ jsp.error.setproperty.arrayVal=setProperty: on ne peut renseigner les array prop
jsp.warning.keepgen=Attention: Valeur incorrecte pour le initParam keepgenerated. Utilisation de la valeur par défaut \"false\"
jsp.warning.enablePooling=Attention: Valeur incorrecte pour le initParam enablePooling. Utilisation de la valeur par défaut \"true\"
jsp.warning.mappedFile=Attention: Valeur incorrecte pour le initParam mappedFile. Utilisation de la valeur par défaut \"false\"
-jsp.warning.sendErrToClient=Attention: Valeur incorrecte pour le initParam sendErrToClient. Utilisation de la valeur par défaut \"false\"
jsp.warning.classDebugInfo=Attention: Valeur incorrecte pour le initParam classdebuginfo. Utilisation de la valeur par défaut \"false\"
jsp.warning.checkInterval=Attention: Valeur incorrecte pour le initParam checkInterval. Utilisation de la valeur par défaut \"300\" secondes
jsp.warning.development=Attention: Valeur incorrecte pour le initParam development. Utilisation de la valeur par défaut \"true\"
diff --git a/java/org/apache/jasper/resources/LocalStrings_ja.properties b/java/org/apache/jasper/resources/LocalStrings_ja.properties
index 72ce6cd59..cfe536c00 100644
--- a/java/org/apache/jasper/resources/LocalStrings_ja.properties
+++ b/java/org/apache/jasper/resources/LocalStrings_ja.properties
@@ -152,7 +152,6 @@ jsp.warning.xpoweredBy=\u8b66\u544a: Invalid value for the initParam xpoweredBy\
jsp.warning.enablePooling=\u8b66\u544a: initParam enablePooling\u304c\u7121\u52b9\u306a\u5024\u3067\u3059\u3002\"true\"\u306e\u30c7\u30d5\u30a9\u30eb\u30c8\u5024\u3092\u4f7f\u7528\u3057\u307e\u3059
jsp.warning.invalidTagPoolSize=\u8b66\u544a: tagPoolSize\u306e\u521d\u671f\u30d1\u30e9\u30e1\u30fc\u30bf\u304c\u7121\u52b9\u306a\u5024\u3067\u3059\u3002{0}\u306e\u30c7\u30d5\u30a9\u30eb\u30c8\u30b5\u30a4\u30ba\u3092\u4f7f\u7528\u3057\u307e\u3059
jsp.warning.mappedFile=\u8b66\u544a: initParam mappedFile\u306e\u5024\u304c\u7121\u52b9\u3067\u3059\u3002\u30c7\u30d5\u30a9\u30eb\u30c8\u5024 \"false\" \u3092\u4f7f\u7528\u3057\u307e\u3059
-jsp.warning.sendErrToClient=\u8b66\u544a: initParam sendErrToClient\u306e\u5024\u304c\u7121\u52b9\u3067\u3059\u3002\u30c7\u30d5\u30a9\u30eb\u30c8\u5024 \"false\" \u3092\u4f7f\u7528\u3057\u307e\u3059
jsp.warning.classDebugInfo=\u8b66\u544a: initParam classDebugInfo\u306e\u5024\u304c\u7121\u52b9\u3067\u3059\u3002\u30c7\u30d5\u30a9\u30eb\u30c8\u5024 \"false\"\u3092\u4f7f\u7528\u3057\u307e\u3059
jsp.warning.checkInterval=\u8b66\u544a: initParam checkInterval\u306e\u5024\u304c\u7121\u52b9\u3067\u3059\u3002\"300\"\u79d2\u306e\u30c7\u30d5\u30a9\u30eb\u30c8\u5024\u3092\u4f7f\u7528\u3057\u307e\u3059
jsp.warning.development=\u8b66\u544a: initParam development\u306e\u5024\u304c\u7121\u52b9\u3067\u3059\u3002\"true\"\u306e\u30c7\u30d5\u30a9\u30eb\u30c8\u5024\u3092\u4f7f\u7528\u3057\u307e\u3059
diff --git a/webapps/docs/jasper-howto.xml b/webapps/docs/jasper-howto.xml
index 46133d207..a94802fe6 100644
--- a/webapps/docs/jasper-howto.xml
+++ b/webapps/docs/jasper-howto.xml
@@ -85,15 +85,10 @@ for use on a production Tomcat server.
in your global $CATALINA_BASE/conf/web.xml.
-- checkInterval - If development is false and reloading is
-true, background compiles are enabled. checkInterval is the time in seconds
-between checks to see if a JSP page needs to be recompiled. Default
-
300 seconds.
-
-- compiler - Which compiler Ant should use to compile JSP
-pages. See the Ant documentation for more information. If the value is not set,
-then the default Eclipse JDT Java compiler will be used instead of using Ant.
-No default value.
+- checkInterval - If development is false and checkInterval
+is greater than zero, background compiles are enabled. checkInterval is the time
+in seconds between checks to see if a JSP page (and its dependent files) needs
+to be recompiled. Default
0 seconds.
- classdebuginfo - Should the class file be compiled with
debugging information?
true or false, default
@@ -106,13 +101,29 @@ attribute org.apache.jasper.Constants.SERVLET_CLASSPATH is not set. This
attribute is always set when Jasper is used within Tomcat. By default the
classpath is created dynamically based on the current web application.
-- compilerSourceVM - What JDK version are the source files compatible with? (Default JDK 1.4)
+- compiler - Which compiler Ant should use to compile JSP
+pages. See the Ant documentation for more information. If the value is not set,
+then the default Eclipse JDT Java compiler will be used instead of using Ant.
+No default value.
+
+- compilerSourceVM - What JDK version are the source files
+compatible with? (Default JDK 1.4)
-- compilerTargetVM - What JDK version are the generated files compatible with? (Default JDK 1.4)
+- compilerTargetVM - What JDK version are the generated files
+compatible with? (Default JDK 1.4)
-- development - Is Jasper used in development mode (will
-check for JSP modification on every access)?
true or
-false, default true.
+- development - Is Jasper used in development mode? If true,
+the frequency at which JSPs are checked for modification may be specified via
+the modificationTestInterval parameter.
true or false,
+default true.
+
+- displaySourceFragment - Should a source fragment be
+included in exception messages?
true or false,
+default true.
+
+- dumpSmap - Should the SMAP info for JSR45 debugging be
+dumped to a file?
true or false, default
+false. false if suppressSmap is true.
- enablePooling - Determines whether tag handler pooling is
enabled.
true or false, default true.
@@ -123,20 +134,25 @@ used to configure Jasper. If not present, the default EmbeddedServletOptions
will be used.
-- ieClassId - The class-id value to be sent to Internet
-Explorer when using <jsp:plugin> tags. Default
-
clsid:8AD9C840-044E-11D1-B3E9-00805F499D93.
+- errorOnUseBeanInvalidClassAttribute - Should Jasper issue
+an error when the value of the class attribute in an useBean action is not a
+valid bean class?
true or false, default
+true.
- fork - Have Ant fork JSP page compiles so they are
performed in a seperate JVM from Tomcat?
true or
false, default true.
-- javaEncoding - Java file encoding to use for generating
-java source files. Default
UTF8.
-
- genStringAsCharArray - Should text strings be generated as char
arrays, to improve performance in some cases? Default
false.
+- ieClassId - The class-id value to be sent to Internet
+Explorer when using <jsp:plugin> tags. Default
+
clsid:8AD9C840-044E-11D1-B3E9-00805F499D93.
+
+- javaEncoding - Java file encoding to use for generating
+java source files. Default
UTF8.
+
- keepgenerated - Should we keep the generated Java source
code for each page instead of deleting it?
true or
false, default true.
@@ -145,45 +161,52 @@ code for each page instead of deleting it? true or
print statement per input line, to ease debugging?
true or false, default true.
-- modificationTestInterval - Checks for modification for a given
-JSP file (and all its dependent files) will be performed only once every specified amount
-of seconds. Setting this to 0 will cause the JSP to be checked on every access.
-Default is
4 seconds.
-
-- reloading - Should Jasper check for modified JSPs?
-
true or false, default false.
+- modificationTestInterval - Causes a JSP (and its dependent
+files) to not be checked for modification during the specified time interval
+(in seconds) from the last time the JSP was checked for modification. A value of
+0 will cause the JSP to be checked on every access. Used in development mode
+only. Default is
4 seconds.
- scratchdir - What scratch directory should we use when
compiling JSP pages? Default is the work directory for the current web
application.
+- suppressSmap - Should the generation of SMAP info for JSR45
+debugging be suppressed?
true or false, default
+false.
+
- trimSpaces - Should white spaces in template text between
actions or directives be trimmed ?, default
false.
+
+- xpoweredBy - Determines whether X-Powered-By response
+header is added by generated servlet.
true or false,
+default false.
-The Java compiler from Eclipse JDT in included as the default compiler. It is an
-advanced Java compiler which will load all dependencies from the Tomcat class loader,
-which will help tremendously when compiling on large installations with tens of JARs.
-On fast servers, this will allow sub-second recompilation cycles for even large JSP
-pages.
+The Java compiler from Eclipse JDT in included as the default compiler. It is
+an advanced Java compiler which will load all dependencies from the Tomcat class
+loader, which will help tremendously when compiling on large installations with
+tens of JARs. On fast servers, this will allow sub-second recompilation cycles
+for even large JSP pages.
-Apache Ant, which was used in previous Tomcat releases, can be used instead instead of
-the new compiler by simply removing the lib/jasper-jdt.jar file,
-and placing the ant.jar file from the latest Ant distribution in the
-lib folder. If you do this, you also need to use the "javac"
+
Apache Ant, which was used in previous Tomcat releases, can be used instead
+of the new compiler by simply removing the lib/jasper-jdt.jar file,
+and placing the ant.jar file from the latest Ant distribution in
+the lib folder. If you do this, you also need to use the "javac"
argument to catalina.sh.
-The main JSP optimization which can be done is precompilation of JSPs. However,
-this might not be possible (for example, when using the jsp-property-group feature)
-or practical, in which case the configuration of the Jasper servlet becomes critical.
+The main JSP optimization which can be done is precompilation of JSPs.
+However, this might not be possible (for example, when using the
+jsp-property-group feature) or practical, in which case the configuration of the
+Jasper servlet becomes critical.
-When using Jasper 2 in a production Tomcat server you should consider
-making the following changes from the default configuration.
+
When using Jasper 2 in a production Tomcat server you should consider making
+the following changes from the default configuration.
- development - To disable on access checks for JSP
pages compilation set this to
false.
@@ -290,28 +313,34 @@ are automatically compiled as part of the build process.
At the jasper2 task you can use the option addWebXmlMappings for
automatic merge the ${webapp.path}/WEB-INF/generated_web.xml
-with the current web application deployment descriptor at ${webapp.path}/WEB-INF/web.xml.
-When you want to use Java 5 feature inside your jsp's, add the following javac compiler task
-attributes: source="1.5" target="1.5". For live application
-you can also compile with optimize="on" and without debug info
-debug="off".
+with the current web application deployment descriptor at
+${webapp.path}/WEB-INF/web.xml. When you want to use Java 5
+features inside your jsp's, add the following javac compiler task attributes:
+source="1.5" target="1.5". For live
+applications you can also compile with optimize="on" and
+without debug info debug="off".
When you don't want to stop the jsp generation at first jsp syntax error, use
-failOnError="false"and with showSuccess="true"
-all successfull jsp to java generation are printed out. Sometimes it is
-very helpfull, when you cleanup the generate java source files at ${webapp.path}/WEB-INF/src
-and the compile jsp servlet classes at ${webapp.path}/WEB-INF/classes/org/apache/jsp.
+failOnError="false"and with
+showSuccess="true" all successfull jsp to java
+generation are printed out. Sometimes it is very helpfull, when you cleanup the
+generate java source files at ${webapp.path}/WEB-INF/src
+and the compile jsp servlet classes at
+${webapp.path}/WEB-INF/classes/org/apache/jsp.
Hints:
-- When you switch to another tomcat release, then regenerate and recompile
-your jsp's with this version again!
-- Use java system property at server runtime to disable tag pooling
org.apache.jasper.runtime.JspFactoryImpl.USE_POOL=false.
-and limit the buffering with org.apache.jasper.runtime.BodyContentImpl.LIMIT_BUFFER=true. Note that changing
-from the defaults may affect performance, but depending on the application.
+- When you switch to another Tomcat release, then regenerate and recompile
+your jsp's with the new Tomcat version.
+- Use java system property at server runtime to disable tag pooling
+
org.apache.jasper.runtime.JspFactoryImpl.USE_POOL=false.
+and limit the buffering with
+org.apache.jasper.runtime.BodyContentImpl.LIMIT_BUFFER=true. Note
+that changing from the defaults may affect performance, but it will vary
+depending on the application.