Package org.apache.jasper
Class JspC
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.jasper.JspC
Shell for the jspc compiler. Handles all options associated with the
command line and creates compilation contexts which it then compiles
according to the specified options.
This version can process files from a _single_ webapp at once, i.e.
a single docbase can be specified.
It can be used as an Ant task using:
<taskdef classname="org.apache.jasper.JspC" name="jasper" > <classpath> <pathelement location="${java.home}/../lib/tools.jar"/> <fileset dir="${ENV.CATALINA_HOME}/lib"> <include name="*.jar"/> </fileset> <path refid="myjars"/> </classpath> </taskdef> <jasper verbose="0" package="my.package" uriroot="${webapps.dir}/${webapp.name}" webXmlFragment="${build.dir}/generated_web.xml" outputDir="${webapp.dir}/${webapp.name}/WEB-INF/src/my/package" />
- Author:
- Danno Ferrin, Pierre Delisle, Costin Manolache, Yoav Shapira
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
protected static final int
protected int
protected String[]
protected boolean
protected final Map<String,
TagLibraryInfo> protected boolean
protected boolean
protected String
protected boolean
protected String
protected String
protected String
protected JspCServletContext
The servlet context.protected static final int
static final String
protected int
protected boolean
Needs better documentation, this data member does.The file extensions to be handled as JSP files.protected boolean
protected boolean
Throw an exception if there's a compilation error, or swallow it.protected static final int
protected boolean
protected boolean
protected boolean
protected String
protected static final int
protected String
The java file encoding.protected JspConfig
protected static final String
protected boolean
protected ClassLoader
protected Writer
protected boolean
protected CharArrayWriter
protected static final int
The pages.protected boolean
protected boolean
protected JspRuntimeContext
The runtime context.protected TldScanner
protected File
protected CharArrayWriter
protected static final String
protected boolean
protected boolean
protected boolean
protected boolean
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected TagPluginManager
protected String
protected String
protected int
The number of threads to use; default is one per coreprotected TldCache
Cache for the TLD locationsprotected boolean
protected String
protected String
protected boolean
protected boolean
protected boolean
protected String
protected String
protected int
protected boolean
Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapper
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
addExtension
(String extension) Adds the given file extension to the list of extensions handled as JSP files.protected void
void
execute()
Executes the compilation.void
generateWebMapping
(String file, JspCompilationContext clctxt) Adds servlet declaration and mapping for the JSP page servlet to the generated web.xml fragment.boolean
Indicates whether text strings are to be generated as char arrays.getCache()
The web-application wide cache for the TagLibraryInfo tag library descriptors, used ifOptions.isCaching()
returnstrue
.int
In JspC this always returns0
.boolean
Compiler to use.boolean
In JspC this always returnsfalse
.boolean
In JspC this always returnstrue
.boolean
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 the list of file extensions that are treated as JSP files.boolean
boolean
getFork()
The boolean flag to tell Ant whether to fork JSP page compilations.Gets the class-id value that is sent to Internet Explorer when using <jsp:plugin> tags.Returns the encoding to use for java files.int
boolean
In JspC this always returnstrue
.boolean
int
The maximum number of loaded jsps per web-application.int
In JspC this always returns0
.boolean
boolean
In JspC this always returnsfalse
.boolean
int
The cache that maps URIs, resource paths and parsed TLD files for the various tag libraries 'exposed' by the web application.boolean
protected ClassLoader
Initializes the classloader as/if needed for the given compilation context.protected void
initServletContext
(ClassLoader classLoader) protected void
initTldScanner
(JspCServletContext context, ClassLoader classLoader) protected void
boolean
boolean
boolean
boolean
This setting is ignored if suppressSmap() istrue
.boolean
boolean
boolean
boolean
protected void
Find the WEB-INF dir by looking up in the directory tree.static void
protected void
Include the generated web.xml inside the webapp's web.xml.protected TldScanner
newTldScanner
(JspCServletContext context, boolean namespaceAware, boolean validate, boolean blockExternal) protected String
nextArg()
protected String
nextFile()
protected void
processFile
(String file) protected File
Resolves the relative or absolute pathname correctly in both Ant and command-line situations.void
Locate all jsp files in the webapp.void
Deprecated.This will be removed in Tomcat 10.void
setAddWebXmlMappings
(boolean b) Sets the option to merge generated web.xml fragment into the WEB-INF/web.xml file of the web application that we were processing.void
Apply command-line arguments.void
setBlockExternal
(boolean b) void
setCaching
(boolean caching) Sets the option to enable caching.void
setClassDebugInfo
(boolean b) Sets the option to include debug information in compiled class.void
Class name of the generated file ( without package ).void
Sets the classpath used while compiling the servlets generated from JSP filesvoid
setCompile
(boolean b) Sets the compile flag.void
Sets the option to determine what compiler to use.void
Sets the compiler source VM.void
Sets the compiler target VM.void
setErrorOnUseBeanInvalidClassAttribute
(boolean b) Sets the option to issue a compilation error if the class attribute specified in useBean action is invalid.void
setFailOnError
(boolean b) Sets the option that throws an exception in case of a compilation error.void
setFork
(boolean fork) void
setGenStringAsCharArray
(boolean genStringAsCharArray) Determines whether text strings are to be generated as char arrays, which improves performance in some cases.void
setIeClassId
(String ieClassId) Sets the class-id value to be sent to Internet Explorer when using <jsp:plugin> tags.void
setJavaEncoding
(String encodingName) Sets the encoding to use for java files.void
setJspFiles
(String jspFiles) Parses comma-separated list of JSP files to be processed.void
setListErrors
(boolean b) void
setMappedFile
(boolean b) void
void
setPackage
(String p) Sets the package name to be used for the generated servlet classes.void
setPoolingEnabled
(boolean poolingEnabled) Sets the option to enable the tag handler pooling.void
setQuoteAttributeEL
(boolean b) void
setSmapDumped
(boolean smapDumped) Sets smapDumped flag.void
setSmapSuppressed
(boolean smapSuppressed) Sets smapSuppressed flag.void
setStrictQuoteEscaping
(boolean b) void
setThreadCount
(String threadCount) void
setTrimSpaces
(boolean ts) Sets the option to remove template text that consists entirely of whitespace.void
setUriroot
(String s) Base dir for the webapp.void
setValidateTld
(boolean b) void
setValidateXml
(boolean b) void
setVerbose
(int level) Sets the verbosity level.void
File where we generate a complete web-fragment.xml with the class definitions.void
File where we generate a complete web.xml with the class definitions.void
setWebXmlEncoding
(String encoding) Sets the encoding to be used to read and write web.xml files.void
Deprecated.Will be removed in Tomcat 10.void
File where we generate configuration with the class definitions to be included in a web.xml file.void
setXpoweredBy
(boolean xpoweredBy) Sets the option to enable generation of X-Powered-By response header.Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Field Details
-
DEFAULT_IE_CLASS_ID
- See Also:
-
SWITCH_VERBOSE
- See Also:
-
SWITCH_HELP
- See Also:
-
SWITCH_OUTPUT_DIR
- See Also:
-
SWITCH_PACKAGE_NAME
- See Also:
-
SWITCH_CACHE
- See Also:
-
SWITCH_CLASS_NAME
- See Also:
-
SWITCH_FULL_STOP
- See Also:
-
SWITCH_COMPILE
- See Also:
-
SWITCH_FAIL_FAST
- See Also:
-
SWITCH_SOURCE
- See Also:
-
SWITCH_TARGET
- See Also:
-
SWITCH_URI_BASE
- See Also:
-
SWITCH_URI_ROOT
- See Also:
-
SWITCH_FILE_WEBAPP
- See Also:
-
SWITCH_WEBAPP_INC
- See Also:
-
SWITCH_WEBAPP_FRG
- See Also:
-
SWITCH_WEBAPP_XML
- See Also:
-
SWITCH_WEBAPP_XML_ENCODING
- See Also:
-
SWITCH_ADD_WEBAPP_XML_MAPPINGS
- See Also:
-
SWITCH_MAPPED
- See Also:
-
SWITCH_XPOWERED_BY
- See Also:
-
SWITCH_TRIM_SPACES
- See Also:
-
SWITCH_CLASSPATH
- See Also:
-
SWITCH_DIE
- See Also:
-
SWITCH_POOLING
- See Also:
-
SWITCH_ENCODING
- See Also:
-
SWITCH_SMAP
- See Also:
-
SWITCH_DUMP_SMAP
- See Also:
-
SWITCH_VALIDATE_TLD
- See Also:
-
SWITCH_VALIDATE_XML
- See Also:
-
SWITCH_NO_BLOCK_EXTERNAL
- See Also:
-
SWITCH_NO_STRICT_QUOTE_ESCAPING
- See Also:
-
SWITCH_QUOTE_ATTRIBUTE_EL
- See Also:
-
SWITCH_NO_QUOTE_ATTRIBUTE_EL
- See Also:
-
SWITCH_THREAD_COUNT
- See Also:
-
SHOW_SUCCESS
- See Also:
-
LIST_ERRORS
- See Also:
-
INC_WEBXML
protected static final int INC_WEBXML- See Also:
-
FRG_WEBXML
protected static final int FRG_WEBXML- See Also:
-
ALL_WEBXML
protected static final int ALL_WEBXML- See Also:
-
DEFAULT_DIE_LEVEL
protected static final int DEFAULT_DIE_LEVEL- See Also:
-
NO_DIE_LEVEL
protected static final int NO_DIE_LEVEL- See Also:
-
insertBefore
-
classPath
-
loader
-
trimSpaces
protected boolean trimSpaces -
genStringAsCharArray
protected boolean genStringAsCharArray -
validateTld
protected boolean validateTld -
validateXml
protected boolean validateXml -
blockExternal
protected boolean blockExternal -
strictQuoteEscaping
protected boolean strictQuoteEscaping -
quoteAttributeEL
protected boolean quoteAttributeEL -
xpoweredBy
protected boolean xpoweredBy -
mappedFile
protected boolean mappedFile -
poolingEnabled
protected boolean poolingEnabled -
scratchDir
-
ieClassId
-
targetPackage
-
targetClassName
-
uriBase
-
uriRoot
-
dieLevel
protected int dieLevel -
helpNeeded
protected boolean helpNeeded -
compile
protected boolean compile -
failFast
protected boolean failFast -
smapSuppressed
protected boolean smapSuppressed -
smapDumped
protected boolean smapDumped -
caching
protected boolean caching -
cache
-
compiler
-
compilerTargetVM
-
compilerSourceVM
-
classDebugInfo
protected boolean classDebugInfo -
failOnError
protected boolean failOnErrorThrow an exception if there's a compilation error, or swallow it. Default is true to preserve old behavior. -
extensions
The file extensions to be handled as JSP files. Default list is .jsp and .jspx. -
pages
The pages. -
errorOnUseBeanInvalidClassAttribute
protected boolean errorOnUseBeanInvalidClassAttributeNeeds better documentation, this data member does. True by default. -
javaEncoding
The java file encoding. Default is UTF-8. Added per bugzilla 19622. -
threadCount
protected int threadCountThe number of threads to use; default is one per core -
webxmlFile
-
webxmlLevel
protected int webxmlLevel -
webxmlEncoding
-
addWebXmlMappings
protected boolean addWebXmlMappings -
mapout
-
servletout
-
mappingout
-
context
The servlet context. -
rctxt
The runtime context. Maintain a dummy JspRuntimeContext for compiling tag files. -
tldCache
Cache for the TLD locations -
jspConfig
-
tagPluginManager
-
scanner
-
verbose
protected boolean verbose -
listErrors
protected boolean listErrors -
showSuccess
protected boolean showSuccess -
argPos
protected int argPos -
fullstop
protected boolean fullstop -
args
-
-
Constructor Details
-
JspC
public JspC()
-
-
Method Details
-
main
-
setArgs
Apply command-line arguments.- Parameters:
arg
- The arguments- Throws:
JasperException
- JSPC error
-
getKeepGenerated
public boolean getKeepGenerated()In JspC this always returnstrue
.- Specified by:
getKeepGenerated
in interfaceOptions
- Returns:
true
to keep the generated source
-
getTrimSpaces
public boolean getTrimSpaces()- Specified by:
getTrimSpaces
in interfaceOptions
- Returns:
true
to remove template text that consists entirely of whitespace
-
setTrimSpaces
public void setTrimSpaces(boolean ts) Sets the option to remove template text that consists entirely of whitespace.- Parameters:
ts
- New value
-
isPoolingEnabled
public boolean isPoolingEnabled()- Specified by:
isPoolingEnabled
in interfaceOptions
- Returns:
true
if tag handler pooling is enabled,false
otherwise.
-
setPoolingEnabled
public void setPoolingEnabled(boolean poolingEnabled) Sets the option to enable the tag handler pooling.- Parameters:
poolingEnabled
- New value
-
isXpoweredBy
public boolean isXpoweredBy()- Specified by:
isXpoweredBy
in interfaceOptions
- Returns:
true
to generate a X-Powered-By response header.
-
setXpoweredBy
public void setXpoweredBy(boolean xpoweredBy) Sets the option to enable generation of X-Powered-By response header.- Parameters:
xpoweredBy
- New value
-
getDisplaySourceFragment
public boolean getDisplaySourceFragment()In JspC this always returnstrue
.- Specified by:
getDisplaySourceFragment
in interfaceOptions
- Returns:
true
to include a source fragment in exception messages.
-
getMaxLoadedJsps
public int getMaxLoadedJsps()Description copied from interface:Options
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.- Specified by:
getMaxLoadedJsps
in interfaceOptions
- Returns:
- The JSP count
-
getJspIdleTimeout
public int getJspIdleTimeout()- Specified by:
getJspIdleTimeout
in 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.
-
getErrorOnUseBeanInvalidClassAttribute
public boolean getErrorOnUseBeanInvalidClassAttribute()Description copied from interface:Options
Returns 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:
getErrorOnUseBeanInvalidClassAttribute
in interfaceOptions
- Returns:
true
to get an error
-
setErrorOnUseBeanInvalidClassAttribute
public void setErrorOnUseBeanInvalidClassAttribute(boolean b) Sets the option to issue a compilation error if the class attribute specified in useBean action is invalid.- Parameters:
b
- New value
-
getMappedFile
public boolean getMappedFile()- Specified by:
getMappedFile
in interfaceOptions
- Returns:
true
if HTML mapped Servlets are supported.
-
setMappedFile
public void setMappedFile(boolean b) -
setClassDebugInfo
public void setClassDebugInfo(boolean b) Sets the option to include debug information in compiled class.- Parameters:
b
- New value
-
getClassDebugInfo
public boolean getClassDebugInfo()- Specified by:
getClassDebugInfo
in interfaceOptions
- Returns:
true
if debug information in included in compiled classes.
-
isCaching
public boolean isCaching() -
setCaching
public void setCaching(boolean caching) Sets the option to enable caching.- Parameters:
caching
- New value- See Also:
-
getCache
Description copied from interface:Options
The 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).
-
getCheckInterval
public int getCheckInterval()In JspC this always returns0
.- Specified by:
getCheckInterval
in interfaceOptions
- Returns:
- background compile thread check interval in seconds
-
getModificationTestInterval
public int getModificationTestInterval()In JspC this always returns0
.- Specified by:
getModificationTestInterval
in interfaceOptions
- Returns:
- modification test interval.
-
getRecompileOnFail
public boolean getRecompileOnFail()In JspC this always returnsfalse
.- Specified by:
getRecompileOnFail
in interfaceOptions
- Returns:
true
if re-compile will occur on a failure.
-
getDevelopment
public boolean getDevelopment()In JspC this always returnsfalse
. Main development flag, which enables detailed error reports with sources, as well automatic recompilation of JSPs and tag files. This setting should usually befalse
when running in production.- Specified by:
getDevelopment
in interfaceOptions
- Returns:
true
if Jasper is in development mode
-
isSmapSuppressed
public boolean isSmapSuppressed()- Specified by:
isSmapSuppressed
in interfaceOptions
- Returns:
true
to suppress generation of SMAP info for JSR45 debugging.
-
setSmapSuppressed
public void setSmapSuppressed(boolean smapSuppressed) Sets smapSuppressed flag.- Parameters:
smapSuppressed
- New value
-
isSmapDumped
public boolean isSmapDumped()Description copied from interface:Options
This setting is ignored if suppressSmap() istrue
.- Specified by:
isSmapDumped
in interfaceOptions
- Returns:
true
to write SMAP info for JSR45 debugging to a file.
-
setSmapDumped
public void setSmapDumped(boolean smapDumped) Sets smapDumped flag.- Parameters:
smapDumped
- New value- See Also:
-
setGenStringAsCharArray
public void setGenStringAsCharArray(boolean genStringAsCharArray) Determines whether text strings are to be generated as char arrays, which improves performance in some cases.- Parameters:
genStringAsCharArray
- true if text strings are to be generated as char arrays, false otherwise
-
genStringAsCharArray
public boolean genStringAsCharArray()Description copied from interface:Options
Indicates whether text strings are to be generated as char arrays.- Specified by:
genStringAsCharArray
in interfaceOptions
- Returns:
true
if text strings are to be generated as char arrays,false
otherwise
-
setIeClassId
Sets the class-id value to be sent to Internet Explorer when using <jsp:plugin> tags.- Parameters:
ieClassId
- Class-id value
-
getIeClassId
Description copied from interface:Options
Gets the class-id value that is sent to Internet Explorer when using <jsp:plugin> tags.- Specified by:
getIeClassId
in interfaceOptions
- Returns:
- Class-id value
-
getScratchDir
- Specified by:
getScratchDir
in interfaceOptions
- Returns:
- the work folder
-
getCompiler
Description copied from interface:Options
Compiler to use.If
null
(the default), the java compiler from Eclipse JDT project, bundled with Tomcat, will be used. Otherwise, thejavac
task 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.- Specified by:
getCompiler
in interfaceOptions
- Returns:
- the compiler name
-
setCompiler
Sets the option to determine what compiler to use.- Parameters:
c
- New value- See Also:
-
getCompilerClassName
- Specified by:
getCompilerClassName
in interfaceOptions
- Returns:
- Jasper Java compiler class to use.
-
getCompilerTargetVM
- Specified by:
getCompilerTargetVM
in interfaceOptions
- Returns:
- the compiler target VM, e.g. 1.8.
-
setCompilerTargetVM
Sets the compiler target VM.- Parameters:
vm
- New value- See Also:
-
getCompilerSourceVM
- Specified by:
getCompilerSourceVM
in interfaceOptions
- Returns:
- the compiler source VM, e.g. 1.8.
-
setCompilerSourceVM
Sets the compiler source VM.- Parameters:
vm
- New value- See Also:
-
getTldCache
Description copied from interface:Options
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).- Specified by:
getTldCache
in interfaceOptions
- Returns:
- the instance of the TldLocationsCache for the web-application.
-
getJavaEncoding
Returns the encoding to use for java files. The default is UTF-8.- Specified by:
getJavaEncoding
in interfaceOptions
- Returns:
- String The encoding
-
setJavaEncoding
Sets the encoding to use for java files.- Parameters:
encodingName
- The name, e.g. "UTF-8"
-
getFork
public boolean getFork()Description copied from interface:Options
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
javac
Apache Ant task). -
setFork
public void setFork(boolean fork) -
getClassPath
- Specified by:
getClassPath
in interfaceOptions
- Returns:
- the classpath used to compile generated Servlets
-
setClassPath
Sets the classpath used while compiling the servlets generated from JSP files- Parameters:
s
- New value
-
getExtensions
Returns the list of file extensions that are treated as JSP files.- Returns:
- The list of extensions
-
addExtension
Adds the given file extension to the list of extensions handled as JSP files.- Parameters:
extension
- The extension to add, e.g. "myjsp"
-
setUriroot
Base dir for the webapp. Used to generate class names and resolve includes.- Parameters:
s
- New value
-
setJspFiles
Parses comma-separated list of JSP files to be processed. If the argument is null, nothing is done.Each file is interpreted relative to uriroot, unless it is absolute, in which case it must start with uriroot.
- Parameters:
jspFiles
- Comma-separated list of JSP files to be processed
-
setCompile
public void setCompile(boolean b) Sets the compile flag.- Parameters:
b
- Flag value
-
setVerbose
public void setVerbose(int level) Sets the verbosity level. The actual number doesn't matter: if it's greater than zero, the verbose flag will be true.- Parameters:
level
- Positive means verbose
-
setValidateTld
public void setValidateTld(boolean b) -
isValidateTld
public boolean isValidateTld() -
setValidateXml
public void setValidateXml(boolean b) -
isValidateXml
public boolean isValidateXml() -
setBlockExternal
public void setBlockExternal(boolean b) -
isBlockExternal
public boolean isBlockExternal() -
setStrictQuoteEscaping
public void setStrictQuoteEscaping(boolean b) -
getStrictQuoteEscaping
public boolean getStrictQuoteEscaping()- Specified by:
getStrictQuoteEscaping
in interfaceOptions
- Returns:
true
if the quote escaping required by section JSP.1.6 of the JSP specification should be applied to scriplet expression.
-
setQuoteAttributeEL
public void setQuoteAttributeEL(boolean b) -
getQuoteAttributeEL
public boolean getQuoteAttributeEL()- Specified by:
getQuoteAttributeEL
in interfaceOptions
- Returns:
true
if EL expressions used within attributes should have the quoting rules in JSP.1.6 applied to the expression.
-
getThreadCount
public int getThreadCount() -
setThreadCount
-
setListErrors
public void setListErrors(boolean b) -
setOutputDir
-
setPackage
Sets the package name to be used for the generated servlet classes.- Parameters:
p
- New value
-
setClassName
Class name of the generated file ( without package ). Can only be used if a single file is converted. XXX Do we need this feature ?- Parameters:
p
- New value
-
setWebXmlFragment
Deprecated.Will be removed in Tomcat 10. UsesetWebXmlInclude(String)
File where we generate a web.xml fragment with the class definitions.- Parameters:
s
- New value
-
setWebXmlInclude
File where we generate configuration with the class definitions to be included in a web.xml file.- Parameters:
s
- New value
-
setWebFragmentXml
File where we generate a complete web-fragment.xml with the class definitions.- Parameters:
s
- New value
-
setWebXml
File where we generate a complete web.xml with the class definitions.- Parameters:
s
- New value
-
setWebXmlEncoding
Sets the encoding to be used to read and write web.xml files.If not specified, defaults to UTF-8.
- Parameters:
encoding
- Encoding, e.g. "UTF-8".
-
setAddWebXmlMappings
public void setAddWebXmlMappings(boolean b) Sets the option to merge generated web.xml fragment into the WEB-INF/web.xml file of the web application that we were processing.- Parameters:
b
-true
to merge the fragment into the existing web.xml file of the processed web application ({uriroot}/WEB-INF/web.xml),false
to keep the generated web.xml fragment
-
setFailOnError
public void setFailOnError(boolean b) Sets the option that throws an exception in case of a compilation error.- Parameters:
b
- New value
-
getFailOnError
public boolean getFailOnError()- Returns:
true
if an exception will be thrown in case of a compilation error.
-
getJspConfig
- Specified by:
getJspConfig
in interfaceOptions
- Returns:
- JSP configuration information specified in web.xml.
-
getTagPluginManager
- Specified by:
getTagPluginManager
in interfaceOptions
- Returns:
- a Tag Plugin Manager
-
generateWebMapping
Adds servlet declaration and mapping for the JSP page servlet to the generated web.xml fragment.- Parameters:
file
- Context-relative path to the JSP file, e.g./index.jsp
clctxt
- Compilation context of the servlet- Throws:
IOException
- An IO error occurred
-
mergeIntoWebXml
Include the generated web.xml inside the webapp's web.xml.- Throws:
IOException
- An IO error occurred
-
processFile
- Throws:
JasperException
-
scanFiles
Deprecated.This will be removed in Tomcat 10. UsescanFiles()
Locate all jsp files in the webapp. Used if no explicit jsps are specified.- Parameters:
base
- Base path
-
scanFiles
public void scanFiles()Locate all jsp files in the webapp. Used if no explicit jsps are specified. Scan is performed via the ServletContext and will include any JSPs located in resource JARs. -
execute
public void execute()Executes the compilation.- Overrides:
execute
in classorg.apache.tools.ant.Task
-
nextArg
-
nextFile
-
initWebXml
- Throws:
JasperException
-
completeWebXml
protected void completeWebXml() -
initTldScanner
-
newTldScanner
protected TldScanner newTldScanner(JspCServletContext context, boolean namespaceAware, boolean validate, boolean blockExternal) -
initServletContext
- Throws:
IOException
JasperException
-
initClassLoader
Initializes the classloader as/if needed for the given compilation context.- Returns:
- the classloader that will be used
- Throws:
IOException
- If an error occurs
-
locateUriRoot
Find the WEB-INF dir by looking up in the directory tree. This is used if no explicit docbase is set, but only files.- Parameters:
f
- The path from which it will start looking
-
resolveFile
Resolves the relative or absolute pathname correctly in both Ant and command-line situations. If Ant launched us, we should use the basedir of the current project to resolve relative paths. See Bugzilla 35571.- Parameters:
s
- The file- Returns:
- The file resolved
-