Package org.apache.jasper
Class JspCompilationContext
- java.lang.Object
-
- org.apache.jasper.JspCompilationContext
-
public class JspCompilationContext extends java.lang.ObjectA 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
Constructors Constructor Description JspCompilationContext(java.lang.String tagfile, TagInfo tagInfo, Options options, ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt, Jar tagJar)JspCompilationContext(java.lang.String jspUri, Options options, ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected static java.lang.StringcanonicalURI(java.lang.String s)voidcheckOutputDir()voidclearJspLoader()voidcompile()CompilercreateCompiler()Create a "Compiler" object based on some init param data.protected CompilercreateCompiler(java.lang.String className)protected voidcreateOutputDir()java.lang.StringgetClassFileName()java.lang.ClassLoadergetClassLoader()What class loader to use for loading classes while compiling this JSP?java.lang.StringgetClassPath()CompilergetCompiler()protected java.lang.StringgetDerivedPackageName()java.lang.StringgetFQCN()java.lang.StringgetJavaPath()java.lang.StringgetJspFile()Path of the JSP URI.java.lang.ClassLoadergetJspLoader()java.lang.LonggetLastModified(java.lang.String resource)java.lang.LonggetLastModified(java.lang.String resource, Jar tagJar)OptionsgetOptions()java.lang.StringgetOutputDir()The output directory to generate code into.java.lang.StringgetRealPath(java.lang.String path)Gets the actual path of a URI relative to the context of the compilation.java.net.URLgetResource(java.lang.String res)java.io.InputStreamgetResourceAsStream(java.lang.String res)Gets a resource as a stream, relative to the meanings of this context's implementation.java.util.Set<java.lang.String>getResourcePaths(java.lang.String path)JspRuntimeContextgetRuntimeContext()java.lang.StringgetServletClassName()Just the class name (does not include package name) of the generated class.ServletContextgetServletContext()java.lang.StringgetServletJavaFileName()java.lang.StringgetServletPackageName()Package name for the generated class is make up of the base package name, which is user settable, and the derived package name.JargetTagFileJar()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.TagInfogetTagInfo()TldResourcePathgetTldResourcePath(java.lang.String uri)Gets the 'location' of the TLD associated with the given taglib 'uri'.ServletWritergetWriter()voidincrementRemoved()protected static booleanisPathSeparator(char c)booleanisPrototypeMode()booleanisRemoved()booleanisTagFile()booleankeepGenerated()java.lang.Class<?>load()protected booleanmakeOutputDir()java.lang.StringresolveRelativeUri(java.lang.String uri)Get the full value of a URI relative to this compilations context uses current file as the base.voidsetClassLoader(java.lang.ClassLoader loader)voidsetClassPath(java.lang.String classPath)The classpath that is passed off to the Java compiler.voidsetPrototypeMode(boolean pm)voidsetServletClassName(java.lang.String className)voidsetServletPackageName(java.lang.String servletPackageName)The package name into which the servlet class is generated.voidsetTagFileJar(Jar tagJar)voidsetTagInfo(TagInfo tagi)voidsetWriter(ServletWriter writer)
-
-
-
Constructor Detail
-
JspCompilationContext
public JspCompilationContext(java.lang.String jspUri, Options options, ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt)
-
JspCompilationContext
public JspCompilationContext(java.lang.String tagfile, TagInfo tagInfo, Options options, ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt, Jar tagJar)
-
-
Method Detail
-
getClassPath
public java.lang.String getClassPath()
- Returns:
- the classpath that is passed off to the Java compiler.
-
setClassPath
public void setClassPath(java.lang.String classPath)
The classpath that is passed off to the Java compiler.- Parameters:
classPath- The class path to use
-
getClassLoader
public java.lang.ClassLoader getClassLoader()
What class loader to use for loading classes while compiling this JSP?- Returns:
- the class loader used to load all compiled classes
-
setClassLoader
public void setClassLoader(java.lang.ClassLoader loader)
-
getJspLoader
public java.lang.ClassLoader getJspLoader()
-
clearJspLoader
public void clearJspLoader()
-
getOutputDir
public java.lang.String 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
public Compiler 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
protected Compiler createCompiler(java.lang.String className)
-
getCompiler
public Compiler getCompiler()
-
resolveRelativeUri
public java.lang.String resolveRelativeUri(java.lang.String uri)
Get the full value of a URI relative to this compilations context uses current file as the base.- Parameters:
uri- The relative URI- Returns:
- absolute URI
-
getResourceAsStream
public java.io.InputStream getResourceAsStream(java.lang.String res)
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
public java.net.URL getResource(java.lang.String res) throws java.net.MalformedURLException- Throws:
java.net.MalformedURLException
-
getResourcePaths
public java.util.Set<java.lang.String> getResourcePaths(java.lang.String path)
-
getRealPath
public java.lang.String getRealPath(java.lang.String path)
Gets the actual path of a URI relative to the context of the compilation.- Parameters:
path- The webapp path- Returns:
- the corresponding path in the filesystem
-
getTagFileJar
public Jar 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
public void setTagFileJar(Jar tagJar)
-
getServletClassName
public java.lang.String getServletClassName()
Just the class name (does not include package name) of the generated class.- Returns:
- the class name
-
setServletClassName
public void setServletClassName(java.lang.String className)
-
getJspFile
public java.lang.String 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
public java.lang.Long getLastModified(java.lang.String resource)
-
getLastModified
public java.lang.Long getLastModified(java.lang.String resource, Jar tagJar)
-
isTagFile
public boolean isTagFile()
-
getTagInfo
public TagInfo getTagInfo()
-
setTagInfo
public void setTagInfo(TagInfo tagi)
-
isPrototypeMode
public boolean isPrototypeMode()
- Returns:
trueif 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
public java.lang.String 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 hierarchy of the JSP page.- Returns:
- the package name
-
getDerivedPackageName
protected java.lang.String getDerivedPackageName()
-
setServletPackageName
public void setServletPackageName(java.lang.String servletPackageName)
The package name into which the servlet class is generated.- Parameters:
servletPackageName- The package name to use
-
getServletJavaFileName
public java.lang.String getServletJavaFileName()
- Returns:
- Full path name of the Java file into which the servlet is being generated.
-
getOptions
public Options getOptions()
- Returns:
- the Options object for this context.
-
getServletContext
public ServletContext getServletContext()
-
getRuntimeContext
public JspRuntimeContext getRuntimeContext()
-
getJavaPath
public java.lang.String getJavaPath()
- Returns:
- the path of the Java file relative to the work directory.
-
getClassFileName
public java.lang.String getClassFileName()
-
getWriter
public ServletWriter getWriter()
- Returns:
- the writer that is used to write the generated Servlet source.
-
setWriter
public void setWriter(ServletWriter writer)
-
getTldResourcePath
public TldResourcePath getTldResourcePath(java.lang.String uri)
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:
trueif generated code is kept.
-
incrementRemoved
public void incrementRemoved()
-
isRemoved
public boolean isRemoved()
-
compile
public void compile() throws JasperException, java.io.FileNotFoundException- Throws:
JasperExceptionjava.io.FileNotFoundException
-
load
public java.lang.Class<?> load() throws JasperException- Throws:
JasperException
-
getFQCN
public java.lang.String getFQCN()
-
checkOutputDir
public void checkOutputDir()
-
makeOutputDir
protected boolean makeOutputDir()
-
createOutputDir
protected void createOutputDir()
-
isPathSeparator
protected static final boolean isPathSeparator(char c)
-
canonicalURI
protected static final java.lang.String canonicalURI(java.lang.String s)
-
-