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 SummaryConstructors 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 SummaryAll 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.StringgetBasePackageName()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 made 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.voidsetBasePackageName(java.lang.String basePackageName)The package name into which the servlet class is generated.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)voidsetTagFileJar(Jar tagJar)voidsetTagInfo(TagInfo tagi)voidsetWriter(ServletWriter writer)
 
- 
- 
- 
Constructor Detail- 
JspCompilationContextpublic JspCompilationContext(java.lang.String jspUri, Options options, ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt)
 - 
JspCompilationContextpublic JspCompilationContext(java.lang.String tagfile, TagInfo tagInfo, Options options, ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt, Jar tagJar)
 
- 
 - 
Method Detail- 
getClassPathpublic java.lang.String getClassPath() - Returns:
- the classpath that is passed off to the Java compiler.
 
 - 
setClassPathpublic void setClassPath(java.lang.String classPath) The classpath that is passed off to the Java compiler.- Parameters:
- classPath- The class path to use
 
 - 
getClassLoaderpublic 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
 
 - 
setClassLoaderpublic void setClassLoader(java.lang.ClassLoader loader) 
 - 
getJspLoaderpublic java.lang.ClassLoader getJspLoader() 
 - 
clearJspLoaderpublic void clearJspLoader() 
 - 
getOutputDirpublic 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
 
 - 
createCompilerpublic 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
 
 - 
createCompilerprotected Compiler createCompiler(java.lang.String className) 
 - 
getCompilerpublic Compiler getCompiler() 
 - 
resolveRelativeUripublic 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
 
 - 
getResourceAsStreampublic 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.
 
 - 
getResourcepublic java.net.URL getResource(java.lang.String res) throws java.net.MalformedURLException- Throws:
- java.net.MalformedURLException
 
 - 
getResourcePathspublic java.util.Set<java.lang.String> getResourcePaths(java.lang.String path) 
 - 
getRealPathpublic 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
 
 - 
getTagFileJarpublic 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
 
 - 
setTagFileJarpublic void setTagFileJar(Jar tagJar) 
 - 
getServletClassNamepublic java.lang.String getServletClassName() Just the class name (does not include package name) of the generated class.- Returns:
- the class name
 
 - 
setServletClassNamepublic void setServletClassName(java.lang.String className) 
 - 
getJspFilepublic 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
 
 - 
getLastModifiedpublic java.lang.Long getLastModified(java.lang.String resource) 
 - 
getLastModifiedpublic java.lang.Long getLastModified(java.lang.String resource, Jar tagJar)
 - 
isTagFilepublic boolean isTagFile() 
 - 
getTagInfopublic TagInfo getTagInfo() 
 - 
setTagInfopublic void setTagInfo(TagInfo tagi) 
 - 
isPrototypeModepublic 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.
 
 - 
setPrototypeModepublic void setPrototypeMode(boolean pm) 
 - 
getServletPackageNamepublic java.lang.String 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
 
 - 
getDerivedPackageNameprotected java.lang.String getDerivedPackageName() 
 - 
getBasePackageNamepublic java.lang.String getBasePackageName() - Returns:
- The base package name into which all servlet and associated code is generated
 
 - 
setBasePackageNamepublic void setBasePackageName(java.lang.String basePackageName) The package name into which the servlet class is generated.- Parameters:
- basePackageName- The package name to use
 
 - 
getServletJavaFileNamepublic java.lang.String getServletJavaFileName() - Returns:
- Full path name of the Java file into which the servlet is being generated.
 
 - 
getOptionspublic Options getOptions() - Returns:
- the Options object for this context.
 
 - 
getServletContextpublic ServletContext getServletContext() 
 - 
getRuntimeContextpublic JspRuntimeContext getRuntimeContext() 
 - 
getJavaPathpublic java.lang.String getJavaPath() - Returns:
- the path of the Java file relative to the work directory.
 
 - 
getClassFileNamepublic java.lang.String getClassFileName() 
 - 
getWriterpublic ServletWriter getWriter() - Returns:
- the writer that is used to write the generated Servlet source.
 
 - 
setWriterpublic void setWriter(ServletWriter writer) 
 - 
getTldResourcePathpublic 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.
 
 - 
keepGeneratedpublic boolean keepGenerated() - Returns:
- trueif generated code is kept.
 
 - 
incrementRemovedpublic void incrementRemoved() 
 - 
isRemovedpublic boolean isRemoved() 
 - 
compilepublic void compile() throws JasperException, java.io.FileNotFoundException- Throws:
- JasperException
- java.io.FileNotFoundException
 
 - 
loadpublic java.lang.Class<?> load() throws JasperException- Throws:
- JasperException
 
 - 
getFQCNpublic java.lang.String getFQCN() 
 - 
checkOutputDirpublic void checkOutputDir() 
 - 
makeOutputDirprotected boolean makeOutputDir() 
 - 
createOutputDirprotected void createOutputDir() 
 - 
isPathSeparatorprotected static final boolean isPathSeparator(char c) 
 - 
canonicalURIprotected static final java.lang.String canonicalURI(java.lang.String s) 
 
- 
 
-