Package org.apache.jasper
Class JspCompilationContext
java.lang.Object
org.apache.jasper.JspCompilationContext
A place holder for various things that are used through out the JSP
engine. This is a per-request/per-context data structure. Some of
the instance variables are set at different points.
Most of the path-related stuff is here - mangling names, versions, dirs,
loading resources and dealing with uris.
- Author:
- Anil K. Vijendran, Harish Prabandham, Pierre Delisle, Costin Manolache, Kin-man Chung
-
Constructor Summary
ConstructorDescriptionJspCompilationContext
(String tagfile, TagInfo tagInfo, Options options, ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt, Jar tagJar) JspCompilationContext
(String jspUri, Options options, ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt) -
Method Summary
Modifier and TypeMethodDescriptionprotected static final String
void
void
void
compile()
Create a "Compiler" object based on some init param data.protected Compiler
createCompiler
(String className) protected void
What class loader to use for loading classes while compiling this JSP?protected String
getFQCN()
Path of the JSP URI.getLastModified
(String resource) getLastModified
(String resource, Jar tagJar) The output directory to generate code into.getRealPath
(String path) Gets the actual path of a URI relative to the context of the compilation.getResource
(String res) Gets a resource as a stream, relative to the meanings of this context's implementation.getResourcePaths
(String path) Just the class name (does not include package name) of the generated class.Package name for the generated class is made up of the base package name, which is user settable, and the derived package name.Returns the JAR file in which the tag file for which this JspCompilationContext was created is packaged, or null if this JspCompilationContext does not correspond to a tag file, or if the corresponding tag file is not packaged in a JAR.getTldResourcePath
(String uri) Gets the 'location' of the TLD associated with the given taglib 'uri'.void
protected static final boolean
isPathSeparator
(char c) boolean
boolean
boolean
boolean
Class
<?> load()
protected boolean
resolveRelativeUri
(String uri) Get the full value of a URI relative to this compilations context uses current file as the base.void
setBasePackageName
(String basePackageName) The package name into which the servlet class is generated.void
setClassLoader
(ClassLoader loader) void
setClassPath
(String classPath) The classpath that is passed off to the Java compiler.void
setPrototypeMode
(boolean pm) void
setServletClassName
(String className) void
setTagFileJar
(Jar tagJar) void
setTagInfo
(TagInfo tagi) void
setWriter
(ServletWriter writer)
-
Constructor Details
-
JspCompilationContext
public JspCompilationContext(String jspUri, Options options, ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt) -
JspCompilationContext
public JspCompilationContext(String tagfile, TagInfo tagInfo, Options options, ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt, Jar tagJar)
-
-
Method Details
-
getClassPath
- Returns:
- the classpath that is passed off to the Java compiler.
-
setClassPath
The classpath that is passed off to the Java compiler.- Parameters:
classPath
- The class path to use
-
getClassLoader
What class loader to use for loading classes while compiling this JSP?- Returns:
- the class loader used to load all compiled classes
-
setClassLoader
-
getJspLoader
-
clearJspLoader
public void clearJspLoader() -
getOutputDir
The output directory to generate code into. The output directory is make up of the scratch directory, which is provide in Options, plus the directory derived from the package name.- Returns:
- the output directory in which the generated sources are placed
-
createCompiler
Create a "Compiler" object based on some init param data. This is not done yet. Right now we're just hardcoding the actual compilers that are created.- Returns:
- the Java compiler wrapper
-
createCompiler
-
getCompiler
-
resolveRelativeUri
-
getResourceAsStream
Gets a resource as a stream, relative to the meanings of this context's implementation.- Parameters:
res
- the resource to look for- Returns:
- a null if the resource cannot be found or represented as an InputStream.
-
getResource
- Throws:
MalformedURLException
-
getResourcePaths
-
getRealPath
-
getTagFileJar
Returns the JAR file in which the tag file for which this JspCompilationContext was created is packaged, or null if this JspCompilationContext does not correspond to a tag file, or if the corresponding tag file is not packaged in a JAR.- Returns:
- a JAR file
-
setTagFileJar
-
getServletClassName
Just the class name (does not include package name) of the generated class.- Returns:
- the class name
-
setServletClassName
-
getJspFile
Path of the JSP URI. Note that this is not a file name. This is the context rooted URI of the JSP file.- Returns:
- the path to the JSP
-
getLastModified
-
getLastModified
-
isTagFile
public boolean isTagFile() -
getTagInfo
-
setTagInfo
-
isPrototypeMode
public boolean isPrototypeMode()- Returns:
true
if we are compiling a tag file in prototype mode. ie we only generate codes with class for the tag handler with empty method bodies.
-
setPrototypeMode
public void setPrototypeMode(boolean pm) -
getServletPackageName
Package name for the generated class is made up of the base package name, which is user settable, and the derived package name. The derived package name directly mirrors the file hierarchy of the JSP page.- Returns:
- the package name
-
getDerivedPackageName
-
getBasePackageName
- Returns:
- The base package name into which all servlet and associated code is generated
-
setBasePackageName
The package name into which the servlet class is generated.- Parameters:
basePackageName
- The package name to use
-
getServletJavaFileName
- Returns:
- Full path name of the Java file into which the servlet is being generated.
-
getOptions
- Returns:
- the Options object for this context.
-
getServletContext
-
getRuntimeContext
-
getJavaPath
- Returns:
- the path of the Java file relative to the work directory.
-
getClassFileName
-
getWriter
- Returns:
- the writer that is used to write the generated Servlet source.
-
setWriter
-
getTldResourcePath
Gets the 'location' of the TLD associated with the given taglib 'uri'.- Parameters:
uri
- The taglib URI- Returns:
- An array of two Strings: The first element denotes the real path to the TLD. If the path to the TLD points to a jar file, then the second element denotes the name of the TLD entry in the jar file. Returns null if the given uri is not associated with any tag library 'exposed' in the web application.
-
keepGenerated
public boolean keepGenerated()- Returns:
true
if generated code is kept.
-
incrementRemoved
public void incrementRemoved() -
isRemoved
public boolean isRemoved() -
compile
- Throws:
JasperException
FileNotFoundException
-
load
- Throws:
JasperException
-
getFQCN
-
checkOutputDir
public void checkOutputDir() -
makeOutputDir
protected boolean makeOutputDir() -
createOutputDir
protected void createOutputDir() -
isPathSeparator
protected static final boolean isPathSeparator(char c) -
canonicalURI
-