org.apache.catalina.core
public class ApplicationContext extends java.lang.Object implements javax.servlet.ServletContext
ServletContext that represents
a web application's execution environment. An instance of this class is
associated with each instance of StandardContext.| Modifier and Type | Field and Description |
|---|---|
protected java.util.Map |
attributes
The context attributes for this context.
|
| Constructor and Description |
|---|
ApplicationContext(java.lang.String basePath,
StandardContext context)
Construct a new instance of this class, associated with the specified
Context instance.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
clearAttributes()
Clear all application-created attributes.
|
java.lang.Object |
getAttribute(java.lang.String name)
Return the value of the specified context attribute, if any;
otherwise return
null. |
java.util.Enumeration |
getAttributeNames()
Return an enumeration of the names of the context attributes
associated with this context.
|
protected StandardContext |
getContext() |
javax.servlet.ServletContext |
getContext(java.lang.String uri)
Return a
ServletContext object that corresponds to a
specified URI on the server. |
java.lang.String |
getContextPath()
Return the main path associated with this context.
|
protected javax.servlet.ServletContext |
getFacade()
Return the facade associated with this ApplicationContext.
|
java.lang.String |
getInitParameter(java.lang.String name)
Return the value of the specified initialization parameter, or
null if this parameter does not exist. |
java.util.Enumeration |
getInitParameterNames()
Return the names of the context's initialization parameters, or an
empty enumeration if the context has no initialization parameters.
|
int |
getMajorVersion()
Return the major version of the Java Servlet API that we implement.
|
java.lang.String |
getMimeType(java.lang.String file)
Return the MIME type of the specified file, or
null if
the MIME type cannot be determined. |
int |
getMinorVersion()
Return the minor version of the Java Servlet API that we implement.
|
javax.servlet.RequestDispatcher |
getNamedDispatcher(java.lang.String name)
Return a
RequestDispatcher object that acts as a
wrapper for the named servlet. |
protected java.util.Map |
getReadonlyAttributes() |
java.lang.String |
getRealPath(java.lang.String path)
Return the real path for a given virtual path, if possible; otherwise
return
null. |
javax.servlet.RequestDispatcher |
getRequestDispatcher(java.lang.String path)
Return a
RequestDispatcher instance that acts as a
wrapper for the resource at the given path. |
java.net.URL |
getResource(java.lang.String path)
Return the URL to the resource that is mapped to a specified path.
|
java.io.InputStream |
getResourceAsStream(java.lang.String path)
Return the requested resource as an
InputStream. |
java.util.Set |
getResourcePaths(java.lang.String path)
Return a Set containing the resource paths of resources member of the
specified collection.
|
javax.naming.directory.DirContext |
getResources()
Return the resources object that is mapped to a specified path.
|
java.lang.String |
getServerInfo()
Return the name and version of the servlet container.
|
javax.servlet.Servlet |
getServlet(java.lang.String name)
Deprecated.
As of Java Servlet API 2.1, with no direct replacement.
|
java.lang.String |
getServletContextName()
Return the display name of this web application.
|
java.util.Enumeration |
getServletNames()
Deprecated.
As of Java Servlet API 2.1, with no direct replacement.
|
java.util.Enumeration |
getServlets()
Deprecated.
As of Java Servlet API 2.1, with no direct replacement.
|
void |
log(java.lang.Exception exception,
java.lang.String message)
Deprecated.
As of Java Servlet API 2.1, use
log(String, Throwable) instead |
void |
log(java.lang.String message)
Writes the specified message to a servlet log file.
|
void |
log(java.lang.String message,
java.lang.Throwable throwable)
Writes the specified message and exception to a servlet log file.
|
void |
removeAttribute(java.lang.String name)
Remove the context attribute with the specified name, if any.
|
void |
setAttribute(java.lang.String name,
java.lang.Object value)
Bind the specified value with the specified context attribute name,
replacing any existing value for that name.
|
boolean |
setInitParameter(java.lang.String name,
java.lang.String value) |
public ApplicationContext(java.lang.String basePath,
StandardContext context)
context - The associated Context instancepublic javax.naming.directory.DirContext getResources()
public java.lang.Object getAttribute(java.lang.String name)
null.getAttribute in interface javax.servlet.ServletContextname - Name of the context attribute to returnObject containing the value
of the attribute, or null
if no attribute exists matching the given
nameServletContext.getAttributeNames()public java.util.Enumeration getAttributeNames()
getAttributeNames in interface javax.servlet.ServletContextEnumeration of attribute
namesServletContext.getAttribute(java.lang.String)public javax.servlet.ServletContext getContext(java.lang.String uri)
ServletContext object that corresponds to a
specified URI 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 or resources from the
context. The given path must be absolute (beginning with a "/"),
and is interpreted based on our virtual host's document root.getContext in interface javax.servlet.ServletContexturi - Absolute URI of a resource on the serverServletContext object that
corresponds to the named URL, or null if either
none exists or the container wishes to restrict
this access.RequestDispatcherpublic java.lang.String getContextPath()
getContextPath in interface javax.servlet.ServletContextpublic java.lang.String getInitParameter(java.lang.String name)
null if this parameter does not exist.getInitParameter in interface javax.servlet.ServletContextname - Name of the initialization parameter to retrieveString containing at least the
servlet container name and version numberServletConfig.getInitParameter(java.lang.String)public boolean setInitParameter(java.lang.String name,
java.lang.String value)
public java.util.Enumeration getInitParameterNames()
getInitParameterNames in interface javax.servlet.ServletContextEnumeration of String
objects containing the names of the context's
initialization parametersServletConfig.getInitParameter(java.lang.String)public int getMajorVersion()
getMajorVersion in interface javax.servlet.ServletContextpublic int getMinorVersion()
getMinorVersion in interface javax.servlet.ServletContextpublic java.lang.String getMimeType(java.lang.String file)
null if
the MIME type cannot be determined.getMimeType in interface javax.servlet.ServletContextfile - Filename for which to identify a MIME typeString specifying the file's MIME typepublic javax.servlet.RequestDispatcher getNamedDispatcher(java.lang.String name)
RequestDispatcher object that acts as a
wrapper for the named servlet.getNamedDispatcher in interface javax.servlet.ServletContextname - Name of the servlet for which a dispatcher is requestedRequestDispatcher 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 java.lang.String getRealPath(java.lang.String path)
null.getRealPath in interface javax.servlet.ServletContextpath - The path to the desired resourceString specifying the real path,
or null if the translation cannot be performedpublic javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
RequestDispatcher instance that acts as a
wrapper for the resource at the given path. The path must begin
with a "/" and is interpreted as relative to the current context root.getRequestDispatcher in interface javax.servlet.ServletContextpath - The path to the desired 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 java.net.URL getResource(java.lang.String path)
throws java.net.MalformedURLException
getResource in interface javax.servlet.ServletContextpath - The path to the desired resourcenull if there is no resource
at that pathjava.net.MalformedURLException - if the path is not given
in the correct formpublic java.io.InputStream getResourceAsStream(java.lang.String path)
InputStream. The
path must be specified according to the rules described under
getResource. If no such resource can be identified,
return null.getResourceAsStream in interface javax.servlet.ServletContextpath - The path to the desired resource.InputStream returned to the
servlet, or null if no resource
exists at the specified pathpublic java.util.Set getResourcePaths(java.lang.String path)
getResourcePaths in interface javax.servlet.ServletContextpath - Collection pathpublic java.lang.String getServerInfo()
getServerInfo in interface javax.servlet.ServletContextString containing at least the
servlet container name and version numberpublic javax.servlet.Servlet getServlet(java.lang.String name)
getServlet in interface javax.servlet.ServletContextpublic java.lang.String getServletContextName()
getServletContextName in interface javax.servlet.ServletContextpublic java.util.Enumeration getServletNames()
getServletNames in interface javax.servlet.ServletContextpublic java.util.Enumeration getServlets()
getServlets in interface javax.servlet.ServletContextpublic void log(java.lang.String message)
log in interface javax.servlet.ServletContextmessage - Message to be writtenpublic void log(java.lang.Exception exception,
java.lang.String message)
log(String, Throwable) insteadlog in interface javax.servlet.ServletContextexception - Exception to be reportedmessage - Message to be writtenpublic void log(java.lang.String message,
java.lang.Throwable throwable)
log in interface javax.servlet.ServletContextmessage - Message to be writtenthrowable - Exception to be reportedpublic void removeAttribute(java.lang.String name)
removeAttribute in interface javax.servlet.ServletContextname - Name of the context attribute to be removedpublic void setAttribute(java.lang.String name,
java.lang.Object value)
setAttribute in interface javax.servlet.ServletContextname - Attribute name to be boundvalue - New attribute value to be boundprotected StandardContext getContext()
protected java.util.Map getReadonlyAttributes()
protected void clearAttributes()
protected javax.servlet.ServletContext getFacade()
Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.