Sun GlassFish Enterprise Server 2.1 Application Deployment Guide

jsp-config

Specifies JSP configuration information.

Superelements

sun-web-app (sun-web.xml)

Subelements

The following table describes subelements for the jsp-config element.

Table A–55 jsp-config Subelements

Element 

Required 

Description 

property (with attributes)

zero or more 

Specifies a property, which has a name and a value. 

Properties

The default property values are tuned for development of JSP files at the cost of performance. To maximize performance, set jsp-config properties to these non-default values:

The following table describes properties for the jsp-config element.

Table A–56 jsp-config Properties

Property 

Default 

Description 

checkInterval

0

If development is set to false and checkInterval is greater than zero, background compilations are enabled. The checkInterval is the time in seconds between checks to see if a JSP file needs to be recompiled.

classdebuginfo

true

Specifies whether the generated Java servlets are compiled with the debug option set (-g for javac).

classpath

created dynamically based on the current web application 

Specifies the classpath to use when compiling generated servlets. 

compiler

javac

Specifies the compiler Ant uses to compile JSP files. See the Ant documentation for more information: 

http://antinstaller.sourceforge.net/manual/manual/

compilerSourceVM

Depends on the Enterprise Server's Java runtime 

Specifies the JDK release with which source compatibility of the generated servlets is provided. Same as the -source release option of javac.

For more information, see http://java.sun.com/javase/6/docs/technotes/tools/solaris/javac.html#options.

compilerTargetVM

Depends on the Enterprise Server's Java runtime 

Specifies the JVM version for which the servlet class files are generated. Same as the -target release option of javac.

For more information, see http://java.sun.com/javase/6/docs/technotes/tools/solaris/javac.html#options.

defaultBufferNone

false

If true, the default for the buffer attribute of the page directive is none.

development

true

If set to true, enables development mode, which allows JSP files to be checked for modification. Specify the frequency at which JSPs are checked using the modificationTestInterval property.

dumpSmap

false

If set to true, dumps SMAP information for JSR 45 debugging to a file. Set to false if suppressSmap is true.

enablePooling

true

If set to true, tag handler pooling is enabled.

enableTldValidation

false

If set to true, all Tag Library Descriptor (TLD) files referenced by the web application are validated against their underlying schema or DTD file.

errorOnUseBeanInvalidClassAttribute

false

If set to true, issues an error when the value of the class attribute in a useBean action is not a valid bean class.

fork

true

Specifies that Ant forks the compiling of JSP files, using a JVM separate from the one in which Tomcat is running. 

genStrAsByteArray

true

If true, text strings are generated as bytes (encoded with the page encoding), if the page is not buffered.

genStrAsCharArray

false

If set to true, generates text strings as char arrays, which improves performance in some cases.

httpMethods

* for all methods

Specifies a comma separated list of HTTP methods supported by the JspServlet.

ieClassId

clsid:8AD9C840-044E-11D1-B3E9-00805F499D93

Specifies the Java plug-in COM class ID for Internet Explorer. Used by the <jsp:plugin> tags.

ignoreJspFragmentErrors

false

If set to true, instructs the compiler to ignore any JSP precompilation errors pertaining to statically included JSP segments that, despite not being top level JSP files, use the .jsp or .jspx extension (instead of the recommended .jspf).

initialCapacity

32

Specifies the initial capacity of the HashMap that maps JSP files to their corresponding servlets.

javaEncoding

UTF8

Specifies the encoding for the generated Java servlet. This encoding is passed to the Java compiler that is used to compile the servlet as well. By default, the web container tries to use UTF8. If that fails, it tries to use the javaEncoding value.

For encodings, see: 

http://java.sun.com/javase/6/docs/technotes/guides/intl/encoding.doc.html

keepgenerated

true with JDK 5 and before and for jspc, otherwise false

If set to true, keeps the generated Java files. If false, deletes the Java files.

mappedfile

true

If set to true, generates static content with one print statement per input line, to ease debugging.

modificationTestInterval

0

Specifies the frequency in seconds at which JSPs are checked for modification. A value of 0 causes the JSP to be checked on every access. Used only if development is set to true.

reload-interval

0

Specifies the frequency in seconds at which JSP files are checked for modifications. Setting this value to 0 checks JSP files for modifications on every request. Setting this value to -1 disables checks for JSP modifications and JSP recompilation.

saveBytecode

true for jspc, otherwise false

If true, generated byte code is saved to .class files? This option is meaningful only when the Java compiler API, JSR 199 (available with and used as the default on Java 6) is used for javac compilations.

scratchdir

The default work directory for the web application 

Specifies the working directory created for storing all the generated code. 

suppressSmap

false

If set to true, generation of SMAP information for JSR 45 debugging is suppressed.

trimSpaces

false

If set to true, trims white spaces in template text between actions or directives.

usePrecompiled

false

If set to true, an accessed JSP file is not compiled. Its precompiled servlet class is used instead.

It is assumed that JSP files have been precompiled, and their corresponding servlet classes have been bundled in the web application’s WEB-INF/lib or WEB-INF/classes directory.

xpoweredBy

true

If set to true, the X-Powered-By response header is added by the generated servlet.