Package org.apache.jasper
Class EmbeddedServletOptions
- java.lang.Object
-
- org.apache.jasper.EmbeddedServletOptions
-
-
Field Summary
Fields Modifier and Type Field Description booleanforkShould Ant fork its java compiles of JSP pages.
-
Constructor Summary
Constructors Constructor Description EmbeddedServletOptions(ServletConfig config, ServletContext context)Create an EmbeddedServletOptions object using data available from ServletConfig and ServletContext.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleangenStringAsCharArray()Are Text strings to be generated as char arrays?Map<String,TagLibraryInfo>getCache()The web-application wide cache for the TagLibraryInfo tag library descriptors, used ifOptions.isCaching()returnstrue.intgetCheckInterval()Background JSP compile thread check intervalbooleangetClassDebugInfo()Should class files be compiled with debug information?StringgetClassPath()What classpath should I use while compiling the servlets generated from JSP files?StringgetCompiler()Compiler to use.StringgetCompilerClassName()Java compiler class to use.StringgetCompilerSourceVM()StringgetCompilerTargetVM()booleangetDevelopment()Is Jasper being used in development mode?booleangetDisplaySourceFragment()Should we include a source fragment in exception messages, which could be displayed to the developer ?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.StringgetGeneratedJspPackageName()StringgetGeneratedTagFilePackageName()StringgetIeClassId()Deprecated.Will be removed in Tomcat 10.1StringgetJavaEncoding()JspConfiggetJspConfig()intgetJspIdleTimeout()Should any jsps be unloaded when being idle for this time in seconds?StringgetJspPrecompilationQueryParameter()StringgetJspServletBase()booleangetKeepGenerated()Are we keeping generated code around?booleangetMappedFile()Are we supporting HTML mapped servlets?intgetMaxLoadedJsps()Should jsps be unloaded if to many are loaded?intgetModificationTestInterval()Modification test interval.booleangetPoolTagsWithExtends()StringgetProperty(String name)booleangetQuoteAttributeEL()booleangetRecompileOnFail()Re-compile on failure.FilegetScratchDir()What is my scratch dir?StringgetServiceMethodName()_jspService is the name of the method that is called by HttpJspBase.service().StringgetServletClasspathAttribute()booleangetStrictGetProperty()booleangetStrictQuoteEscaping()booleangetStrictWhitespace()TagPluginManagergetTagPluginManager()StringgetTempVariableNamePrefix()TldCachegetTldCache()The cache that maps URIs, resource paths and parsed TLD files for the various tag libraries 'exposed' by the web application.TrimSpacesOptiongetTrimSpaces()booleangetUseInstanceManagerForTags()StringgetVariableForExpressionFactory()StringgetVariableForInstanceManager()booleanisCaching()booleanisPoolingEnabled()booleanisSmapDumped()Should SMAP info for JSR45 debugging be dumped to a file?booleanisSmapSuppressed()Is the generation of SMAP info for JSR45 debugging suppressed?booleanisXpoweredBy()Is generation of X-Powered-By response header enabled/disabled?voidsetErrorOnUseBeanInvalidClassAttribute(boolean b)voidsetProperty(String name, String value)voidsetQuoteAttributeEL(boolean b)voidsetTldCache(TldCache tldCache)-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.jasper.Options
getGeneratedJavaAddTimestamp
-
-
-
-
Constructor Detail
-
EmbeddedServletOptions
public EmbeddedServletOptions(ServletConfig config, ServletContext context)
Create an EmbeddedServletOptions object using data available from ServletConfig and ServletContext.- Parameters:
config- The Servlet configcontext- The Servlet context
-
-
Method Detail
-
setQuoteAttributeEL
public void setQuoteAttributeEL(boolean b)
-
getQuoteAttributeEL
public boolean getQuoteAttributeEL()
- Specified by:
getQuoteAttributeELin interfaceOptions- Returns:
trueif EL expressions used within attributes should have the quoting rules in JSP.1.6 applied to the expression.
-
getKeepGenerated
public boolean getKeepGenerated()
Are we keeping generated code around?- Specified by:
getKeepGeneratedin interfaceOptions- Returns:
trueto keep the generated source
-
getTrimSpaces
public TrimSpacesOption getTrimSpaces()
- Specified by:
getTrimSpacesin interfaceOptions- 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.
-
isPoolingEnabled
public boolean isPoolingEnabled()
- Specified by:
isPoolingEnabledin interfaceOptions- Returns:
trueif tag handler pooling is enabled,falseotherwise.
-
getMappedFile
public boolean getMappedFile()
Are we supporting HTML mapped servlets?- Specified by:
getMappedFilein interfaceOptions- Returns:
trueif HTML mapped Servlets are supported.
-
getClassDebugInfo
public boolean getClassDebugInfo()
Should class files be compiled with debug information?- Specified by:
getClassDebugInfoin interfaceOptions- Returns:
trueif debug information in included in compiled classes.
-
getCheckInterval
public int getCheckInterval()
Background JSP compile thread check interval- Specified by:
getCheckIntervalin interfaceOptions- Returns:
- background compile thread check interval in seconds
-
getModificationTestInterval
public int getModificationTestInterval()
Modification test interval.- Specified by:
getModificationTestIntervalin interfaceOptions- Returns:
- modification test interval.
-
getRecompileOnFail
public boolean getRecompileOnFail()
Re-compile on failure.- Specified by:
getRecompileOnFailin interfaceOptions- Returns:
trueif re-compile will occur on a failure.
-
getDevelopment
public boolean getDevelopment()
Is Jasper being used in development mode?- Specified by:
getDevelopmentin interfaceOptions- Returns:
trueif Jasper is in development mode
-
isSmapSuppressed
public boolean isSmapSuppressed()
Is the generation of SMAP info for JSR45 debugging suppressed?- Specified by:
isSmapSuppressedin interfaceOptions- Returns:
trueto suppress generation of SMAP info for JSR45 debugging.
-
isSmapDumped
public boolean isSmapDumped()
Should SMAP info for JSR45 debugging be dumped to a file?- Specified by:
isSmapDumpedin interfaceOptions- Returns:
trueto write SMAP info for JSR45 debugging to a file.
-
genStringAsCharArray
public boolean genStringAsCharArray()
Are Text strings to be generated as char arrays?- Specified by:
genStringAsCharArrayin interfaceOptions- Returns:
trueif text strings are to be generated as char arrays,falseotherwise
-
getIeClassId
@Deprecated public String getIeClassId()
Deprecated.Will be removed in Tomcat 10.1Class ID for use in the plugin tag when the browser is IE.- Specified by:
getIeClassIdin interfaceOptions- Returns:
- Class-id value
-
getScratchDir
public File getScratchDir()
What is my scratch dir?- Specified by:
getScratchDirin interfaceOptions- Returns:
- the work folder
-
getClassPath
public String getClassPath()
What classpath should I use while compiling the servlets generated from JSP files?- Specified by:
getClassPathin interfaceOptions- Returns:
- the classpath used to compile generated Servlets
-
isXpoweredBy
public boolean isXpoweredBy()
Is generation of X-Powered-By response header enabled/disabled?- Specified by:
isXpoweredByin interfaceOptions- Returns:
trueto generate a X-Powered-By response header.
-
getCompiler
public String getCompiler()
Compiler to use.- Specified by:
getCompilerin interfaceOptions- Returns:
- the compiler name
-
getCompilerTargetVM
public String getCompilerTargetVM()
- Specified by:
getCompilerTargetVMin interfaceOptions- Returns:
- the compiler target VM, e.g. 1.8.
- See Also:
Options.getCompilerTargetVM()
-
getCompilerSourceVM
public String getCompilerSourceVM()
- Specified by:
getCompilerSourceVMin interfaceOptions- Returns:
- the compiler source VM, e.g. 1.8.
- See Also:
Options.getCompilerSourceVM()
-
getCompilerClassName
public String getCompilerClassName()
Java compiler class to use.- Specified by:
getCompilerClassNamein interfaceOptions- Returns:
- Jasper Java compiler class to use.
-
getErrorOnUseBeanInvalidClassAttribute
public boolean getErrorOnUseBeanInvalidClassAttribute()
Description copied from interface:OptionsReturns true if Jasper issues a compilation error instead of a runtime Instantiation error if the class attribute specified in useBean action is invalid.- Specified by:
getErrorOnUseBeanInvalidClassAttributein interfaceOptions- Returns:
trueto get an error
-
setErrorOnUseBeanInvalidClassAttribute
public void setErrorOnUseBeanInvalidClassAttribute(boolean b)
-
getTldCache
public TldCache getTldCache()
Description copied from interface:OptionsThe 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).- Specified by:
getTldCachein interfaceOptions- Returns:
- the instance of the TldLocationsCache for the web-application.
-
setTldCache
public void setTldCache(TldCache tldCache)
-
getJavaEncoding
public String getJavaEncoding()
- Specified by:
getJavaEncodingin interfaceOptions- Returns:
- Java platform encoding to generate the JSP page servlet.
-
getFork
public boolean getFork()
Description copied from interface:OptionsThe 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).
-
getJspConfig
public JspConfig getJspConfig()
- Specified by:
getJspConfigin interfaceOptions- Returns:
- JSP configuration information specified in web.xml.
-
getTagPluginManager
public TagPluginManager getTagPluginManager()
- Specified by:
getTagPluginManagerin interfaceOptions- Returns:
- a Tag Plugin Manager
-
isCaching
public boolean isCaching()
-
getCache
public Map<String,TagLibraryInfo> getCache()
Description copied from interface:OptionsThe web-application wide cache for the TagLibraryInfo tag library descriptors, used ifOptions.isCaching()returnstrue.Using this cache avoids the cost of repeating the parsing of a tag library descriptor XML file (performed by TagLibraryInfoImpl.parseTLD).
-
getDisplaySourceFragment
public boolean getDisplaySourceFragment()
Should we include a source fragment in exception messages, which could be displayed to the developer ?- Specified by:
getDisplaySourceFragmentin interfaceOptions- Returns:
trueto include a source fragment in exception messages.
-
getMaxLoadedJsps
public int getMaxLoadedJsps()
Should jsps be unloaded if to many are loaded? If set to a value greater than 0 eviction of jsps is started. Default: -1- Specified by:
getMaxLoadedJspsin interfaceOptions- Returns:
- The JSP count
-
getJspIdleTimeout
public int getJspIdleTimeout()
Should any jsps be unloaded when being idle for this time in seconds? If set to a value greater than 0 eviction of jsps is started. Default: -1- Specified by:
getJspIdleTimeoutin interfaceOptions- 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
public boolean getStrictQuoteEscaping()
- Specified by:
getStrictQuoteEscapingin interfaceOptions- Returns:
trueif the quote escaping required by section JSP.1.6 of the JSP specification should be applied to scriplet expression.
-
getVariableForExpressionFactory
public String getVariableForExpressionFactory()
- Specified by:
getVariableForExpressionFactoryin interfaceOptions- Returns:
- the name of the variable that will be used in the generated JSP code for the expression factory
-
getVariableForInstanceManager
public String getVariableForInstanceManager()
- Specified by:
getVariableForInstanceManagerin interfaceOptions- Returns:
- the name of the variable that will be used in the generated JSP code for the instance manager
-
getPoolTagsWithExtends
public boolean getPoolTagsWithExtends()
- Specified by:
getPoolTagsWithExtendsin interfaceOptions- Returns:
trueif tag pooling is disabled with page that uses extends.
-
getStrictGetProperty
public boolean getStrictGetProperty()
- Specified by:
getStrictGetPropertyin interfaceOptions- 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
public boolean getStrictWhitespace()
- Specified by:
getStrictWhitespacein interfaceOptions- Returns:
trueif the strict white space rules are applied.
-
getJspServletBase
public String getJspServletBase()
- Specified by:
getJspServletBasein interfaceOptions- Returns:
- the default base class for generated JSP Servlets
-
getServiceMethodName
public String getServiceMethodName()
Description copied from interface:Options_jspService is the name of the method that is called by HttpJspBase.service(). This is where most of the code generated from JSPs go.- Specified by:
getServiceMethodNamein interfaceOptions- Returns:
- the method name
-
getServletClasspathAttribute
public String getServletClasspathAttribute()
- Specified by:
getServletClasspathAttributein interfaceOptions- 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
public String getJspPrecompilationQueryParameter()
- Specified by:
getJspPrecompilationQueryParameterin interfaceOptions- Returns:
- The query parameter that causes the JSP engine to just pregenerated the servlet but not invoke it.
-
getGeneratedJspPackageName
public String getGeneratedJspPackageName()
- Specified by:
getGeneratedJspPackageNamein interfaceOptions- Returns:
- The default package name for compiled jsp pages.
-
getGeneratedTagFilePackageName
public String getGeneratedTagFilePackageName()
- Specified by:
getGeneratedTagFilePackageNamein interfaceOptions- Returns:
- The default package name for tag handlers generated from tag files.
-
getTempVariableNamePrefix
public String getTempVariableNamePrefix()
- Specified by:
getTempVariableNamePrefixin interfaceOptions- Returns:
- Prefix to use for generated temporary variable names
-
getUseInstanceManagerForTags
public boolean getUseInstanceManagerForTags()
- Specified by:
getUseInstanceManagerForTagsin interfaceOptions- Returns:
trueif the container instance manager will be used to create the bean instances
-
-