Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Issue #4369 Update jsp documenation; remove old config from webdefault.xml (#4384) 

* Issue #4369 Update jsp documenation; remove old config from webdefault.xml

Signed-off-by: Jan Bartel <janb@webtide.com>
This commit is contained in:
Jan Bartel 2019-12-03 12:15:02 +11:00 committed by GitHub
parent c0f8a46c35
commit f99eb29195
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 66 additions and 148 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

122
jetty-documentation/src/main/asciidoc/distribution-guide/jsp/configuring-jsp.adoc
View File

@ -36,6 +36,12 @@ include::{SRCDIR}/jetty-home/src/main/resources/modules/jsp.mod[]
Note that the availability of some JSP features may depend on which JSP container implementation you are using. Note that the availability of some JSP features may depend on which JSP container implementation you are using.
Note also that it may not be possible to precompile your JSPs with one container and deploy to the other. Note also that it may not be possible to precompile your JSPs with one container and deploy to the other.
===== Logging
The Apache Jasper logging system is bridged to the jetty logging system.
Thus, you can enable logging for jsps in the same way you have setup for your webapp.
For example, assuming you are using Jetty's default StdErr logger, you would enable DEBUG level logging for jsps by adding the system property `-Dorg.apache.jasper.LEVEL=DEBUG` to the command line.
===== JSPs and Embedding ===== JSPs and Embedding
If you have an embedded setup for your webapp and wish to use JSPs, you will need to ensure that a JSP engine is correctly initialized. If you have an embedded setup for your webapp and wish to use JSPs, you will need to ensure that a JSP engine is correctly initialized.
@ -79,89 +85,91 @@ If you wish to use a different compiler, you will need to configure the `compile
[cols=",,,",options="header",] [cols=",,,",options="header",]
|======================================================================= |=======================================================================
|init param |Description |Default |`webdefault.xml` |init param |Description |Default |`webdefault.xml`
|classpath |`Classpath used for jsp compilation. Only used if
org.apache.catalina.jsp_classpath context attribute is not |checkInterval |If non-zero and `development` is `false`, background jsp recompilation is enabled. This value is the interval in seconds between background recompile checks.
set, which it is in Jetty.` |- |– |0 |–
|classpath |The classpath is dynamically generated if the context has a URL classloader. The `org.apache.catalina.jsp_classpath`
context attribute is used to add to the classpath, but if this is not set, this `classpath` configuration item is added to the classpath instead.` |- |–
|classdebuginfo |Include debugging info in class file. |TRUE |– |classdebuginfo |Include debugging info in class file. |TRUE |–
|checkInterval |Interval in seconds between background recompile checks. |compilerClassName |If not set, defaults to the Eclipse jdt compiler. |- |–
Only relevant if `
development=false`. |0 |–
|development |`development=true`, recompilation checks occur on each |compiler |Used if the Eclipse jdt compiler cannot be found on the
request. See also ` classpath. It is the classname of a compiler that Ant should invoke. |–
modificationTestInterval`. |TRUE |– |–
|compilerTargetVM |Target vm to compile for. |1.8 |1.8
|compilerSourceVM |Sets source compliance level for the jdt compiler.
|1.8 |1.8
|development |If `true` recompilation checks occur at the frequency governed by `modificationTestInterval`. |TRUE |–
|displaySourceFragment |Should a source fragment be included in |displaySourceFragment |Should a source fragment be included in
exception messages |TRUE |– exception messages |TRUE |–
|dumpSmap |Dump SMAP JSR45 info to a file. |FALSE |–
|enablePooling |Determines whether tag handler pooling is enabled. |TRUE |–
|engineOptionsClass |Allows specifying the Options class used to
configure Jasper. If not present, the default EmbeddedServletOptions
will be used. |- |–
|errorOnUseBeanInvalidClassAttribute |Should Jasper issue an error when |errorOnUseBeanInvalidClassAttribute |Should Jasper issue an error when
the value of the class attribute in an useBean action is not a valid the value of the class attribute in an useBean action is not a valid
bean class |TRUE |– bean class |TRUE |–
|fork |Should Ant fork its Java compiles of JSP pages? |TRUE |FALSE |fork |Only relevant if you use Ant to compile jsps: by default Jetty will use the Eclipse jdt compiler.|TRUE |-
|genStrAsCharArray |Option for generating Strings as char arrays. |FALSE |–
|ieClassId |The class-id value to be sent to Internet Explorer when
using <jsp:plugin> tags. |clsid:8AD9C840-044E-11D1-B3E9-00805F499D93 |–
|javaEncoding |Pass through the encoding to use for the compilation.
|UTF8 |–
|jspIdleTimeout |The amount of time in seconds a JSP can be idle before
it is unloaded. A value of zero or less indicates never unload. |-1 |–
|keepgenerated |Do you want to keep the generated Java files around? |keepgenerated |Do you want to keep the generated Java files around?
|TRUE |– |TRUE |–
|trimSpaces |Should white spaces between directives or actions be
trimmed? |FALSE |–
|enablePooling |Determines whether tag handler pooling is enabled. |TRUE
|–
|engineOptionsClass |Allows specifying the Options class used to
configure Jasper. If not present, the default EmbeddedServletOptions
will be used. |–
|mappedFile |Support for mapped Files. Generates a servlet that has a |mappedFile |Support for mapped Files. Generates a servlet that has a
print statement per line of the JSP file  |TRUE |– print statement per line of the JSP file  |TRUE |–
|suppressSmap |Generation of SMAP info for JSR45 debugging. |FALSE |–
|dumpSmap |Dump SMAP JSR45 info to a file. |FALSE |–
|genStrAsCharArray |Option for generating Strings. |FALSE |–
|ieClassId |The class-id value to be sent to Internet Explorer when
using <jsp:plugin> tags. |clsid:8AD9C840-044E-11D1-B3E9-00805F499D93 |–
|maxLoadedJsps |The maximum number of JSPs that will be loaded for a web |maxLoadedJsps |The maximum number of JSPs that will be loaded for a web
application. If more than this number of JSPs are loaded, the least application. If more than this number of JSPs are loaded, the least
recently used JSPs will be unloaded so that the number of JSPs loaded at recently used JSPs will be unloaded so that the number of JSPs loaded at
any one time does not exceed this limit. A value of zero or less any one time does not exceed this limit. A value of zero or less
indicates no limit. |-1 |– indicates no limit. |-1 |–
|jspIdleTimeout |The amount of time in seconds a JSP can be idle before
it is unloaded. A value of zero or less indicates never unload. |-1 |–
|scratchDir |Directory where servlets are generated. See |– |–
|compilerClassName |If not set, defaults to the Eclipse jdt compiler. |–
|compiler |Used if the Eclipse jdt compiler cannot be found on the
classpath. It is the classname of a compiler that Ant should invoke. |–
|–
|compilerTargetVM |Target vm to compile for. |1.7 |–
|compilerSourceVM |Sets source compliance level for the jdt compiler.
|1.7 |–
|javaEncoding |Pass through the encoding to use for the compilation.
|UTF8 |–
|modificationTestInterval |If `development=true`, interval between |modificationTestInterval |If `development=true`, interval between
recompilation checks, triggered by a request. |4 |– recompilation checks, triggered by a request. |4 |–
|xpoweredBy |Generate an X-Powered-By response header. |FALSE |FALSE |quoteAttributeEL | When EL is used in an attribute value on a JSP page, should the rules for quoting of attributes described in JSP.1.6 be applied to the expression
|TRUE |-
|recompileOnFail |If a JSP compilation fails should the |recompileOnFail |If a JSP compilation fails should the
modificationTestInterval be ignored and the next access trigger a modificationTestInterval be ignored and the next access trigger a
re-compilation attempt? Used in development mode only and is disabled by re-compilation attempt? Used in development mode only and is disabled by
default as compilation may be expensive and could lead to excessive default as compilation may be expensive and could lead to excessive
resource usage. |- |– resource usage. |FALSE |–
|scratchDir |Directory where servlets are generated. The default is the value of the context attribute `javax.servlet.context.tempdir`, or the system property `java.io.tmpdir` if the context attribute is not set. |– |–
|strictQuoteEscaping |Should the quote escaping required by section JSP.1.6 of the JSP specification be applied to scriplet expression.
|TRUE|-
|suppressSmap |Generation of SMAP info for JSR45 debugging. |FALSE |–
|trimSpaces |Should template text that consists entirely of whitespace be removed from the output (true), replaced with a single space (single) or left unchanged (false)? Note that if a JSP page or tag file specifies a trimDirectiveWhitespaces value of true, that will take precedence over this configuration setting for that page/tag.
trimmed? |FALSE |–
|xpoweredBy |Generate an X-Powered-By response header. |FALSE |FALSE
|======================================================================= |=======================================================================
[[configuring-jsp-for-jetty]] [[configuring-jsp-for-jetty]]
@ -171,7 +179,7 @@ The JSP engine has many configuration parameters.
Some parameters affect only precompilation, and some affect runtime recompilation checking. Some parameters affect only precompilation, and some affect runtime recompilation checking.
Parameters also differ among the various versions of the JSP engine. Parameters also differ among the various versions of the JSP engine.
This page lists the configuration parameters, their meanings, and their default settings. This page lists the configuration parameters, their meanings, and their default settings.
Set all parameters on the `org.apache.jasper.servlet.JspServlet` instance defined in the link:#webdefault-xml[`webdefault.xml`] file. Set all parameters on the `org.eclipse.jetty.jsp.JettyJspServlet` instance defined in the link:#webdefault-xml[`webdefault.xml`] file.
____ ____
[NOTE] [NOTE]
@ -225,18 +233,10 @@ You can use the entry in link:#webdefault-xml[{$jetty.home}/etc/webdefault.xml]
---- ----
<servlet id="jsp"> <servlet id="jsp">
<servlet-name>jsp</servlet-name> <servlet-name>jsp</servlet-name>
<servlet-class>org.apache.jasper.servlet.JspServlet</servlet-class> <servlet-class>org.eclipse.jetty.jsp.JettyJspServlet</servlet-class>
<init-param>
<param-name>logVerbosityLevel</param-name>
<param-value>DEBUG</param-value>
</init-param>
<init-param>
<param-name>fork</param-name>
<param-value>>false</param-value>
</init-param>
<init-param> <init-param>
<param-name>keepgenerated</param-name> <param-name>keepgenerated</param-name>
<param-value>>true</param-value> <param-value>true</param-value>
</init-param> </init-param>
... ...

92
jetty-webapp/src/main/config/etc/webdefault.xml
View File

@ -194,107 +194,25 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<!-- The JSP page compiler and execution servlet, which is the mechanism --> <!-- The JSP page compiler and execution servlet, which is the mechanism -->
<!-- used by the jsp container to support JSP pages. Traditionally, --> <!-- used by the jsp container to support JSP pages. Traditionally, -->
<!-- this servlet is mapped to URL pattern "*.jsp". This servlet --> <!-- this servlet is mapped to URL pattern "*.jsp". -->
<!-- supports the following initialization parameters (default values --> <!-- See http://https://www.eclipse.org/jetty/documentation/ -->
<!-- are in square brackets): --> <!-- for applicable configuration params. -->
<!-- -->
<!-- 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. [300] -->
<!-- -->
<!-- compiler Which compiler Ant should use to compile JSP -->
<!-- pages. See the Ant documentation for more -->
<!-- information. [javac] -->
<!-- -->
<!-- classdebuginfo Should the class file be compiled with -->
<!-- debugging information? [true] -->
<!-- -->
<!-- classpath What class path should I use while compiling -->
<!-- generated servlets? [Created dynamically -->
<!-- based on the current web application] -->
<!-- Set to ? to make the container explicitly set -->
<!-- this parameter. -->
<!-- -->
<!-- development Is Jasper used in development mode (will check -->
<!-- for JSP modification on every access)? [true] -->
<!-- -->
<!-- enablePooling Determines whether tag handler pooling is -->
<!-- enabled [true] -->
<!-- -->
<!-- fork Tell Ant to fork compiles of JSP pages so that -->
<!-- a separate JVM is used for JSP page compiles -->
<!-- from the one Tomcat is running in. [true] -->
<!-- -->
<!-- ieClassId The class-id value to be sent to Internet -->
<!-- Explorer when using <jsp:plugin> tags. -->
<!-- [clsid:8AD9C840-044E-11D1-B3E9-00805F499D93] -->
<!-- -->
<!-- javaEncoding Java file encoding to use for generating java -->
<!-- source files. [UTF-8] -->
<!-- -->
<!-- keepgenerated Should we keep the generated Java source code -->
<!-- for each page instead of deleting it? [true] -->
<!-- -->
<!-- logVerbosityLevel The level of detailed messages to be produced -->
<!-- by this servlet. Increasing levels cause the -->
<!-- generation of more messages. Valid values are -->
<!-- FATAL, ERROR, WARNING, INFORMATION, and DEBUG. -->
<!-- [WARNING] -->
<!-- -->
<!-- mappedfile Should we generate static content with one -->
<!-- print statement per input line, to ease -->
<!-- debugging? [false] -->
<!-- -->
<!-- -->
<!-- reloading Should Jasper check for modified JSPs? [true] -->
<!-- -->
<!-- suppressSmap Should the generation of SMAP info for JSR45 -->
<!-- debugging be suppressed? [false] -->
<!-- -->
<!-- dumpSmap Should the SMAP info for JSR45 debugging be -->
<!-- dumped to a file? [false] -->
<!-- False if suppressSmap is true -->
<!-- -->
<!-- scratchdir What scratch directory should we use when -->
<!-- compiling JSP pages? [default work directory -->
<!-- for the current web application] -->
<!-- -->
<!-- tagpoolMaxSize The maximum tag handler pool size [5] -->
<!-- -->
<!-- xpoweredBy Determines whether X-Powered-By response -->
<!-- header is added by generated servlet [false] -->
<!-- -->
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<servlet id="jsp"> <servlet id="jsp">
<servlet-name>jsp</servlet-name> <servlet-name>jsp</servlet-name>
<servlet-class>org.eclipse.jetty.jsp.JettyJspServlet</servlet-class> <servlet-class>org.eclipse.jetty.jsp.JettyJspServlet</servlet-class>
<init-param>
<param-name>logVerbosityLevel</param-name>
<param-value>DEBUG</param-value>
</init-param>
<init-param>
<param-name>fork</param-name>
<param-value>false</param-value>
</init-param>
<init-param> <init-param>
<param-name>xpoweredBy</param-name> <param-name>xpoweredBy</param-name>
<param-value>false</param-value> <param-value>false</param-value>
</init-param> </init-param>
<init-param> <init-param>
<param-name>compilerTargetVM</param-name> <param-name>compilerTargetVM</param-name>
<param-value>1.7</param-value> <param-value>1.8</param-value>
</init-param> </init-param>
<init-param> <init-param>
<param-name>compilerSourceVM</param-name> <param-name>compilerSourceVM</param-name>
<param-value>1.7</param-value> <param-value>1.8</param-value>
</init-param> </init-param>
<!--
<init-param>
<param-name>classpath</param-name>
<param-value>?</param-value>
</init-param>
-->
<load-on-startup>0</load-on-startup> <load-on-startup>0</load-on-startup>
</servlet> </servlet>