Package org.apache.jasper
Interface Options
-
- All Known Implementing Classes:
EmbeddedServletOptions,JspC
public interface OptionsA class to hold all init parameters specific to the JSP engine.- Author:
- Anil K. Vijendran, Hans Bergsten, Pierre Delisle
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description booleangenStringAsCharArray()Indicates whether text strings are to be generated as char arrays.java.util.Map<java.lang.String,TagLibraryInfo>getCache()The web-application wide cache for the TagLibraryInfo tag library descriptors, used ifisCaching()returnstrue.intgetCheckInterval()booleangetClassDebugInfo()java.lang.StringgetClassPath()java.lang.StringgetCompiler()Compiler to use.java.lang.StringgetCompilerClassName()java.lang.StringgetCompilerSourceVM()java.lang.StringgetCompilerTargetVM()booleangetDevelopment()Main development flag, which enables detailed error reports with sources, as well automatic recompilation of JSPs and tag files.booleangetDisplaySourceFragment()booleangetErrorOnUseBeanInvalidClassAttribute()Returns true if Jasper issues a compilation error instead of a runtime Instantiation error if the class attribute specified in useBean action is invalid.booleangetFork()The boolean flag to tell Ant whether to fork JSP page compilations.default booleangetGeneratedJavaAddTimestamp()Should the container include the time the file was generated in the comments at the start of a Java file generated from a JSP or tag.default java.lang.StringgetGeneratedJspPackageName()default java.lang.StringgetGeneratedTagFilePackageName()java.lang.StringgetIeClassId()Deprecated.Will be removed in Tomcat 10.1.xjava.lang.StringgetJavaEncoding()JspConfiggetJspConfig()intgetJspIdleTimeout()default java.lang.StringgetJspPrecompilationQueryParameter()default java.lang.StringgetJspServletBase()booleangetKeepGenerated()booleangetMappedFile()intgetMaxLoadedJsps()The maximum number of loaded jsps per web-application.intgetModificationTestInterval()default booleangetPoolTagsWithExtends()booleangetQuoteAttributeEL()booleangetRecompileOnFail()java.io.FilegetScratchDir()default java.lang.StringgetServiceMethodName()_jspService is the name of the method that is called by HttpJspBase.service().default java.lang.StringgetServletClasspathAttribute()default booleangetStrictGetProperty()booleangetStrictQuoteEscaping()default booleangetStrictWhitespace()TagPluginManagergetTagPluginManager()default java.lang.StringgetTempVariableNamePrefix()TldCachegetTldCache()The cache that maps URIs, resource paths and parsed TLD files for the various tag libraries 'exposed' by the web application.TrimSpacesOptiongetTrimSpaces()default booleangetUseInstanceManagerForTags()default java.lang.StringgetVariableForExpressionFactory()default java.lang.StringgetVariableForInstanceManager()booleanisCaching()booleanisPoolingEnabled()booleanisSmapDumped()This setting is ignored if suppressSmap() istrue.booleanisSmapSuppressed()booleanisXpoweredBy()
-
-
-
Method Detail
-
getErrorOnUseBeanInvalidClassAttribute
boolean getErrorOnUseBeanInvalidClassAttribute()
Returns true if Jasper issues a compilation error instead of a runtime Instantiation error if the class attribute specified in useBean action is invalid.- Returns:
trueto get an error
-
getKeepGenerated
boolean getKeepGenerated()
- Returns:
trueto keep the generated source
-
isPoolingEnabled
boolean isPoolingEnabled()
- Returns:
trueif tag handler pooling is enabled,falseotherwise.
-
getMappedFile
boolean getMappedFile()
- Returns:
trueif HTML mapped Servlets are supported.
-
getClassDebugInfo
boolean getClassDebugInfo()
- Returns:
trueif debug information in included in compiled classes.
-
getCheckInterval
int getCheckInterval()
- Returns:
- background compile thread check interval in seconds
-
getDevelopment
boolean getDevelopment()
Main development flag, which enables detailed error reports with sources, as well automatic recompilation of JSPs and tag files. This setting should usually befalsewhen running in production.- Returns:
trueif Jasper is in development mode
-
getDisplaySourceFragment
boolean getDisplaySourceFragment()
- Returns:
trueto include a source fragment in exception messages.
-
isSmapSuppressed
boolean isSmapSuppressed()
- Returns:
trueto suppress generation of SMAP info for JSR45 debugging.
-
isSmapDumped
boolean isSmapDumped()
This setting is ignored if suppressSmap() istrue.- Returns:
trueto write SMAP info for JSR45 debugging to a file.
-
getTrimSpaces
TrimSpacesOption getTrimSpaces()
- Returns:
TrimSpacesOption.TRUEto remove template text that consists only of whitespace from the output completely,TrimSpacesOption.SINGLEto replace such template text with a single space,TrimSpacesOption.FALSEto leave such template text unchanged orTrimSpacesOption.EXTENDEDto remove template text that consists only of whitespace and to replace any sequence of whitespace and new lines within template text with a single new line.
-
getIeClassId
@Deprecated java.lang.String getIeClassId()
Deprecated.Will be removed in Tomcat 10.1.xGets the class-id value that is sent to Internet Explorer when using <jsp:plugin> tags.- Returns:
- Class-id value
-
getScratchDir
java.io.File getScratchDir()
- Returns:
- the work folder
-
getClassPath
java.lang.String getClassPath()
- Returns:
- the classpath used to compile generated Servlets
-
getCompiler
java.lang.String getCompiler()
Compiler to use.If
null(the default), the java compiler from Eclipse JDT project, bundled with Tomcat, will be used. Otherwise, thejavactask from Apache Ant will be used to call an external java compiler and the value of this option will be passed to it. See Apache Ant documentation for the possible values.- Returns:
- the compiler name
-
getCompilerTargetVM
java.lang.String getCompilerTargetVM()
- Returns:
- the compiler target VM, e.g. 1.8.
-
getCompilerSourceVM
java.lang.String getCompilerSourceVM()
- Returns:
- the compiler source VM, e.g. 1.8.
-
getCompilerClassName
java.lang.String getCompilerClassName()
- Returns:
- Jasper Java compiler class to use.
-
getTldCache
TldCache getTldCache()
The cache that maps URIs, resource paths and parsed TLD files for the various tag libraries 'exposed' by the web application. A tag library is 'exposed' either explicitly in web.xml or implicitly via the uri tag in the TLD of a taglib deployed in a jar file (WEB-INF/lib).- Returns:
- the instance of the TldLocationsCache for the web-application.
-
getJavaEncoding
java.lang.String getJavaEncoding()
- Returns:
- Java platform encoding to generate the JSP page servlet.
-
getFork
boolean getFork()
The boolean flag to tell Ant whether to fork JSP page compilations.Is used only when Jasper uses an external java compiler (wrapped through a
javacApache Ant task).- Returns:
trueto fork a process during compilation
-
getJspConfig
JspConfig getJspConfig()
- Returns:
- JSP configuration information specified in web.xml.
-
isXpoweredBy
boolean isXpoweredBy()
- Returns:
trueto generate a X-Powered-By response header.
-
getTagPluginManager
TagPluginManager getTagPluginManager()
- Returns:
- a Tag Plugin Manager
-
genStringAsCharArray
boolean genStringAsCharArray()
Indicates whether text strings are to be generated as char arrays.- Returns:
trueif text strings are to be generated as char arrays,falseotherwise
-
getModificationTestInterval
int getModificationTestInterval()
- Returns:
- modification test interval.
-
getRecompileOnFail
boolean getRecompileOnFail()
- Returns:
trueif re-compile will occur on a failure.
-
isCaching
boolean isCaching()
- Returns:
trueis caching is enabled (used for precompilation).
-
getCache
java.util.Map<java.lang.String,TagLibraryInfo> getCache()
The web-application wide cache for the TagLibraryInfo tag library descriptors, used ifisCaching()returnstrue.Using this cache avoids the cost of repeating the parsing of a tag library descriptor XML file (performed by TagLibraryInfoImpl.parseTLD).
- Returns:
- the Map(String uri, TagLibraryInfo tld) instance.
-
getMaxLoadedJsps
int getMaxLoadedJsps()
The maximum number of loaded jsps per web-application. If there are more jsps loaded, they will be unloaded. If unset or less than 0, no jsps are unloaded.- Returns:
- The JSP count
-
getJspIdleTimeout
int getJspIdleTimeout()
- Returns:
- the idle time in seconds after which a JSP is unloaded. If unset or less or equal than 0, no jsps are unloaded.
-
getStrictQuoteEscaping
boolean getStrictQuoteEscaping()
- Returns:
trueif the quote escaping required by section JSP.1.6 of the JSP specification should be applied to scriplet expression.
-
getQuoteAttributeEL
boolean getQuoteAttributeEL()
- Returns:
trueif EL expressions used within attributes should have the quoting rules in JSP.1.6 applied to the expression.
-
getVariableForExpressionFactory
default java.lang.String getVariableForExpressionFactory()
- Returns:
- the name of the variable that will be used in the generated JSP code for the expression factory
-
getVariableForInstanceManager
default java.lang.String getVariableForInstanceManager()
- Returns:
- the name of the variable that will be used in the generated JSP code for the instance manager
-
getPoolTagsWithExtends
default boolean getPoolTagsWithExtends()
- Returns:
trueif tag pooling is disabled with page that uses extends.
-
getStrictGetProperty
default boolean getStrictGetProperty()
- Returns:
trueif the requirement to have the object used in jsp:getProperty action to be previously "introduced" to the JSP processor (see JSP.5.3) is enforced.
-
getStrictWhitespace
default boolean getStrictWhitespace()
- Returns:
trueif the strict white space rules are applied.
-
getJspServletBase
default java.lang.String getJspServletBase()
- Returns:
- the default base class for generated JSP Servlets
-
getServiceMethodName
default java.lang.String getServiceMethodName()
_jspService is the name of the method that is called by HttpJspBase.service(). This is where most of the code generated from JSPs go.- Returns:
- the method name
-
getServletClasspathAttribute
default java.lang.String getServletClasspathAttribute()
- Returns:
- ServletContext attribute for classpath. This is tomcat specific. Other servlet engines may choose to support this attribute if they want to have this JSP engine running on them.
-
getJspPrecompilationQueryParameter
default java.lang.String getJspPrecompilationQueryParameter()
- Returns:
- The query parameter that causes the JSP engine to just pregenerated the servlet but not invoke it.
-
getGeneratedJspPackageName
default java.lang.String getGeneratedJspPackageName()
- Returns:
- The default package name for compiled jsp pages.
-
getGeneratedTagFilePackageName
default java.lang.String getGeneratedTagFilePackageName()
- Returns:
- The default package name for tag handlers generated from tag files.
-
getTempVariableNamePrefix
default java.lang.String getTempVariableNamePrefix()
- Returns:
- Prefix to use for generated temporary variable names
-
getUseInstanceManagerForTags
default boolean getUseInstanceManagerForTags()
- Returns:
trueif the container instance manager will be used to create the bean instances
-
getGeneratedJavaAddTimestamp
default boolean getGeneratedJavaAddTimestamp()
Should the container include the time the file was generated in the comments at the start of a Java file generated from a JSP or tag. Defaults totrue.- Returns:
trueto include the timestamp, otherwise don't include it
-
-