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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
private String
private URL
private String
private String
private String
private String
private javax.servlet.ServletContext
private String
private boolean
private boolean
private String
private Compiler
private String
private JspServletWrapper
private ClassLoader
private Options
private String
(package private) static Object
private boolean
private JspRuntimeContext
private int
private Class
private String
private URL
private ConcurrentHashMap
<String, URL> private javax.servlet.jsp.tagext.TagInfo
private ConcurrentHashMap
<String, TagLibraryInfoImpl> private ServletWriter
-
Constructor Summary
ConstructorsConstructorDescriptionJspCompilationContext
(String jspUri, boolean isErrPage, Options options, javax.servlet.ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt) JspCompilationContext
(String tagfile, javax.servlet.jsp.tagext.TagInfo tagInfo, Options options, javax.servlet.ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt, URL tagFileJarUrl) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addTaglib
(String uri, TagLibraryInfoImpl taglib) Adds the given tag library with the given URI to the context-wide tag library cache.private static final String
private static <T> T
void
Clears the context-wide mappings from JAR packaged tag file paths to their corresponding URLs.void
Clears the context-wide tag library cache.void
compile()
createCompiler
(boolean jspcMode) Create a "Compiler" object.private void
Create a compiler object for parsing only.What class loader to use for loading classes while compiling this JSP?The classpath that is passed off to the Java compiler.Get the content type of this JSP.private String
Full class namePath of the Java file relative to the work directory.Path of the JSP URI.Get hold of the Options object for this context.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.javax.servlet.ServletContext
Full path name of the Java file into which the servlet is being generated.Package name for the generated class is make 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.Gets the context-wide mappings from JAR packaged tag file paths to their corresponfing URLs.javax.servlet.jsp.tagext.TagInfo
Gets the context-wide tag library cache.String[]
getTldLocation
(String uri) Gets the 'location' of the TLD associated with the given taglib 'uri'.Where is the servlet being generated?void
boolean
Are we processing something that has been declared as an errorpage?private static final boolean
isPathSeparator
(char c) boolean
True if we are compiling a tag file in prototype mode.boolean
boolean
boolean
Are we keeping generated code around?load()
void
makeOutputDir
(String outdir) resolveRelativeUri
(String uri) Get the full value of a URI relative to this compilations context uses current file as the base.void
setClassLoader
(URLClassLoader loader) void
setClassPath
(String classPath) The classpath that is passed off to the Java compiler.void
setContentType
(String contentType) void
setErrorPage
(boolean isErrPage) void
setPrototypeMode
(boolean pm) void
setServletClassName
(String className) void
setServletPackageName
(String servletPackageName) The package name into which the servlet class is generated.void
setTagInfo
(javax.servlet.jsp.tagext.TagInfo tagi) void
setWriter
(ServletWriter writer)
-
Field Details
-
className
-
jspUri
-
isErrPage
private boolean isErrPage -
basePackageName
-
derivedPackageName
-
servletJavaFileName
-
javaPath
-
classFileName
-
contentType
-
writer
-
options
-
jsw
-
jspCompiler
-
classPath
-
baseURI
-
outputDir
-
context
private javax.servlet.ServletContext context -
loader
-
rctxt
-
removed
private int removed -
baseUrl
-
servletClass
-
isTagFile
private boolean isTagFile -
protoTypeMode
private boolean protoTypeMode -
tagInfo
private javax.servlet.jsp.tagext.TagInfo tagInfo -
tagFileJarUrl
-
taglibs
-
tagFileJarUrls
-
outputDirLock
-
-
Constructor Details
-
JspCompilationContext
public JspCompilationContext(String jspUri, boolean isErrPage, Options options, javax.servlet.ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt) throws JasperException - Throws:
JasperException
-
JspCompilationContext
public JspCompilationContext(String tagfile, javax.servlet.jsp.tagext.TagInfo tagInfo, Options options, javax.servlet.ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt, URL tagFileJarUrl) throws JasperException - Throws:
JasperException
-
-
Method Details
-
cast
-
addTaglib
Adds the given tag library with the given URI to the context-wide tag library cache.- Parameters:
uri
- The tag library URItaglib
- The tag library to add
-
getTaglibs
Gets the context-wide tag library cache.- Returns:
- The context-wide tag library cache
-
clearTaglibs
public void clearTaglibs()Clears the context-wide tag library cache. -
clearTagFileJarUrls
public void clearTagFileJarUrls()Clears the context-wide mappings from JAR packaged tag file paths to their corresponding URLs. -
getClassPath
The classpath that is passed off to the Java compiler. -
setClassPath
The classpath that is passed off to the Java compiler. -
getClassLoader
What class loader to use for loading classes while compiling this JSP? -
setClassLoader
-
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. -
createParser
Create a compiler object for parsing only.- Throws:
JasperException
-
createCompiler
Create a "Compiler" object.- Throws:
JasperException
-
getCompiler
-
resolveRelativeUri
Get the full value of a URI relative to this compilations context uses current file as the base. -
getResourceAsStream
Gets a resource as a stream, relative to the meanings of this context's implementation.- Returns:
- a null if the resource cannot be found or represented as an InputStream.
- Throws:
JasperException
-
getResource
- Throws:
MalformedURLException
-
getResourcePaths
- Throws:
JasperException
-
getRealPath
Gets the actual path of a URI relative to the context of the compilation. -
getTagFileJarUrls
Gets the context-wide mappings from JAR packaged tag file paths to their corresponfing URLs. -
getTagFileJarUrl
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. -
getServletClassName
Just the class name (does not include package name) of the generated class. -
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. -
isErrorPage
public boolean isErrorPage()Are we processing something that has been declared as an errorpage? -
setErrorPage
public void setErrorPage(boolean isErrPage) -
isTagFile
public boolean isTagFile() -
getTagInfo
public javax.servlet.jsp.tagext.TagInfo getTagInfo() -
setTagInfo
public void setTagInfo(javax.servlet.jsp.tagext.TagInfo tagi) -
isPrototypeMode
public boolean isPrototypeMode()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 make up of the base package name, which is user settable, and the derived package name. The derived package name directly mirrors the file heirachy of the JSP page. -
getDerivedPackageName
-
setServletPackageName
The package name into which the servlet class is generated. -
getServletJavaFileName
Full path name of the Java file into which the servlet is being generated. -
getOptions
Get hold of the Options object for this context. -
getServletContext
public javax.servlet.ServletContext getServletContext() -
getRuntimeContext
-
getFullClassName
Full class name -
getJavaPath
Path of the Java file relative to the work directory. -
getClassFileName
-
getContentType
Get the content type of this JSP. Content type includes content type and encoding. -
setContentType
-
getWriter
Where is the servlet being generated? -
setWriter
-
getTldLocation
Gets the 'location' of the TLD associated with the given 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.
- Throws:
JasperException
-
keepGenerated
public boolean keepGenerated()Are we keeping generated code around? -
incrementRemoved
public void incrementRemoved() -
isRemoved
public boolean isRemoved() -
compile
- Throws:
JasperException
FileNotFoundException
-
load
-
getJspLoader
-
makeOutputDir
-
createOutputDir
private void createOutputDir() -
isPathSeparator
private static final boolean isPathSeparator(char c) -
canonicalURI
- Throws:
JasperException
-