Package org.apache.jasper
Interface Options
- All Known Implementing Classes:
- EmbeddedServletOptions,- JspC
public interface Options
A class to hold all init parameters specific to the JSP engine.
- Author:
- Anil K. Vijendran, Hans Bergsten, Pierre Delisle
- 
Method SummaryModifier and TypeMethodDescriptionbooleanIndicates whether text strings are to be generated as char arrays.getCache()The web-application wide cache for the TagLibraryInfo tag library descriptors, used ifisCaching()returnstrue.intbooleanCompiler to use.booleanMain development flag, which enables detailed error reports with sources, as well automatic recompilation of JSPs and tag files.booleanbooleanReturns 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 booleanShould 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 Stringdefault Stringintdefault Stringdefault StringbooleanbooleanintThe maximum number of loaded jsps per web-application.intdefault booleanbooleanbooleandefault String_jspService is the name of the method that is called by HttpJspBase.service().default Stringdefault booleanbooleandefault booleandefault StringThe cache that maps URIs, resource paths and parsed TLD files for the various tag libraries 'exposed' by the web application.default booleandefault Stringdefault StringbooleanbooleanbooleanThis setting is ignored if suppressSmap() istrue.booleanboolean
- 
Method Details- 
getErrorOnUseBeanInvalidClassAttributeboolean 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
 
- 
getKeepGeneratedboolean getKeepGenerated()- Returns:
- trueto keep the generated source
 
- 
isPoolingEnabledboolean isPoolingEnabled()- Returns:
- trueif tag handler pooling is enabled,- falseotherwise.
 
- 
getMappedFileboolean getMappedFile()- Returns:
- trueif HTML mapped Servlets are supported.
 
- 
getClassDebugInfoboolean getClassDebugInfo()- Returns:
- trueif debug information in included in compiled classes.
 
- 
getCheckIntervalint getCheckInterval()- Returns:
- background compile thread check interval in seconds
 
- 
getDevelopmentboolean 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
 
- 
getDisplaySourceFragmentboolean getDisplaySourceFragment()- Returns:
- trueto include a source fragment in exception messages.
 
- 
isSmapSuppressedboolean isSmapSuppressed()- Returns:
- trueto suppress generation of SMAP info for JSR45 debugging.
 
- 
isSmapDumpedboolean isSmapDumped()This setting is ignored if suppressSmap() istrue.- Returns:
- trueto write SMAP info for JSR45 debugging to a file.
 
- 
getTrimSpacesTrimSpacesOption 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 or- TrimSpacesOption.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.
 
- 
getScratchDirFile getScratchDir()- Returns:
- the work folder
 
- 
getClassPathString getClassPath()- Returns:
- the classpath used to compile generated Servlets
 
- 
getCompilerString 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
 
- 
getCompilerTargetVMString getCompilerTargetVM()- Returns:
- the compiler target VM, e.g. 1.8.
 
- 
getCompilerSourceVMString getCompilerSourceVM()- Returns:
- the compiler source VM, e.g. 1.8.
 
- 
getCompilerClassNameString getCompilerClassName()- Returns:
- Jasper Java compiler class to use.
 
- 
getTldCacheTldCache 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.
 
- 
getJavaEncodingString getJavaEncoding()- Returns:
- Java platform encoding to generate the JSP page servlet.
 
- 
getForkboolean 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
 
- 
getJspConfigJspConfig getJspConfig()- Returns:
- JSP configuration information specified in web.xml.
 
- 
isXpoweredByboolean isXpoweredBy()- Returns:
- trueto generate a X-Powered-By response header.
 
- 
getTagPluginManagerTagPluginManager getTagPluginManager()- Returns:
- a Tag Plugin Manager
 
- 
genStringAsCharArrayboolean genStringAsCharArray()Indicates whether text strings are to be generated as char arrays.- Returns:
- trueif text strings are to be generated as char arrays,- falseotherwise
 
- 
getModificationTestIntervalint getModificationTestInterval()- Returns:
- modification test interval.
 
- 
getRecompileOnFailboolean getRecompileOnFail()- Returns:
- trueif re-compile will occur on a failure.
 
- 
isCachingboolean isCaching()- Returns:
- trueis caching is enabled (used for precompilation).
 
- 
getCacheMap<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.
 
- 
getMaxLoadedJspsint 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
 
- 
getJspIdleTimeoutint 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.
 
- 
getStrictQuoteEscapingboolean getStrictQuoteEscaping()- Returns:
- trueif the quote escaping required by section JSP.1.6 of the JSP specification should be applied to scriplet expression.
 
- 
getQuoteAttributeELboolean getQuoteAttributeEL()- Returns:
- trueif EL expressions used within attributes should have the quoting rules in JSP.1.6 applied to the expression.
 
- 
getVariableForExpressionFactory- Returns:
- the name of the variable that will be used in the generated JSP code for the expression factory
 
- 
getVariableForInstanceManager- Returns:
- the name of the variable that will be used in the generated JSP code for the instance manager
 
- 
getPoolTagsWithExtendsdefault boolean getPoolTagsWithExtends()- Returns:
- trueif tag pooling is disabled with page that uses extends.
 
- 
getStrictGetPropertydefault 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.
 
- 
getStrictWhitespacedefault boolean getStrictWhitespace()- Returns:
- trueif the strict white space rules are applied.
 
- 
getJspServletBase- Returns:
- the default base class for generated JSP Servlets
 
- 
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- 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- Returns:
- The query parameter that causes the JSP engine to just pregenerated the servlet but not invoke it.
 
- 
getGeneratedJspPackageName- Returns:
- The default package name for compiled jsp pages.
 
- 
getGeneratedTagFilePackageName- Returns:
- The default package name for tag handlers generated from tag files.
 
- 
getTempVariableNamePrefix- Returns:
- Prefix to use for generated temporary variable names
 
- 
getUseInstanceManagerForTagsdefault boolean getUseInstanceManagerForTags()- Returns:
- trueif the container instance manager will be used to create the bean instances
 
- 
getGeneratedJavaAddTimestampdefault 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
 
 
-