org.apache.sling.scripting.jsp.jasper

Class JspCompilationContext

java.lang.Object

org.apache.sling.scripting.jsp.jasper.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

Constructor Summary

Constructors

Constructor and Description
JspCompilationContext(String jspUri, boolean isErrPage, Options options, javax.servlet.ServletContext context, JspRuntimeContext rctxt, boolean defaultIsSession)
JspCompilationContext(String tagfile, javax.servlet.jsp.tagext.TagInfo tagInfo, Options options, javax.servlet.ServletContext context, JspRuntimeContext rctxt, boolean defaultIsSession, URL tagFileJarUrl)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkOutputDir()
JasperException	compile()
boolean	delete(String fileName) Removes a (generated) file.
String	getClassFileName()
ClassLoader	getClassLoader() What class loader to use for loading classes while compiling this JSP?
Compiler	getCompiler()
String	getContentType() Get the content type of this JSP.
protected String	getDerivedPackageName()
InputStream	getInputStream(String fileName) Creates an input stream from the given file
String	getJavaPath() Path of the Java file relative to the work directory.
String	getJspFile() Path of the JSP URI.
Options	getOptions() Get hold of the Options object for this context.
String	getOutputDir() The output directory to generate code into.
OutputStream	getOutputStream(String fileName) Creates an output stream to the given file
String	getRealPath(String path) Gets the actual path of a URI relative to the context of the compilation.
URL	getResource(String res)
InputStream	getResourceAsStream(String res) Gets a resource as a stream, relative to the meanings of this context's implementation.
Set<String>	getResourcePaths(String path)
JspRuntimeContext	getRuntimeContext()
String	getServletClassName() Just the class name (does not include package name) of the generated class.
javax.servlet.ServletContext	getServletContext()
String	getServletJavaFileName() Full path name of the Java file into which the servlet is being generated.
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.
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.
URL	getTagFileJarUrl(String tagFile) 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.
javax.servlet.jsp.tagext.TagInfo	getTagInfo()
String[]	getTldLocation(String uri) Gets the 'location' of the TLD associated with the given taglib 'uri'.
ServletWriter	getWriter() Where is the servlet being generated?
boolean	isErrorPage() Are we processing something that has been declared as an errorpage?
boolean	isPrototypeMode() True if we are compiling a tag file in prototype mode.
boolean	isTagFile()
boolean	keepGenerated() Are we keeping generated code around?
Class<?>	load()
boolean	rename(String oldFileName, String newFileName) Renams then old file to the new file
String	resolveRelativeUri(String uri) Get the full value of a URI relative to this compilations context uses current file as the base.
void	setContentType(String contentType)
void	setErrorPage(boolean isErrPage)
void	setPrototypeMode(boolean pm)
void	setTagFileJarUrl(String tagFile, URL tagFileURL)
void	setTagInfo(javax.servlet.jsp.tagext.TagInfo tagi)
void	setWriter(ServletWriter writer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JspCompilationContext

public JspCompilationContext(String jspUri,
                     boolean isErrPage,
                     Options options,
                     javax.servlet.ServletContext context,
                     JspRuntimeContext rctxt,
                     boolean defaultIsSession)

JspCompilationContext

public JspCompilationContext(String tagfile,
                     javax.servlet.jsp.tagext.TagInfo tagInfo,
                     Options options,
                     javax.servlet.ServletContext context,
                     JspRuntimeContext rctxt,
                     boolean defaultIsSession,
                     URL tagFileJarUrl)

Method Detail

getClassLoader

public ClassLoader getClassLoader()

What class loader to use for loading classes while compiling this JSP?

getOutputStream

public OutputStream getOutputStream(String fileName)
                             throws IOException

Creates an output stream to the given file

Parameters:

fileName - The path to the file to write to

Returns:

The OutputStream to the file

Throws:

IOException - If an error occurrs creating the output stream.

getInputStream

public InputStream getInputStream(String fileName)
                           throws FileNotFoundException,
                                  IOException

Creates an input stream from the given file

Parameters:

fileName - The path to the file to read from

Returns:

The InputStream from the file

Throws:

FileNotFoundException - If the file cannot be found

IOException - If an error occurrs creating the intput stream.

delete

public boolean delete(String fileName)

Removes a (generated) file.

Parameters:

fileName - The path to the file to remove.

Returns:

true if the file has been removed.

rename

public boolean rename(String oldFileName,
             String newFileName)

Renams then old file to the new file

Returns:

true if the file has been renamed

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.

getCompiler

public Compiler getCompiler()

resolveRelativeUri

public String resolveRelativeUri(String uri)

Get the full value of a URI relative to this compilations context uses current file as the base.

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.

getResource

public URL getResource(String res)
                throws MalformedURLException

Throws:

MalformedURLException

getResourcePaths

public Set<String> getResourcePaths(String path)

getRealPath

public String getRealPath(String path)

Gets the actual path of a URI relative to the context of the compilation.

getTagFileJarUrl

public URL getTagFileJarUrl(String tagFile)

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.

setTagFileJarUrl

public void setTagFileJarUrl(String tagFile,
                    URL tagFileURL)

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.

getServletClassName

public String getServletClassName()

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

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.

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

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.

getDerivedPackageName

protected String getDerivedPackageName()

getServletJavaFileName

public String getServletJavaFileName()

Full path name of the Java file into which the servlet is being generated.

getOptions

public Options getOptions()

Get hold of the Options object for this context.

getServletContext

public javax.servlet.ServletContext getServletContext()

getRuntimeContext

public JspRuntimeContext getRuntimeContext()

getJavaPath

public String getJavaPath()

Path of the Java file relative to the work directory.

getClassFileName

public String getClassFileName()

getContentType

public String getContentType()

Get the content type of this JSP. Content type includes content type and encoding.

setContentType

public void setContentType(String contentType)

getWriter

public ServletWriter getWriter()

Where is the servlet being generated?

setWriter

public void setWriter(ServletWriter writer)

getTldLocation

public String[] getTldLocation(String uri)
                        throws JasperException

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?

compile

public JasperException compile()

load

public Class<?> load()
              throws JasperException

Throws:

JasperException

checkOutputDir

public void checkOutputDir()