org.apache.jasper

Class JspCompilationContext

public class JspCompilationContext extends Object

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

Field Summary
protected Loglog
Constructor Summary
JspCompilationContext(String jspUri, boolean isErrPage, Options options, ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt)
JspCompilationContext(String tagfile, TagInfo tagInfo, Options options, ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt, URL tagFileJarUrl)
Method Summary
voidcompile()
CompilercreateCompiler()
Create a "Compiler" object based on some init param data.
StringgetClassFileName()
ClassLoadergetClassLoader()
What class loader to use for loading classes while compiling this JSP?
StringgetClassPath()
The classpath that is passed off to the Java compiler.
CompilergetCompiler()
StringgetContentType()
Get the content type of this JSP.
StringgetJavaPath()
Path of the Java file relative to the work directory.
StringgetJspFile()
Path of the JSP URI.
ClassLoadergetJspLoader()
OptionsgetOptions()
Get hold of the Options object for this context.
StringgetOutputDir()
The output directory to generate code into.
StringgetRealPath(String path)
Gets the actual path of a URI relative to the context of the compilation.
URLgetResource(String res)
InputStreamgetResourceAsStream(String res)
Gets a resource as a stream, relative to the meanings of this context's implementation.
SetgetResourcePaths(String path)
JspRuntimeContextgetRuntimeContext()
StringgetServletClassName()
Just the class name (does not include package name) of the generated class.
ServletContextgetServletContext()
StringgetServletJavaFileName()
Full path name of the Java file into which the servlet is being generated.
StringgetServletPackageName()
Package name for the generated class is make up of the base package name, which is user settable, and the derived package name.
URLgetTagFileJarUrl()
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.
HashtablegetTagFileJarUrls()
Returns the tag-file-name-to-JAR-file map of this compilation unit, which maps tag file names to the JAR files in which the tag files are packaged.
TagInfogetTagInfo()
String[]getTldLocation(String uri)
Gets the 'location' of the TLD associated with the given taglib 'uri'.
ServletWritergetWriter()
Where is the servlet being generated?
voidincrementRemoved()
booleanisErrorPage()
Are we processing something that has been declared as an errorpage?
booleanisPrototypeMode()
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.
booleanisRemoved()
booleanisTagFile()
booleankeepGenerated()
Are we keeping generated code around?
Classload()
StringresolveRelativeUri(String uri)
Get the full value of a URI relative to this compilations context uses current file as the base.
voidsetClassLoader(URLClassLoader loader)
voidsetClassPath(String classPath)
The classpath that is passed off to the Java compiler.
voidsetContentType(String contentType)
voidsetErrorPage(boolean isErrPage)
voidsetPrototypeMode(boolean pm)
voidsetServletClassName(String className)
voidsetServletJavaFileName(String servletJavaFileName)
voidsetServletPackageName(String servletPackageName)
The package name into which the servlet class is generated.
voidsetTagInfo(TagInfo tagi)
voidsetWriter(ServletWriter writer)

Field Detail

log

protected Log log

Constructor Detail

JspCompilationContext

public JspCompilationContext(String jspUri, boolean isErrPage, Options options, ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt)

JspCompilationContext

public JspCompilationContext(String tagfile, TagInfo tagInfo, Options options, ServletContext context, JspServletWrapper jsw, JspRuntimeContext rctxt, URL tagFileJarUrl)

Method Detail

compile

public void compile()

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.

getClassFileName

public String getClassFileName()

getClassLoader

public ClassLoader getClassLoader()
What class loader to use for loading classes while compiling this JSP?

getClassPath

public String getClassPath()
The classpath that is passed off to the Java compiler.

getCompiler

public Compiler getCompiler()

getContentType

public String getContentType()
Get the content type of this JSP. Content type includes content type and encoding.

getJavaPath

public String getJavaPath()
Path of the Java file relative to the work directory.

getJspFile

public 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.

getJspLoader

public ClassLoader getJspLoader()

getOptions

public Options getOptions()
Get hold of the Options object for this context.

getOutputDir

public 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.

getRealPath

public String getRealPath(String path)
Gets the actual path of a URI relative to the context of the compilation.

getResource

public URL getResource(String res)

getResourceAsStream

public InputStream getResourceAsStream(String res)
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.

getResourcePaths

public Set getResourcePaths(String path)

getRuntimeContext

public JspRuntimeContext getRuntimeContext()

getServletClassName

public String getServletClassName()
Just the class name (does not include package name) of the generated class.

getServletContext

public ServletContext getServletContext()

getServletJavaFileName

public String getServletJavaFileName()
Full path name of the Java file into which the servlet is being generated.

getServletPackageName

public 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 heirachy of the JSP page.

getTagFileJarUrl

public URL 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.

getTagFileJarUrls

public Hashtable getTagFileJarUrls()
Returns the tag-file-name-to-JAR-file map of this compilation unit, which maps tag file names to the JAR files in which the tag files are packaged. The map is populated when parsing the tag-file elements of the TLDs of any imported taglibs.

getTagInfo

public TagInfo getTagInfo()

getTldLocation

public String[] getTldLocation(String uri)
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.

getWriter

public ServletWriter getWriter()
Where is the servlet being generated?

incrementRemoved

public void incrementRemoved()

isErrorPage

public boolean isErrorPage()
Are we processing something that has been declared as an errorpage?

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.

isRemoved

public boolean isRemoved()

isTagFile

public boolean isTagFile()

keepGenerated

public boolean keepGenerated()
Are we keeping generated code around?

load

public Class load()

resolveRelativeUri

public String resolveRelativeUri(String uri)
Get the full value of a URI relative to this compilations context uses current file as the base.

setClassLoader

public void setClassLoader(URLClassLoader loader)

setClassPath

public void setClassPath(String classPath)
The classpath that is passed off to the Java compiler.

setContentType

public void setContentType(String contentType)

setErrorPage

public void setErrorPage(boolean isErrPage)

setPrototypeMode

public void setPrototypeMode(boolean pm)

setServletClassName

public void setServletClassName(String className)

setServletJavaFileName

public void setServletJavaFileName(String servletJavaFileName)

setServletPackageName

public void setServletPackageName(String servletPackageName)
The package name into which the servlet class is generated.

setTagInfo

public void setTagInfo(TagInfo tagi)

setWriter

public void setWriter(ServletWriter writer)
Copyright B) 2000-2004 Apache Software Foundation. All Rights Reserved.