| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.catalina.core.ApplicationContextFacade
public final class ApplicationContextFacade
Facade object which masks the internal ApplicationContext
 object from the web application.
| Constructor Summary | |
|---|---|
| ApplicationContextFacade(ApplicationContext context)Construct a new instance of this class, associated with the specified Context instance. | |
| Method Summary | |
|---|---|
|  java.lang.Object | getAttribute(java.lang.String name)Returns the servlet container attribute with the given name, or nullif there is no attribute by that name. | 
|  java.util.Enumeration | getAttributeNames()Returns an Enumerationcontaining the
 attribute names available
 within this servlet context. | 
|  javax.servlet.ServletContext | getContext(java.lang.String uripath)Returns a ServletContextobject that
 corresponds to a specified URL on the server. | 
|  java.lang.String | getContextPath() | 
|  java.lang.String | getInitParameter(java.lang.String name)Returns a Stringcontaining the value of the named
 context-wide initialization parameter, ornullif the
 parameter does not exist. | 
|  java.util.Enumeration | getInitParameterNames()Returns the names of the context's initialization parameters as an EnumerationofStringobjects, or an
 emptyEnumerationif the context has no initialization
 parameters. | 
|  int | getMajorVersion()Returns the major version of the Java Servlet API that this servlet container supports. | 
|  java.lang.String | getMimeType(java.lang.String file)Returns the MIME type of the specified file, or nullif
 the MIME type is not known. | 
|  int | getMinorVersion()Returns the minor version of the Servlet API that this servlet container supports. | 
|  javax.servlet.RequestDispatcher | getNamedDispatcher(java.lang.String name)Returns a RequestDispatcherobject that acts
 as a wrapper for the named servlet. | 
|  java.lang.String | getRealPath(java.lang.String path)Returns a Stringcontaining the real path
 for a given virtual path. | 
|  javax.servlet.RequestDispatcher | getRequestDispatcher(java.lang.String path)Returns a RequestDispatcherobject that acts
 as a wrapper for the resource located at the given path. | 
|  java.net.URL | getResource(java.lang.String path)Returns a URL to the resource that is mapped to a specified path. | 
|  java.io.InputStream | getResourceAsStream(java.lang.String path)Returns the resource located at the named path as an InputStreamobject. | 
|  java.util.Set | getResourcePaths(java.lang.String path)Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path matches the supplied path argument. | 
|  java.lang.String | getServerInfo()Returns the name and version of the servlet container on which the servlet is running. | 
|  javax.servlet.Servlet | getServlet(java.lang.String name) | 
|  java.lang.String | getServletContextName()Returns the name of this web application corresponding to this ServletContext as specified in the deployment descriptor for this web application by the display-name element. | 
|  java.util.Enumeration | getServletNames() | 
|  java.util.Enumeration | getServlets() | 
|  void | log(java.lang.Exception exception,
    java.lang.String msg) | 
|  void | log(java.lang.String msg)Writes the specified message to a servlet log file, usually an event log. | 
|  void | log(java.lang.String message,
    java.lang.Throwable throwable)Writes an explanatory message and a stack trace for a given Throwableexception
 to the servlet log file. | 
|  void | removeAttribute(java.lang.String name)Removes the attribute with the given name from the servlet context. | 
|  void | setAttribute(java.lang.String name,
             java.lang.Object object)Binds an object to a given attribute name in this servlet context. | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
|---|
public ApplicationContextFacade(ApplicationContext context)
context - The associated Context instance| Method Detail | 
|---|
public javax.servlet.ServletContext getContext(java.lang.String uripath)
javax.servlet.ServletContextServletContext object that
 corresponds to a specified URL on the server.
 This method allows servlets to gain
 access to the context for various parts of the server, and as
 needed obtain RequestDispatcher objects from the context.
 The given path must be begin with "/", is interpreted relative
 to the server's document root and is matched against the context roots of
 other web applications hosted on this container.
 
In a security conscious environment, the servlet container may
 return null for a given URL.
getContext in interface javax.servlet.ServletContexturipath - a String specifying the context path of
                        another web application in the container.
ServletContext object that
                        corresponds to the named URL, or null if either
                        none exists or the container wishes to restrict
                        this access.RequestDispatcherpublic int getMajorVersion()
javax.servlet.ServletContext
getMajorVersion in interface javax.servlet.ServletContextpublic int getMinorVersion()
javax.servlet.ServletContext
getMinorVersion in interface javax.servlet.ServletContextpublic java.lang.String getMimeType(java.lang.String file)
javax.servlet.ServletContextnull if
 the MIME type is not known. The MIME type is determined
 by the configuration of the servlet container, and may be specified
 in a web application deployment descriptor. Common MIME
 types are "text/html" and "image/gif".
getMimeType in interface javax.servlet.ServletContextfile - a String specifying the name
                        of a file
String specifying the file's MIME typepublic java.util.Set getResourcePaths(java.lang.String path)
javax.servlet.ServletContext
getResourcePaths in interface javax.servlet.ServletContextpath - the partial path used to match the resources,
                                which must start with a /
public java.net.URL getResource(java.lang.String path)
                         throws java.net.MalformedURLException
javax.servlet.ServletContextThis method allows the servlet container to make a resource
 available to servlets from any source. Resources
 can be located on a local or remote
 file system, in a database, or in a .war file.
 
The servlet container must implement the URL handlers
 and URLConnection objects that are necessary
 to access the resource.
 
This method returns null
 if no resource is mapped to the pathname.
 
Some containers may allow writing to the URL returned by this method using the methods of the URL class.
The resource content is returned directly, so be aware that
 requesting a .jsp page returns the JSP source code.
 Use a RequestDispatcher instead to include results of
 an execution.
 
This method has a different purpose than
 java.lang.Class.getResource,
 which looks up resources based on a class loader. This
 method does not use class loaders.
getResource in interface javax.servlet.ServletContextpath - a String specifying
                                                the path to the resource
null if there is no resource
                                                at that path
java.net.MalformedURLException - if the pathname is not given in
                                                the correct formpublic java.io.InputStream getResourceAsStream(java.lang.String path)
javax.servlet.ServletContextInputStream object.
 The data in the InputStream can be
 of any type or length. The path must be specified according
 to the rules given in getResource.
 This method returns null if no resource exists at
 the specified path.
 
Meta-information such as content length and content type
 that is available via getResource
 method is lost when using this method.
 
The servlet container must implement the URL handlers
 and URLConnection objects necessary to access
 the resource.
 
This method is different from
 java.lang.Class.getResourceAsStream,
 which uses a class loader. This method allows servlet containers
 to make a resource available
 to a servlet from any location, without using a class loader.
getResourceAsStream in interface javax.servlet.ServletContextpath - a String specifying the path
                        to the resource
InputStream returned to the
                        servlet, or null if no resource
                        exists at the specified pathpublic javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
javax.servlet.ServletContextRequestDispatcher object that acts
 as a wrapper for the resource located at the given path.
 A RequestDispatcher object can be used to forward
 a request to the resource or to include the resource in a response.
 The resource can be dynamic or static.
 The pathname must begin with a "/" and is interpreted as relative
 to the current context root.  Use getContext to obtain
 a RequestDispatcher for resources in foreign contexts.
 This method returns null if the ServletContext
 cannot return a RequestDispatcher.
getRequestDispatcher in interface javax.servlet.ServletContextpath - a String specifying the pathname
                        to the resource
RequestDispatcher object
                        that acts as a wrapper for the resource
                        at the specified path, or null if
                        the ServletContext cannot return
                        a RequestDispatcherRequestDispatcher, 
ServletContext.getContext(java.lang.String)public javax.servlet.RequestDispatcher getNamedDispatcher(java.lang.String name)
javax.servlet.ServletContextRequestDispatcher object that acts
 as a wrapper for the named servlet.
 Servlets (and JSP pages also) may be given names via server
 administration or via a web application deployment descriptor.
 A servlet instance can determine its name using
 ServletConfig.getServletName().
 
This method returns null if the
 ServletContext
 cannot return a RequestDispatcher for any reason.
getNamedDispatcher in interface javax.servlet.ServletContextname - a String specifying the name
                        of a servlet to wrap
RequestDispatcher object
                        that acts as a wrapper for the named servlet,
                        or null if the ServletContext
                        cannot return a RequestDispatcherRequestDispatcher, 
ServletContext.getContext(java.lang.String), 
ServletConfig.getServletName()
public javax.servlet.Servlet getServlet(java.lang.String name)
                                 throws javax.servlet.ServletException
getServlet in interface javax.servlet.ServletContextjavax.servlet.ServletExceptionpublic java.util.Enumeration getServlets()
getServlets in interface javax.servlet.ServletContextpublic java.util.Enumeration getServletNames()
getServletNames in interface javax.servlet.ServletContextpublic void log(java.lang.String msg)
javax.servlet.ServletContext
log in interface javax.servlet.ServletContextmsg - a String specifying the
                        message to be written to the log file
public void log(java.lang.Exception exception,
                java.lang.String msg)
log in interface javax.servlet.ServletContext
public void log(java.lang.String message,
                java.lang.Throwable throwable)
javax.servlet.ServletContextThrowable exception
 to the servlet log file. The name and type of the servlet log
 file is specific to the servlet container, usually an event log.
log in interface javax.servlet.ServletContextmessage - a String that
                                describes the error or exceptionthrowable - the Throwable error
                                or exceptionpublic java.lang.String getRealPath(java.lang.String path)
javax.servlet.ServletContextString containing the real path
 for a given virtual path. For example, the path "/index.html"
 returns the absolute file path on the server's filesystem would be
 served by a request for "http://host/contextPath/index.html",
 where contextPath is the context path of this ServletContext..
 The real path returned will be in a form
 appropriate to the computer and operating system on
 which the servlet container is running, including the
 proper path separators. This method returns null
 if the servlet container cannot translate the virtual path
 to a real path for any reason (such as when the content is
 being made available from a .war archive).
getRealPath in interface javax.servlet.ServletContextpath - a String specifying a virtual path
String specifying the real path,
                  or null if the translation cannot be performedpublic java.lang.String getServerInfo()
javax.servlet.ServletContextThe form of the returned string is
 servername/versionnumber.
 For example, the JavaServer Web Development Kit may return the string
 JavaServer Web Dev Kit/1.0.
 
The servlet container may return other optional information
 after the primary string in parentheses, for example,
 JavaServer Web Dev Kit/1.0 (JDK 1.1.6; Windows NT 4.0 x86).
getServerInfo in interface javax.servlet.ServletContextString containing at least the
                        servlet container name and version numberpublic java.lang.String getInitParameter(java.lang.String name)
javax.servlet.ServletContextString containing the value of the named
 context-wide initialization parameter, or null if the
 parameter does not exist.
 This method can make available configuration information useful to an entire "web application". For example, it can provide a webmaster's email address or the name of a system that holds critical data.
getInitParameter in interface javax.servlet.ServletContextname - a String containing the name of the parameter
            whose value is requested
String containing the value of the initialization
         parameterServletConfig.getInitParameter(java.lang.String)public java.util.Enumeration getInitParameterNames()
javax.servlet.ServletContextEnumeration of String objects, or an
 empty Enumeration if the context has no initialization
 parameters.
getInitParameterNames in interface javax.servlet.ServletContextEnumeration of String
                  objects containing the names of the context's
                  initialization parametersServletConfig.getInitParameter(java.lang.String)public java.lang.Object getAttribute(java.lang.String name)
javax.servlet.ServletContextnull if there is no attribute by that name.
 An attribute allows a servlet container to give the
 servlet additional information not
 already provided by this interface. See your
 server documentation for information about its attributes.
 A list of supported attributes can be retrieved using
 getAttributeNames.
 The attribute is returned as a java.lang.Object
 or some subclass.
 Attribute names should follow the same convention as package
 names. The Java Servlet API specification reserves names
 matching java.*, javax.*,
 and sun.*.
getAttribute in interface javax.servlet.ServletContextname - a String specifying the name
                        of the attribute
Object containing the value
                        of the attribute, or null
                        if no attribute exists matching the given
                        nameServletContext.getAttributeNames()public java.util.Enumeration getAttributeNames()
javax.servlet.ServletContextEnumeration containing the
 attribute names available
 within this servlet context. Use the
 ServletContext.getAttribute(java.lang.String) method with an attribute name
 to get the value of an attribute.
getAttributeNames in interface javax.servlet.ServletContextEnumeration of attribute
                        namesServletContext.getAttribute(java.lang.String)
public void setAttribute(java.lang.String name,
                         java.lang.Object object)
javax.servlet.ServletContextIf listeners are configured on the ServletContext the
 container notifies them accordingly.
 
 If a null value is passed, the effect is the same as calling
 removeAttribute().
 
Attribute names should follow the same convention as package
 names. The Java Servlet API specification reserves names
 matching java.*, javax.*, and
 sun.*.
setAttribute in interface javax.servlet.ServletContextname - a String specifying the name
                        of the attributeobject - an Object representing the
                        attribute to be boundpublic void removeAttribute(java.lang.String name)
javax.servlet.ServletContextServletContext.getAttribute(java.lang.String) to retrieve the attribute's value
 will return null.
 If listeners are configured on the ServletContext the
 container notifies them accordingly.
removeAttribute in interface javax.servlet.ServletContextname - a String specifying the name
                        of the attribute to be removedpublic java.lang.String getServletContextName()
javax.servlet.ServletContext
getServletContextName in interface javax.servlet.ServletContextpublic java.lang.String getContextPath()
getContextPath in interface javax.servlet.ServletContext| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||