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 SummaryConstructorsConstructorDescriptionJspCompilationContext(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 SummaryModifier and TypeMethodDescriptionprotected static final Stringvoidvoidvoidcompile()Create a "Compiler" object based on some init param data.protected CompilercreateCompiler(String className) protected voidWhat class loader to use for loading classes while compiling this JSP?protected StringgetFQCN()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'.voidprotected static final booleanisPathSeparator(char c) booleanbooleanbooleanbooleanClass<?>load()protected booleanresolveRelativeUri(String uri) Get the full value of a URI relative to this compilations context uses current file as the base.voidsetBasePackageName(String basePackageName) The package name into which the servlet class is generated.voidsetClassLoader(ClassLoader loader) voidsetClassPath(String classPath) The classpath that is passed off to the Java compiler.voidsetPrototypeMode(boolean pm) voidsetServletClassName(String className) voidsetTagFileJar(Jar tagJar) voidsetTagInfo(TagInfo tagi) voidsetWriter(ServletWriter writer) 
- 
Constructor Details- 
JspCompilationContextpublic JspCompilationContext(String jspUri, Options options, ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt) 
- 
JspCompilationContextpublic 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.
 
- 
setClassPathThe classpath that is passed off to the Java compiler.- Parameters:
- classPath- The class path to use
 
- 
getClassLoaderWhat class loader to use for loading classes while compiling this JSP?- Returns:
- the class loader used to load all compiled classes
 
- 
setClassLoader
- 
getJspLoader
- 
clearJspLoaderpublic void clearJspLoader()
- 
getOutputDirThe 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
 
- 
createCompilerCreate 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
- 
resolveRelativeUriGet 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
 
- 
getResourceAsStreamGets 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
- 
getRealPathGets 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
 
- 
getTagFileJarReturns 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
- 
getServletClassNameJust the class name (does not include package name) of the generated class.- Returns:
- the class name
 
- 
setServletClassName
- 
getJspFilePath 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
- 
isTagFilepublic boolean isTagFile()
- 
getTagInfo
- 
setTagInfo
- 
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) 
- 
getServletPackageNamePackage 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
 
- 
setBasePackageNameThe 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
- 
getTldResourcePathGets 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()
- 
compile- Throws:
- JasperException
- FileNotFoundException
 
- 
load- Throws:
- JasperException
 
- 
getFQCN
- 
checkOutputDirpublic void checkOutputDir()
- 
makeOutputDirprotected boolean makeOutputDir()
- 
createOutputDirprotected void createOutputDir()
- 
isPathSeparatorprotected static final boolean isPathSeparator(char c) 
- 
canonicalURI
 
-