Package org.apache.jasper

Class JspCompilationContext

  • public class JspCompilationContext
extends java.lang.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.

    • Field Detail

      • className

        private java.lang.String className

      • jspUri

        private java.lang.String jspUri

      • isErrPage

        private boolean isErrPage

      • basePackageName

        private java.lang.String basePackageName

      • derivedPackageName

        private java.lang.String derivedPackageName

      • servletJavaFileName

        private java.lang.String servletJavaFileName

      • javaPath

        private java.lang.String javaPath

      • classFileName

        private java.lang.String classFileName

      • contentType

        private java.lang.String contentType

      • jspCompiler

        private Compiler jspCompiler

      • classPath

        private java.lang.String classPath

      • baseURI

        private java.lang.String baseURI

      • outputDir

        private java.lang.String outputDir

      • context

        private javax.servlet.ServletContext context

      • loader

        private java.lang.ClassLoader loader

      • removed

        private int removed

      • baseUrl

        private java.net.URL baseUrl

      • servletClass

        private java.lang.Class servletClass

      • isTagFile

        private boolean isTagFile

      • protoTypeMode

        private boolean protoTypeMode

      • tagInfo

        private javax.servlet.jsp.tagext.TagInfo tagInfo

      • tagFileJarUrl

        private java.net.URL tagFileJarUrl

      • taglibs

        private java.util.concurrent.ConcurrentHashMap<java.lang.String,​TagLibraryInfoImpl> taglibs

      • tagFileJarUrls

        private java.util.concurrent.ConcurrentHashMap<java.lang.String,​java.net.URL> tagFileJarUrls

      • outputDirLock

        static java.lang.Object outputDirLock

    • Method Detail

      • cast

        private static <T> T cast​(java.lang.Object x)

      • addTaglib

        public void addTaglib​(java.lang.String uri,
                      TagLibraryInfoImpl taglib)
        Adds the given tag library with the given URI to the context-wide tag library cache.
        Parameters:
        uri - The tag library URI
        taglib - The tag library to add

      • getTaglibs

        public java.util.concurrent.ConcurrentHashMap<java.lang.String,​TagLibraryInfoImpl> getTaglibs()
        Gets the context-wide tag library cache.
        Returns:
        The context-wide tag library cache

      • clearTaglibs

        public void clearTaglibs()
        Clears the context-wide tag library cache.

      • clearTagFileJarUrls

        public void clearTagFileJarUrls()
        Clears the context-wide mappings from JAR packaged tag file paths to their corresponding URLs.

      • getClassPath

        public java.lang.String getClassPath()
        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.

      • getClassLoader

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

      • setClassLoader

        public void setClassLoader​(java.net.URLClassLoader loader)

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

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

      • getResourceAsStream

        public java.io.InputStream getResourceAsStream​(java.lang.String res)
                                        throws JasperException
        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.
        Throws:
        JasperException

      • 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)
                                                 throws JasperException
        Throws:
        JasperException

      • getRealPath

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

      • getTagFileJarUrls

        public java.util.concurrent.ConcurrentHashMap<java.lang.String,​java.net.URL> getTagFileJarUrls()
        Gets the context-wide mappings from JAR packaged tag file paths to their corresponfing URLs.

      • getTagFileJarUrl

        public java.net.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 java.lang.String getServletClassName()
        Just the class name (does not include package name) of the generated class.

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

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

      • getDerivedPackageName

        private java.lang.String getDerivedPackageName()

      • setServletPackageName

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

      • getServletJavaFileName

        public java.lang.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()

      • getFullClassName

        public java.lang.String getFullClassName()
        Full class name

      • getJavaPath

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

      • getClassFileName

        public java.lang.String getClassFileName()

      • getContentType

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

      • setContentType

        public void setContentType​(java.lang.String contentType)

      • getWriter

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

      • getTldLocation

        public java.lang.String[] getTldLocation​(java.lang.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?

      • incrementRemoved

        public void incrementRemoved()

      • isRemoved

        public boolean isRemoved()

      • load

        public java.lang.Class load()
                     throws JasperException,
                            java.lang.ClassNotFoundException
        Throws:
        JasperException
        java.lang.ClassNotFoundException

      • getJspLoader

        public java.lang.ClassLoader getJspLoader()

      • makeOutputDir

        public void makeOutputDir​(java.lang.String outdir)

      • createOutputDir

        private void createOutputDir()

      • isPathSeparator

        private static final boolean isPathSeparator​(char c)