org.apache.jasper
Class JspC

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.apache.jasper.JspC

All Implemented Interfaces:

Cloneable, Options

public class JspC
extends org.apache.tools.ant.Task
implements Options

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

protected boolean	addWebXmlMappings
protected static int	ALL_WEBXML
protected int	argPos
protected String[]	args
protected Map<String,TagLibraryInfo>	cache
protected boolean	caching
protected boolean	classDebugInfo
protected String	classPath
protected boolean	compile
protected String	compiler
protected String	compilerSourceVM
protected String	compilerTargetVM
protected JspCServletContext	context The servlet context.
protected static int	DEFAULT_DIE_LEVEL
static String	DEFAULT_IE_CLASS_ID
protected int	dieLevel
protected boolean	errorOnUseBeanInvalidClassAttribute Needs better documentation, this data member does.
protected List<String>	extensions The file extensions to be handled as JSP files.
protected boolean	failOnError Throw an exception if there's a compilation error, or swallow it.
protected boolean	fullstop
protected boolean	genStringAsCharArray
protected boolean	helpNeeded
protected String	ieClassId
protected static int	INC_WEBXML
protected static Set<String>	insertBefore
protected String	javaEncoding The java file encoding.
protected JspConfig	jspConfig
protected static String	LIST_ERRORS
protected boolean	listErrors
protected URLClassLoader	loader
protected Writer	mapout
protected boolean	mappedFile
protected CharArrayWriter	mappingout
protected static int	NO_DIE_LEVEL
protected List<String>	pages The pages.
protected boolean	poolingEnabled
protected JspRuntimeContext	rctxt The runtime context.
protected File	scratchDir
protected CharArrayWriter	servletout
protected static String	SHOW_SUCCESS
protected boolean	showSuccess
protected boolean	smapDumped
protected boolean	smapSuppressed
protected static String	SWITCH_ADD_WEBAPP_XML_MAPPINGS
protected static String	SWITCH_CACHE
protected static String	SWITCH_CLASS_NAME
protected static String	SWITCH_CLASSPATH
protected static String	SWITCH_COMPILE
protected static String	SWITCH_DIE
protected static String	SWITCH_DUMP_SMAP
protected static String	SWITCH_ENCODING
protected static String	SWITCH_FILE_WEBAPP
protected static String	SWITCH_FULL_STOP
protected static String	SWITCH_HELP
protected static String	SWITCH_MAPPED
protected static String	SWITCH_OUTPUT_DIR
protected static String	SWITCH_PACKAGE_NAME
protected static String	SWITCH_POOLING
protected static String	SWITCH_SMAP
protected static String	SWITCH_SOURCE
protected static String	SWITCH_TARGET
protected static String	SWITCH_TRIM_SPACES
protected static String	SWITCH_URI_BASE
protected static String	SWITCH_URI_ROOT
protected static String	SWITCH_VERBOSE
protected static String	SWITCH_WEBAPP_INC
protected static String	SWITCH_WEBAPP_XML
protected static String	SWITCH_WEBAPP_XML_ENCODING
protected static String	SWITCH_XPOWERED_BY
protected TagPluginManager	tagPluginManager
protected String	targetClassName
protected String	targetPackage
protected TldLocationsCache	tldLocationsCache Cache for the TLD locations
protected boolean	trimSpaces
protected String	uriBase
protected String	uriRoot
protected boolean	verbose
protected String	webxmlEncoding
protected String	webxmlFile
protected int	webxmlLevel
protected boolean	xpoweredBy

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

JspC()

Method Summary

protected void	addExtension(String extension) Adds the given file extension to the list of extensions handled as JSP files.
protected void	completeWebXml()
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	genStringAsCharArray() Indicates whether text strings are to be generated as char arrays.
Map<String,TagLibraryInfo>	getCache() The web-application wide cache for the TagLibraryInfo tag library descriptors, used if Options.isCaching() returns true.
int	getCheckInterval() In JspC this always returns 0.
boolean	getClassDebugInfo() Should we include debug information in compiled class?
String	getClassPath() What classpath should I use while compiling the servlets generated from JSP files?
String	getCompiler() Compiler to use.
String	getCompilerClassName() Jasper Java compiler class to use.
String	getCompilerSourceVM() The compiler source VM, e.g. 1.3, 1.4, 1.5 or 1.6.
String	getCompilerTargetVM() The compiler target VM, e.g. 1.1, 1.2, 1.3, 1.4, 1.5 or 1.6.
boolean	getDevelopment() In JspC this always returns false.
boolean	getDisplaySourceFragment() In JspC this always returns true.
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.
List<String>	getExtensions() Returns the list of file extensions that are treated as JSP files.
boolean	getFailOnError() Returns true if an exception will be thrown in case of a compilation error.
boolean	getFork() The boolean flag to tell Ant whether to fork JSP page compilations.
String	getIeClassId() Gets the class-id value that is sent to Internet Explorer when using <jsp:plugin> tags.
String	getJavaEncoding() Returns the encoding to use for java files.
JspConfig	getJspConfig() Obtain JSP configuration information specified in web.xml.
int	getJspIdleTimeout() The idle time in seconds after which a JSP is unloaded.
boolean	getKeepGenerated() In JspC this always returns true.
boolean	getMappedFile() Are we supporting HTML mapped servlets?
int	getMaxLoadedJsps() The maximum number of loaded jsps per web-application.
int	getModificationTestInterval() In JspC this always returns 0.
boolean	getRecompileOnFail() In JspC this always returns false.
File	getScratchDir() What is my scratch dir?
TagPluginManager	getTagPluginManager() Obtain a Tag Plugin Manager
TldLocationsCache	getTldLocationsCache() The cache for the location of the TLD's for the various tag libraries 'exposed' by the web application.
boolean	getTrimSpaces() Should white spaces between directives or actions be trimmed?
protected void	initClassLoader(JspCompilationContext clctxt) Initializes the classloader as/if needed for the given compilation context.
protected void	initServletContext()
protected void	initWebXml()
boolean	isCaching() Is caching enabled (used for precompilation).
boolean	isPoolingEnabled() Returns true if tag handler pooling is enabled, false otherwise.
boolean	isSmapDumped() Indicates whether SMAP info for JSR45 debugging should be dumped to a file.
boolean	isSmapSuppressed() Is the generation of SMAP info for JSR45 debugging suppressed?
boolean	isXpoweredBy() Is generation of X-Powered-By response header enabled/disabled?
protected void	locateUriRoot(File f) Find the WEB-INF dir by looking up in the directory tree.
static void	main(String[] arg)
protected void	mergeIntoWebXml() Include the generated web.xml inside the webapp's web.xml.
protected String	nextArg()
protected String	nextFile()
protected void	processFile(String file)
protected File	resolveFile(String s) Resolves the relative or absolute pathname correctly in both Ant and command-line situations.
void	scanFiles(File base) Locate all jsp files in the webapp.
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	setArgs(String[] arg) Apply command-line arguments.
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	setClassName(String p) Class name of the generated file ( without package ).
void	setClassPath(String s) Sets the classpath used while compiling the servlets generated from JSP files
void	setCompile(boolean b) Sets the compile flag.
void	setCompiler(String c) Sets the option to determine what compiler to use.
void	setCompilerSourceVM(String vm) Sets the compiler source VM.
void	setCompilerTargetVM(String vm) 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	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	setOutputDir(String s)
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	setSmapDumped(boolean smapDumped) Sets smapDumped flag.
void	setSmapSuppressed(boolean smapSuppressed) Sets smapSuppressed flag.
void	setTrimSpaces(boolean ts) Sets the option to trim white spaces between directives or actions.
void	setUriroot(String s) Base dir for the webapp.
void	setValidateXml(boolean b)
void	setVerbose(int level) Sets the verbosity level.
void	setWebXml(String s) 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	setWebXmlFragment(String s) File where we generate a web.xml fragment with the class definitions.
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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_IE_CLASS_ID

public static final String DEFAULT_IE_CLASS_ID

See Also:

Constant Field Values

SWITCH_VERBOSE

protected static final String SWITCH_VERBOSE

See Also:

Constant Field Values

SWITCH_HELP

protected static final String SWITCH_HELP

See Also:

Constant Field Values

SWITCH_OUTPUT_DIR

protected static final String SWITCH_OUTPUT_DIR

See Also:

Constant Field Values

SWITCH_PACKAGE_NAME

protected static final String SWITCH_PACKAGE_NAME

See Also:

Constant Field Values

SWITCH_CACHE

protected static final String SWITCH_CACHE

See Also:

Constant Field Values

SWITCH_CLASS_NAME

protected static final String SWITCH_CLASS_NAME

See Also:

Constant Field Values

SWITCH_FULL_STOP

protected static final String SWITCH_FULL_STOP

See Also:

Constant Field Values

SWITCH_COMPILE

protected static final String SWITCH_COMPILE

See Also:

Constant Field Values

SWITCH_SOURCE

protected static final String SWITCH_SOURCE

See Also:

Constant Field Values

SWITCH_TARGET

protected static final String SWITCH_TARGET

See Also:

Constant Field Values

SWITCH_URI_BASE

protected static final String SWITCH_URI_BASE

See Also:

Constant Field Values

SWITCH_URI_ROOT

protected static final String SWITCH_URI_ROOT

See Also:

Constant Field Values

SWITCH_FILE_WEBAPP

protected static final String SWITCH_FILE_WEBAPP

See Also:

Constant Field Values

SWITCH_WEBAPP_INC

protected static final String SWITCH_WEBAPP_INC

See Also:

Constant Field Values

SWITCH_WEBAPP_XML

protected static final String SWITCH_WEBAPP_XML

See Also:

Constant Field Values

SWITCH_WEBAPP_XML_ENCODING

protected static final String SWITCH_WEBAPP_XML_ENCODING

See Also:

Constant Field Values

SWITCH_ADD_WEBAPP_XML_MAPPINGS

protected static final String SWITCH_ADD_WEBAPP_XML_MAPPINGS

See Also:

Constant Field Values

SWITCH_MAPPED

protected static final String SWITCH_MAPPED

See Also:

Constant Field Values

SWITCH_XPOWERED_BY

protected static final String SWITCH_XPOWERED_BY

See Also:

Constant Field Values

SWITCH_TRIM_SPACES

protected static final String SWITCH_TRIM_SPACES

See Also:

Constant Field Values

SWITCH_CLASSPATH

protected static final String SWITCH_CLASSPATH

See Also:

Constant Field Values

SWITCH_DIE

protected static final String SWITCH_DIE

See Also:

Constant Field Values

SWITCH_POOLING

protected static final String SWITCH_POOLING

See Also:

Constant Field Values

SWITCH_ENCODING

protected static final String SWITCH_ENCODING

See Also:

Constant Field Values

SWITCH_SMAP

protected static final String SWITCH_SMAP

See Also:

Constant Field Values

SWITCH_DUMP_SMAP

protected static final String SWITCH_DUMP_SMAP

See Also:

Constant Field Values

SHOW_SUCCESS

protected static final String SHOW_SUCCESS

See Also:

Constant Field Values

LIST_ERRORS

protected static final String LIST_ERRORS

See Also:

Constant Field Values

INC_WEBXML

protected static final int INC_WEBXML

See Also:

Constant Field Values

ALL_WEBXML

protected static final int ALL_WEBXML

See Also:

Constant Field Values

DEFAULT_DIE_LEVEL

protected static final int DEFAULT_DIE_LEVEL

See Also:

Constant Field Values

NO_DIE_LEVEL

protected static final int NO_DIE_LEVEL

See Also:

Constant Field Values

insertBefore

protected static final Set<String> insertBefore

classPath

protected String classPath

loader

protected URLClassLoader loader

trimSpaces

protected boolean trimSpaces

genStringAsCharArray

protected boolean genStringAsCharArray

xpoweredBy

protected boolean xpoweredBy

mappedFile

protected boolean mappedFile

poolingEnabled

protected boolean poolingEnabled

scratchDir

protected File scratchDir

ieClassId

protected String ieClassId

targetPackage

protected String targetPackage

targetClassName

protected String targetClassName

uriBase

protected String uriBase

uriRoot

protected String uriRoot

dieLevel

protected int dieLevel

helpNeeded

protected boolean helpNeeded

compile

protected boolean compile

smapSuppressed

protected boolean smapSuppressed

smapDumped

protected boolean smapDumped

caching

protected boolean caching

cache

protected final Map<String,TagLibraryInfo> cache

compiler

protected String compiler

compilerTargetVM

protected String compilerTargetVM

compilerSourceVM

protected String compilerSourceVM

classDebugInfo

protected boolean classDebugInfo

failOnError

protected boolean failOnError

Throw an exception if there's a compilation error, or swallow it. Default is true to preserve old behavior.

extensions

protected List<String> extensions

The file extensions to be handled as JSP files. Default list is .jsp and .jspx.

pages

protected final List<String> pages

The pages.

errorOnUseBeanInvalidClassAttribute

protected boolean errorOnUseBeanInvalidClassAttribute

Needs better documentation, this data member does. True by default.

javaEncoding

protected String javaEncoding

The java file encoding. Default is UTF-8. Added per bugzilla 19622.

webxmlFile

protected String webxmlFile

webxmlLevel

protected int webxmlLevel

webxmlEncoding

protected String webxmlEncoding

addWebXmlMappings

protected boolean addWebXmlMappings

mapout

protected Writer mapout

servletout

protected CharArrayWriter servletout

mappingout

protected CharArrayWriter mappingout

context

protected JspCServletContext context

The servlet context.

rctxt

protected JspRuntimeContext rctxt

The runtime context. Maintain a dummy JspRuntimeContext for compiling tag files.

tldLocationsCache

protected TldLocationsCache tldLocationsCache

Cache for the TLD locations

jspConfig

protected JspConfig jspConfig

tagPluginManager

protected TagPluginManager tagPluginManager

verbose

protected boolean verbose

listErrors

protected boolean listErrors

showSuccess

protected boolean showSuccess

argPos

protected int argPos

fullstop

protected boolean fullstop

args

protected String[] args

Constructor Detail

JspC

public JspC()

Method Detail

main

public static void main(String[] arg)

setArgs

public void setArgs(String[] arg)
             throws JasperException

Apply command-line arguments.

Parameters:

arg - The arguments

Throws:

JasperException

getKeepGenerated

public boolean getKeepGenerated()

In JspC this always returns true. Are we keeping generated code around?

Specified by:

getKeepGenerated in interface Options

getTrimSpaces

public boolean getTrimSpaces()

Should white spaces between directives or actions be trimmed?

Specified by:

getTrimSpaces in interface Options

setTrimSpaces

public void setTrimSpaces(boolean ts)

Sets the option to trim white spaces between directives or actions.

isPoolingEnabled

public boolean isPoolingEnabled()

Returns true if tag handler pooling is enabled, false otherwise.

Specified by:

isPoolingEnabled in interface Options

setPoolingEnabled

public void setPoolingEnabled(boolean poolingEnabled)

Sets the option to enable the tag handler pooling.

isXpoweredBy

public boolean isXpoweredBy()

Is generation of X-Powered-By response header enabled/disabled?

Specified by:

isXpoweredBy in interface Options

setXpoweredBy

public void setXpoweredBy(boolean xpoweredBy)

Sets the option to enable generation of X-Powered-By response header.

getDisplaySourceFragment

public boolean getDisplaySourceFragment()

In JspC this always returns true. Should we include a source fragment in exception messages, which could be displayed to the developer ?

Specified by:

getDisplaySourceFragment in interface Options

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 interface Options

getJspIdleTimeout

public int getJspIdleTimeout()

Description copied from interface: Options

The idle time in seconds after which a JSP is unloaded. If unset or less or equal than 0, no jsps are unloaded.

Specified by:

getJspIdleTimeout in interface Options

getErrorOnUseBeanInvalidClassAttribute

public 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.

Specified by:

getErrorOnUseBeanInvalidClassAttribute in interface Options

setErrorOnUseBeanInvalidClassAttribute

public void setErrorOnUseBeanInvalidClassAttribute(boolean b)

Sets the option to issue a compilation error if the class attribute specified in useBean action is invalid.

getMappedFile

public boolean getMappedFile()

Are we supporting HTML mapped servlets?

Specified by:

getMappedFile in interface Options

setClassDebugInfo

public void setClassDebugInfo(boolean b)

Sets the option to include debug information in compiled class.

getClassDebugInfo

public boolean getClassDebugInfo()

Should we include debug information in compiled class?

Specified by:

getClassDebugInfo in interface Options

isCaching

public boolean isCaching()

Is caching enabled (used for precompilation).

Specified by:

isCaching in interface Options

setCaching

public void setCaching(boolean caching)

Sets the option to enable caching.

See Also:

Options.isCaching()

getCache

public Map<String,TagLibraryInfo> getCache()

The web-application wide cache for the TagLibraryInfo tag library descriptors, used if Options.isCaching() returns true.

Using this cache avoids the cost of repeating the parsing of a tag library descriptor XML file (performed by TagLibraryInfoImpl.parseTLD).

Specified by:

getCache in interface Options

Returns:

the Map(String uri, TagLibraryInfo tld) instance.

getCheckInterval

public int getCheckInterval()

In JspC this always returns 0. Background compile thread check interval in seconds

Specified by:

getCheckInterval in interface Options

getModificationTestInterval

public int getModificationTestInterval()

In JspC this always returns 0. Modification test interval.

Specified by:

getModificationTestInterval in interface Options

getRecompileOnFail

public boolean getRecompileOnFail()

In JspC this always returns false. Re-compile on failure.

Specified by:

getRecompileOnFail in interface Options

getDevelopment

public boolean getDevelopment()

In JspC this always returns false. Is Jasper being used in development mode?

Specified by:

getDevelopment in interface Options

isSmapSuppressed

public boolean isSmapSuppressed()

Is the generation of SMAP info for JSR45 debugging suppressed?

Specified by:

isSmapSuppressed in interface Options

setSmapSuppressed

public void setSmapSuppressed(boolean smapSuppressed)

Sets smapSuppressed flag.

isSmapDumped

public boolean isSmapDumped()

Indicates whether SMAP info for JSR45 debugging should be dumped to a file. Ignored if suppressSmap() is true.

Specified by:

isSmapDumped in interface Options

setSmapDumped

public void setSmapDumped(boolean smapDumped)

Sets smapDumped flag.

See Also:

Options.isSmapDumped()

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()

Indicates whether text strings are to be generated as char arrays.

Specified by:

genStringAsCharArray in interface Options

Returns:

true if text strings are to be generated as char arrays, false otherwise

setIeClassId

public void setIeClassId(String ieClassId)

Sets the class-id value to be sent to Internet Explorer when using <jsp:plugin> tags.

Parameters:

ieClassId - Class-id value

getIeClassId

public String getIeClassId()

Gets the class-id value that is sent to Internet Explorer when using <jsp:plugin> tags.

Specified by:

getIeClassId in interface Options

Returns:

Class-id value

getScratchDir

public File getScratchDir()

What is my scratch dir?

Specified by:

getScratchDir in interface Options

getCompiler

public String getCompiler()

Compiler to use.

If null (the default), the java compiler from Eclipse JDT project, bundled with Tomcat, will be used. Otherwise, the javac 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 interface Options

setCompiler

public void setCompiler(String c)

Sets the option to determine what compiler to use.

See Also:

Options.getCompiler()

getCompilerClassName

public String getCompilerClassName()

Jasper Java compiler class to use.

Specified by:

getCompilerClassName in interface Options

getCompilerTargetVM

public String getCompilerTargetVM()

The compiler target VM, e.g. 1.1, 1.2, 1.3, 1.4, 1.5 or 1.6.

Specified by:

getCompilerTargetVM in interface Options

setCompilerTargetVM

public void setCompilerTargetVM(String vm)

Sets the compiler target VM.

See Also:

Options.getCompilerTargetVM()

getCompilerSourceVM

public String getCompilerSourceVM()

The compiler source VM, e.g. 1.3, 1.4, 1.5 or 1.6.

Specified by:

getCompilerSourceVM in interface Options

setCompilerSourceVM

public void setCompilerSourceVM(String vm)

Sets the compiler source VM.

See Also:

Options.getCompilerSourceVM()

getTldLocationsCache

public TldLocationsCache getTldLocationsCache()

The cache for the location of the TLD's 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:

getTldLocationsCache in interface Options

Returns:

the instance of the TldLocationsCache for the web-application.

getJavaEncoding

public String getJavaEncoding()

Returns the encoding to use for java files. The default is UTF-8.

Specified by:

getJavaEncoding in interface Options

Returns:

String The encoding

setJavaEncoding

public void setJavaEncoding(String encodingName)

Sets the encoding to use for java files.

Parameters:

encodingName - The name, e.g. "UTF-8"

getFork

public 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 javac Apache Ant task).

Specified by:

getFork in interface Options

getClassPath

public String getClassPath()

What classpath should I use while compiling the servlets generated from JSP files?

Specified by:

getClassPath in interface Options

setClassPath

public void setClassPath(String s)

Sets the classpath used while compiling the servlets generated from JSP files

getExtensions

public List<String> getExtensions()

Returns the list of file extensions that are treated as JSP files.

Returns:

The list of extensions

addExtension

protected void addExtension(String extension)

Adds the given file extension to the list of extensions handled as JSP files.

Parameters:

extension - The extension to add, e.g. "myjsp"

setUriroot

public void setUriroot(String s)

Base dir for the webapp. Used to generate class names and resolve includes.

setJspFiles

public void setJspFiles(String jspFiles)

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

setValidateXml

public void setValidateXml(boolean b)

setListErrors

public void setListErrors(boolean b)

setOutputDir

public void setOutputDir(String s)

setPackage

public void setPackage(String p)

Sets the package name to be used for the generated servlet classes.

setClassName

public void setClassName(String p)

Class name of the generated file ( without package ). Can only be used if a single file is converted. XXX Do we need this feature ?

setWebXmlFragment

public void setWebXmlFragment(String s)

File where we generate a web.xml fragment with the class definitions.

setWebXml

public void setWebXml(String s)

File where we generate a complete web.xml with the class definitions.

setWebXmlEncoding

public void setWebXmlEncoding(String encoding)

Sets the encoding to be used to read and write web.xml files.

If not specified, defaults to the platform default encoding.

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.

getFailOnError

public boolean getFailOnError()

Returns true if an exception will be thrown in case of a compilation error.

getJspConfig

public JspConfig getJspConfig()

Obtain JSP configuration information specified in web.xml.

Specified by:

getJspConfig in interface Options

getTagPluginManager

public TagPluginManager getTagPluginManager()

Obtain a Tag Plugin Manager

Specified by:

getTagPluginManager in interface Options

generateWebMapping

public void generateWebMapping(String file,
                               JspCompilationContext clctxt)
                        throws IOException

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

mergeIntoWebXml

protected void mergeIntoWebXml()
                        throws IOException

Include the generated web.xml inside the webapp's web.xml.

Throws:

IOException

processFile

protected void processFile(String file)
                    throws JasperException

Throws:

JasperException

scanFiles

public void scanFiles(File base)
               throws JasperException

Locate all jsp files in the webapp. Used if no explicit jsps are specified.

Throws:

JasperException

execute

public void execute()

Executes the compilation.

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

JasperException - If an error occurs

nextArg

protected String nextArg()

nextFile

protected String nextFile()

initWebXml

protected void initWebXml()

completeWebXml

protected void completeWebXml()

initServletContext

protected void initServletContext()

initClassLoader

protected void initClassLoader(JspCompilationContext clctxt)
                        throws IOException

Initializes the classloader as/if needed for the given compilation context.

Parameters:

clctxt - The compilation context

Throws:

IOException - If an error occurs

locateUriRoot

protected void locateUriRoot(File f)

Find the WEB-INF dir by looking up in the directory tree. This is used if no explicit docbase is set, but only files. XXX Maybe we should require the docbase.

resolveFile

protected File resolveFile(String s)

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