TPServletContext (tompuss 0.3 API)

java.lang.Object
- cn.imaq.tompuss.servlet.TPServletContext

所有已实现的接口:: javax.servlet.ServletContext

public class TPServletContext
extends java.lang.Object
implements javax.servlet.ServletContext

字段概要
- 从接口继承的字段 javax.servlet.ServletContext
  ORDERED_LIBS, TEMPDIR

构造器概要

构造器
构造器和说明
`TPServletContext(TPEngine engine, java.lang.String appName, java.lang.String contextPath, java.io.File resourceRoot)`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`javax.servlet.FilterRegistration.Dynamic`	`addFilter(java.lang.String filterName, java.lang.Class<? extends javax.servlet.Filter> filterClass)` Adds the filter with the given name and class type to this servlet context.
`javax.servlet.FilterRegistration.Dynamic`	`addFilter(java.lang.String filterName, javax.servlet.Filter filter)` Registers the given filter instance with this ServletContext under the given `filterName`.
`javax.servlet.FilterRegistration.Dynamic`	`addFilter(java.lang.String filterName, java.lang.String className)` Adds the filter with the given name and class name to this servlet context.
`void`	`addFilterMapping(TPFilterMapping mapping, boolean isMatchAfter)`
`javax.servlet.ServletRegistration.Dynamic`	`addJspFile(java.lang.String servletName, java.lang.String jspFile)` Adds the servlet with the given jsp file to this servlet context.
`void`	`addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)` Adds a listener of the given class type to this ServletContext.
`void`	`addListener(java.lang.String className)` Adds the listener with the given class name to this ServletContext.
`<T extends java.util.EventListener> void`	`addListener(T t)` Adds the given listener to this ServletContext.
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(java.lang.String servletName, java.lang.Class<? extends javax.servlet.Servlet> servletClass)` Adds the servlet with the given name and class type to this servlet context.
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(java.lang.String servletName, javax.servlet.Servlet servlet)` Registers the given servlet instance with this ServletContext under the given `servletName`.
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(java.lang.String servletName, java.lang.String className)` Adds the servlet with the given name and class name to this servlet context.
`boolean`	`addServletMapping(java.lang.String pattern, TPServletRegistration registration)`
`<T extends javax.servlet.Filter> T`	`createFilter(java.lang.Class<T> clazz)` Instantiates the given Filter class.
`<T extends java.util.EventListener> T`	`createListener(java.lang.Class<T> clazz)` Instantiates the given EventListener class.
`<T extends javax.servlet.Servlet> T`	`createServlet(java.lang.Class<T> clazz)` Instantiates the given Servlet class.
`void`	`declareRoles(java.lang.String... roleNames)` Declares role names that are tested using `isUserInRole`.
`void`	`enableJsp()`
`java.lang.Object`	`getAttribute(java.lang.String name)` Returns the servlet container attribute with the given name, or `null` if there is no attribute by that name.
`java.util.Enumeration<java.lang.String>`	`getAttributeNames()` Returns an `Enumeration` containing the attribute names available within this ServletContext.
`java.lang.ClassLoader`	`getClassLoader()` Gets the class loader of the web application represented by this ServletContext.
`javax.servlet.ServletContext`	`getContext(java.lang.String uripath)` Returns a `ServletContext` object that corresponds to a specified URL on the server.
`java.lang.String`	`getContextPath()` Returns the context path of the web application.
`java.util.Set<javax.servlet.SessionTrackingMode>`	`getDefaultSessionTrackingModes()` Gets the session tracking modes that are supported by default for this `ServletContext`.
`int`	`getEffectiveMajorVersion()` Gets the major version of the Servlet specification that the application represented by this ServletContext is based on.
`int`	`getEffectiveMinorVersion()` Gets the minor version of the Servlet specification that the application represented by this ServletContext is based on.
`java.util.Set<javax.servlet.SessionTrackingMode>`	`getEffectiveSessionTrackingModes()` Gets the session tracking modes that are in effect for this `ServletContext`.
`javax.servlet.FilterRegistration`	`getFilterRegistration(java.lang.String filterName)` Gets the FilterRegistration corresponding to the filter with the given `filterName`.
`java.util.Map<java.lang.String,? extends javax.servlet.FilterRegistration>`	`getFilterRegistrations()` Gets a (possibly empty) Map of the FilterRegistration objects (keyed by filter name) corresponding to all filters registered with this ServletContext.
`java.lang.String`	`getInitParameter(java.lang.String name)` Returns a `String` containing the value of the named context-wide initialization parameter, or `null` if the parameter does not exist.
`java.util.Enumeration<java.lang.String>`	`getInitParameterNames()` Returns the names of the context's initialization parameters as an `Enumeration` of `String` objects, or an empty `Enumeration` if the context has no initialization parameters.
`javax.servlet.descriptor.JspConfigDescriptor`	`getJspConfigDescriptor()` Gets the `<jsp-config>` related configuration that was aggregated from the `web.xml` and `web-fragment.xml` descriptor files of the web application represented by this ServletContext.
`<T extends java.util.EventListener> java.util.Collection<T>`	`getListeners(java.lang.Class<T> listenerClass)`
`int`	`getMajorVersion()` Returns the major version of the Servlet API that this servlet container supports.
`java.lang.String`	`getMimeType(java.lang.String file)` Returns the MIME type of the specified file, or `null` if 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 `RequestDispatcher` object that acts as a wrapper for the named servlet.
`java.lang.String`	`getRealPath(java.lang.String path)` Gets the real path corresponding to the given virtual path.
`java.lang.String`	`getRequestCharacterEncoding()` Gets the request character encoding that are supported by default for this `ServletContext`.
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(java.lang.String path)` Returns a `RequestDispatcher` object 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 the given path.
`java.io.InputStream`	`getResourceAsStream(java.lang.String path)` Returns the resource located at the named path as an `InputStream` object.
`java.util.Set<java.lang.String>`	`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`	`getResponseCharacterEncoding()` Gets the response character encoding that are supported by default for this `ServletContext`.
`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)` 已过时。 As of Java Servlet API 2.1, with no direct replacement. This method was originally defined to retrieve a servlet from a `ServletContext`. In this version, this method always returns `null` and remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API. In lieu of this method, servlets can share information using the `ServletContext` class and can perform shared business logic by invoking methods on common non-servlet classes.
`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<java.lang.String>`	`getServletNames()` 已过时。 As of Java Servlet API 2.1, with no replacement. This method was originally defined to return an `Enumeration` of all the servlet names known to this context. In this version, this method always returns an empty `Enumeration` and remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API.
`javax.servlet.ServletRegistration`	`getServletRegistration(java.lang.String servletName)` Gets the ServletRegistration corresponding to the servlet with the given `servletName`.
`java.util.Map<java.lang.String,? extends javax.servlet.ServletRegistration>`	`getServletRegistrations()` Gets a (possibly empty) Map of the ServletRegistration objects (keyed by servlet name) corresponding to all servlets registered with this ServletContext.
`java.util.Enumeration<javax.servlet.Servlet>`	`getServlets()` 已过时。 As of Java Servlet API 2.0, with no replacement. This method was originally defined to return an `Enumeration` of all the servlets known to this servlet context. In this version, this method always returns an empty enumeration and remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API.
`javax.servlet.SessionCookieConfig`	`getSessionCookieConfig()` Gets the `SessionCookieConfig` object through which various properties of the session tracking cookies created on behalf of this `ServletContext` may be configured.
`int`	`getSessionTimeout()` Gets the session timeout in minutes that are supported by default for this `ServletContext`.
`java.lang.String`	`getVirtualServerName()` Returns the configuration name of the logical host on which the ServletContext is deployed.
`void`	`loadConfigFile(java.lang.String fileName)`
`void`	`log(java.lang.Exception exception, java.lang.String msg)` 已过时。 As of Java Servlet API 2.1, use `log(String message, Throwable throwable)` instead. This method was originally defined to write an exception's stack trace and an explanatory error message to the servlet log file.
`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 `Throwable` exception to the servlet log file.
`TPFilterChain`	`matchFilters(java.lang.String path, javax.servlet.Servlet servlet, javax.servlet.DispatcherType dispatcherType)`
`TPMatchResult<TPServletRegistration>`	`matchServletByPath(java.lang.String path)`
`void`	`removeAttribute(java.lang.String name)` Removes the attribute with the given name from this ServletContext.
`void`	`scanAnnotations()`
`void`	`setAttribute(java.lang.String name, java.lang.Object object)` Binds an object to a given attribute name in this ServletContext.
`boolean`	`setInitParameter(java.lang.String name, java.lang.String value)` Sets the context initialization parameter with the given name and value on this ServletContext.
`void`	`setRequestCharacterEncoding(java.lang.String encoding)` Sets the request character encoding for this ServletContext.
`void`	`setResponseCharacterEncoding(java.lang.String encoding)` Sets the response character encoding for this ServletContext.
`void`	`setSessionTimeout(int sessionTimeout)` Sets the session timeout in minutes for this ServletContext.
`void`	`setSessionTrackingModes(java.util.Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)` Sets the session tracking modes that are to become effective for this `ServletContext`.
`void`	`startup()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - TPServletContext
```
public TPServletContext(TPEngine engine,
                        java.lang.String appName,
                        java.lang.String contextPath,
                        java.io.File resourceRoot)
```
- 方法详细资料
  - loadConfigFile
```
public void loadConfigFile(java.lang.String fileName)
```
  - scanAnnotations
```
public void scanAnnotations()
```
  - enableJsp
```
public void enableJsp()
```
  - startup
```
public void startup()
```
  - matchServletByPath
```
public TPMatchResult<TPServletRegistration> matchServletByPath(java.lang.String path)
```
  - matchFilters
```
public TPFilterChain matchFilters(java.lang.String path,
                                  javax.servlet.Servlet servlet,
                                  javax.servlet.DispatcherType dispatcherType)
```
  - getContextPath
```
public java.lang.String getContextPath()
```
    Returns the context path of the web application.
    
    The context path is the portion of the request URI that is used to select the context of the request. The context path always comes first in a request URI. If this context is the "root" context rooted at the base of the Web server's URL name space, this path will be an empty string. Otherwise, if the context is not rooted at the root of the server's name space, the path starts with a / character but does not end with a / character.
    
    It is possible that a servlet container may match a context by more than one context path. In such cases the HttpServletRequest.getContextPath() will return the actual context path used by the request and it may differ from the path returned by this method. The context path returned by this method should be considered as the prime or preferred context path of the application.
    
    指定者:
    
    getContextPath 在接口中 javax.servlet.ServletContext
    
    返回:
    
    The context path of the web application, or "" for the root context
    
    从以下版本开始:
    
    Servlet 2.5
    
    另请参阅:
    
    HttpServletRequest.getContextPath()
  - getContext
```
public javax.servlet.ServletContext getContext(java.lang.String uripath)
```
    Returns a ServletContext 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 在接口中 javax.servlet.ServletContext
    
    参数:
    
    uripath - a String specifying the context path of another web application in the container.
    
    返回:
    
    the ServletContext object that corresponds to the named URL, or null if either none exists or the container wishes to restrict this access.
    
    另请参阅:
    
    RequestDispatcher
  - getMajorVersion
```
public int getMajorVersion()
```
    Returns the major version of the Servlet API that this servlet container supports. All implementations that comply with Version 4.0 must have this method return the integer 4.
    
    指定者:
    
    getMajorVersion 在接口中 javax.servlet.ServletContext
    
    返回:
    
    4
  - getMinorVersion
```
public int getMinorVersion()
```
    Returns the minor version of the Servlet API that this servlet container supports. All implementations that comply with Version 4.0 must have this method return the integer 0.
    
    指定者:
    
    getMinorVersion 在接口中 javax.servlet.ServletContext
    
    返回:
    
    0
  - getEffectiveMajorVersion
```
public int getEffectiveMajorVersion()
```
    Gets the major version of the Servlet specification that the application represented by this ServletContext is based on.
    
    The value returned may be different from getMajorVersion(), which returns the major version of the Servlet specification supported by the Servlet container.
    
    指定者:
    
    getEffectiveMajorVersion 在接口中 javax.servlet.ServletContext
    
    返回:
    
    the major version of the Servlet specification that the application represented by this ServletContext is based on
    
    抛出:
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - getEffectiveMinorVersion
```
public int getEffectiveMinorVersion()
```
    Gets the minor version of the Servlet specification that the application represented by this ServletContext is based on.
    
    The value returned may be different from getMinorVersion(), which returns the minor version of the Servlet specification supported by the Servlet container.
    
    指定者:
    
    getEffectiveMinorVersion 在接口中 javax.servlet.ServletContext
    
    返回:
    
    the minor version of the Servlet specification that the application represented by this ServletContext is based on
    
    抛出:
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - getMimeType
```
public java.lang.String getMimeType(java.lang.String file)
```
    Returns the MIME type of the specified file, or null 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 include text/html and image/gif.
    
    指定者:
    
    getMimeType 在接口中 javax.servlet.ServletContext
    
    参数:
    
    file - a String specifying the name of a file
    
    返回:
    
    a String specifying the file's MIME type
  - getResourcePaths
```
public java.util.Set<java.lang.String> 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.
    
    Paths indicating subdirectory paths end with a /.
    
    The returned paths are all relative to the root of the web application, or relative to the /META-INF/resources directory of a JAR file inside the web application's /WEB-INF/lib directory, and have a leading /.
    
    The returned set is not backed by the ServletContext object, so changes in the returned set are not reflected in the ServletContext object, and vice-versa.
    
    For example, for a web application containing:
```
   /welcome.html
   /catalog/index.html
   /catalog/products.html
   /catalog/offers/books.html
   /catalog/offers/music.html
   /customer/login.jsp
   /WEB-INF/web.xml
   /WEB-INF/classes/com.acme.OrderServlet.class
   /WEB-INF/lib/catalog.jar!/META-INF/resources/catalog/moreOffers/books.html
 
```
    getResourcePaths("/") would return {"/welcome.html", "/catalog/", "/customer/", "/WEB-INF/"}, and getResourcePaths("/catalog/") would return {"/catalog/index.html", "/catalog/products.html", "/catalog/offers/", "/catalog/moreOffers/"}.
    指定者:
    
    getResourcePaths 在接口中 javax.servlet.ServletContext
    
    参数:
    
    path - the partial path used to match the resources, which must start with a /
    
    返回:
    
    a Set containing the directory listing, or null if there are no resources in the web application whose path begins with the supplied path.
    
    从以下版本开始:
    
    Servlet 2.3
  - getResource
```
public java.net.URL getResource(java.lang.String path)
                         throws java.net.MalformedURLException
```
    Returns a URL to the resource that is mapped to the given path.
    
    The path must begin with a / and is interpreted as relative to the current context root, or relative to the /META-INF/resources directory of a JAR file inside the web application's /WEB-INF/lib directory. This method will first search the document root of the web application for the requested resource, before searching any of the JAR files inside /WEB-INF/lib. The order in which the JAR files inside /WEB-INF/lib are searched is undefined.
    
    This 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 在接口中 javax.servlet.ServletContext
    
    参数:
    
    path - a String specifying the path to the resource
    
    返回:
    
    the resource located at the named path, or null if there is no resource at that path
    
    抛出:
    
    java.net.MalformedURLException - if the pathname is not given in the correct form
  - getResourceAsStream
```
public java.io.InputStream getResourceAsStream(java.lang.String path)
```
    Returns the resource located at the named path as an InputStream 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 在接口中 javax.servlet.ServletContext
    
    参数:
    
    path - a String specifying the path to the resource
    
    返回:
    
    the InputStream returned to the servlet, or null if no resource exists at the specified path
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
```
    Returns a RequestDispatcher 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 在接口中 javax.servlet.ServletContext
    
    参数:
    
    path - a String specifying the pathname to the resource
    
    返回:
    
    a RequestDispatcher object that acts as a wrapper for the resource at the specified path, or null if the ServletContext cannot return a RequestDispatcher
    
    另请参阅:
    
    RequestDispatcher, ServletContext.getContext(java.lang.String)
  - getNamedDispatcher
```
public javax.servlet.RequestDispatcher getNamedDispatcher(java.lang.String name)
```
    Returns a RequestDispatcher 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 在接口中 javax.servlet.ServletContext
    
    参数:
    
    name - a String specifying the name of a servlet to wrap
    
    返回:
    
    a RequestDispatcher object that acts as a wrapper for the named servlet, or null if the ServletContext cannot return a RequestDispatcher
    
    另请参阅:
    
    RequestDispatcher, ServletContext.getContext(java.lang.String), ServletConfig.getServletName()
  - getServlet
```
public javax.servlet.Servlet getServlet(java.lang.String name)
                                 throws javax.servlet.ServletException
```
    已过时。 As of Java Servlet API 2.1, with no direct replacement.
    
    This method was originally defined to retrieve a servlet from a ServletContext. In this version, this method always returns null and remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API.
    
    In lieu of this method, servlets can share information using the ServletContext class and can perform shared business logic by invoking methods on common non-servlet classes.
    
    指定者:
    
    getServlet 在接口中 javax.servlet.ServletContext
    
    参数:
    
    name - the servlet name
    
    返回:
    
    the javax.servlet.Servlet Servlet with the given name
    
    抛出:
    
    javax.servlet.ServletException - if an exception has occurred that interfaces with servlet's normal operation
  - getServlets
```
public java.util.Enumeration<javax.servlet.Servlet> getServlets()
```
    已过时。 As of Java Servlet API 2.0, with no replacement.
    
    This method was originally defined to return an Enumeration of all the servlets known to this servlet context. In this version, this method always returns an empty enumeration and remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API.
    
    指定者:
    
    getServlets 在接口中 javax.servlet.ServletContext
    
    返回:
    
    an Enumeration of javax.servlet.Servlet Servlet
  - getServletNames
```
public java.util.Enumeration<java.lang.String> getServletNames()
```
    已过时。 As of Java Servlet API 2.1, with no replacement.
    
    This method was originally defined to return an Enumeration of all the servlet names known to this context. In this version, this method always returns an empty Enumeration and remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API.
    
    指定者:
    
    getServletNames 在接口中 javax.servlet.ServletContext
    
    返回:
    
    an Enumeration of javax.servlet.Servlet Servlet names
  - log
```
public void log(java.lang.String msg)
```
    Writes the specified message to a servlet log file, usually an event log. The name and type of the servlet log file is specific to the servlet container.
    
    指定者:
    
    log 在接口中 javax.servlet.ServletContext
    
    参数:
    
    msg - a String specifying the message to be written to the log file
  - log
```
public void log(java.lang.Exception exception,
                java.lang.String msg)
```
    已过时。 As of Java Servlet API 2.1, use log(String message, Throwable throwable) instead.
    
    This method was originally defined to write an exception's stack trace and an explanatory error message to the servlet log file.
    
    指定者:
    
    log 在接口中 javax.servlet.ServletContext
    
    参数:
    
    exception - the Exception error
    
    msg - a String that describes the exception
  - log
```
public void log(java.lang.String message,
                java.lang.Throwable throwable)
```
    Writes an explanatory message and a stack trace for a given Throwable 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 在接口中 javax.servlet.ServletContext
    
    参数:
    
    message - a String that describes the error or exception
    
    throwable - the Throwable error
  - getRealPath
```
public java.lang.String getRealPath(java.lang.String path)
```
    Gets the real path corresponding to the given virtual path.
    
    For example, if path is equal to /index.html, this method will return the absolute file path on the server's filesystem to which a request of the form http://<host>:<port>/<contextPath>/index.html would be mapped, where <contextPath> corresponds to 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.
    
    Resources inside the /META-INF/resources directories of JAR files bundled in the application's /WEB-INF/lib directory must be considered only if the container has unpacked them from their containing JAR file, in which case the path to the unpacked location must be returned.
    
    This method returns null if the servlet container is unable to translate the given virtual path to a real path.
    
    指定者:
    
    getRealPath 在接口中 javax.servlet.ServletContext
    
    参数:
    
    path - the virtual path to be translated to a real path
    
    返回:
    
    the real path, or null if the translation cannot be performed
  - getServerInfo
```
public java.lang.String getServerInfo()
```
    Returns the name and version of the servlet container on which the servlet is running.
    
    The 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 在接口中 javax.servlet.ServletContext
    
    返回:
    
    a String containing at least the servlet container name and version number
  - getInitParameter
```
public java.lang.String getInitParameter(java.lang.String name)
```
    Returns a String 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 在接口中 javax.servlet.ServletContext
    
    参数:
    
    name - a String containing the name of the parameter whose value is requested
    
    返回:
    
    a String containing the value of the context's initialization parameter, or null if the context's initialization parameter does not exist.
    
    抛出:
    
    java.lang.NullPointerException - if the argument name is null
    
    另请参阅:
    
    ServletConfig.getInitParameter(java.lang.String)
  - getInitParameterNames
```
public java.util.Enumeration<java.lang.String> getInitParameterNames()
```
    Returns the names of the context's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the context has no initialization parameters.
    
    指定者:
    
    getInitParameterNames 在接口中 javax.servlet.ServletContext
    
    返回:
    
    an Enumeration of String objects containing the names of the context's initialization parameters
    
    另请参阅:
    
    ServletConfig.getInitParameter(java.lang.String)
  - setInitParameter
```
public boolean setInitParameter(java.lang.String name,
                                java.lang.String value)
```
    Sets the context initialization parameter with the given name and value on this ServletContext.
    
    指定者:
    
    setInitParameter 在接口中 javax.servlet.ServletContext
    
    参数:
    
    name - the name of the context initialization parameter to set
    
    value - the value of the context initialization parameter to set
    
    返回:
    
    true if the context initialization parameter with the given name and value was set successfully on this ServletContext, and false if it was not set because this ServletContext already contains a context initialization parameter with a matching name
    
    抛出:
    
    java.lang.IllegalStateException - if this ServletContext has already been initialized
    
    java.lang.NullPointerException - if the name parameter is null
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - getAttribute
```
public java.lang.Object getAttribute(java.lang.String name)
```
    Returns the servlet container attribute with the given name, or null 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 在接口中 javax.servlet.ServletContext
    
    参数:
    
    name - a String specifying the name of the attribute
    
    返回:
    
    an Object containing the value of the attribute, or null if no attribute exists matching the given name.
    
    抛出:
    
    java.lang.NullPointerException - if the argument name is null
    
    另请参阅:
    
    ServletContext.getAttributeNames()
  - getAttributeNames
```
public java.util.Enumeration<java.lang.String> getAttributeNames()
```
    Returns an Enumeration containing the attribute names available within this ServletContext.
    
    Use the getAttribute(java.lang.String) method with an attribute name to get the value of an attribute.
    
    指定者:
    
    getAttributeNames 在接口中 javax.servlet.ServletContext
    
    返回:
    
    an Enumeration of attribute names
    
    另请参阅:
    
    getAttribute(java.lang.String)
  - setAttribute
```
public void setAttribute(java.lang.String name,
                         java.lang.Object object)
```
    Binds an object to a given attribute name in this ServletContext. If the name specified is already used for an attribute, this method will replace the attribute with the new to the new attribute.
    If 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 在接口中 javax.servlet.ServletContext
    
    参数:
    
    name - a String specifying the name of the attribute
    
    object - an Object representing the attribute to be bound
    
    抛出:
    
    java.lang.NullPointerException - if the name parameter is null
  - removeAttribute
```
public void removeAttribute(java.lang.String name)
```
    Removes the attribute with the given name from this ServletContext. After removal, subsequent calls to 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 在接口中 javax.servlet.ServletContext
    
    参数:
    
    name - a String specifying the name of the attribute to be removed
  - getServletContextName
```
public 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.
    
    指定者:
    
    getServletContextName 在接口中 javax.servlet.ServletContext
    
    返回:
    
    The name of the web application or null if no name has been declared in the deployment descriptor.
    
    从以下版本开始:
    
    Servlet 2.3
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(java.lang.String servletName,
                                                            java.lang.String className)
```
    Adds the servlet with the given name and class name to this servlet context.
    
    The registered servlet may be further configured via the returned ServletRegistration object.
    
    The specified className will be loaded using the classloader associated with the application represented by this ServletContext.
    
    If this ServletContext already contains a preliminary ServletRegistration for a servlet with the given servletName, it will be completed (by assigning the given className to it) and returned.
    
    This method introspects the class with the given className for the ServletSecurity, MultipartConfig, javax.annotation.security.RunAs, and javax.annotation.security.DeclareRoles annotations. In addition, this method supports resource injection if the class with the given className represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.
    
    指定者:
    
    addServlet 在接口中 javax.servlet.ServletContext
    
    参数:
    
    servletName - the name of the servlet
    
    className - the fully qualified class name of the servlet
    
    返回:
    
    a ServletRegistration object that may be used to further configure the registered servlet, or null if this ServletContext already contains a complete ServletRegistration for a servlet with the given servletName
    
    抛出:
    
    java.lang.IllegalStateException - if this ServletContext has already been initialized
    
    java.lang.IllegalArgumentException - if servletName is null or an empty String
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(java.lang.String servletName,
                                                            javax.servlet.Servlet servlet)
```
    Registers the given servlet instance with this ServletContext under the given servletName.
    
    The registered servlet may be further configured via the returned ServletRegistration object.
    
    If this ServletContext already contains a preliminary ServletRegistration for a servlet with the given servletName, it will be completed (by assigning the class name of the given servlet instance to it) and returned.
    
    指定者:
    
    addServlet 在接口中 javax.servlet.ServletContext
    
    参数:
    
    servletName - the name of the servlet
    
    servlet - the servlet instance to register
    
    返回:
    
    a ServletRegistration object that may be used to further configure the given servlet, or null if this ServletContext already contains a complete ServletRegistration for a servlet with the given servletName or if the same servlet instance has already been registered with this or another ServletContext in the same container
    
    抛出:
    
    java.lang.IllegalStateException - if this ServletContext has already been initialized
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    java.lang.IllegalArgumentException - if the given servlet instance implements SingleThreadModel, or servletName is null or an empty String
    
    从以下版本开始:
    
    Servlet 3.0
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(java.lang.String servletName,
                                                            java.lang.Class<? extends javax.servlet.Servlet> servletClass)
```
    Adds the servlet with the given name and class type to this servlet context.
    
    The registered servlet may be further configured via the returned ServletRegistration object.
    
    If this ServletContext already contains a preliminary ServletRegistration for a servlet with the given servletName, it will be completed (by assigning the name of the given servletClass to it) and returned.
    
    This method introspects the given servletClass for the ServletSecurity, MultipartConfig, javax.annotation.security.RunAs, and javax.annotation.security.DeclareRoles annotations. In addition, this method supports resource injection if the given servletClass represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.
    
    指定者:
    
    addServlet 在接口中 javax.servlet.ServletContext
    
    参数:
    
    servletName - the name of the servlet
    
    servletClass - the class object from which the servlet will be instantiated
    
    返回:
    
    a ServletRegistration object that may be used to further configure the registered servlet, or null if this ServletContext already contains a complete ServletRegistration for the given servletName
    
    抛出:
    
    java.lang.IllegalStateException - if this ServletContext has already been initialized
    
    java.lang.IllegalArgumentException - if servletName is null or an empty String
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - addServletMapping
```
public boolean addServletMapping(java.lang.String pattern,
                                 TPServletRegistration registration)
```
  - addJspFile
```
public javax.servlet.ServletRegistration.Dynamic addJspFile(java.lang.String servletName,
                                                            java.lang.String jspFile)
```
    Adds the servlet with the given jsp file to this servlet context.
    
    The registered servlet may be further configured via the returned ServletRegistration object.
    
    If this ServletContext already contains a preliminary ServletRegistration for a servlet with the given servletName, it will be completed (by assigning the given jspFile to it) and returned.
    
    指定者:
    
    addJspFile 在接口中 javax.servlet.ServletContext
    
    参数:
    
    servletName - the name of the servlet
    
    jspFile - the full path to a JSP file within the web application beginning with a `/'.
    
    返回:
    
    a ServletRegistration object that may be used to further configure the registered servlet, or null if this ServletContext already contains a complete ServletRegistration for a servlet with the given servletName
    
    抛出:
    
    java.lang.IllegalStateException - if this ServletContext has already been initialized
    
    java.lang.IllegalArgumentException - if servletName is null or an empty String
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 4.0
  - createServlet
```
public <T extends javax.servlet.Servlet> T createServlet(java.lang.Class<T> clazz)
                                                  throws javax.servlet.ServletException
```
    Instantiates the given Servlet class.
    
    The returned Servlet instance may be further customized before it is registered with this ServletContext via a call to addServlet(String, Servlet).
    
    The given Servlet class must define a zero argument constructor, which is used to instantiate it.
    
    This method introspects the given clazz for the following annotations: ServletSecurity, MultipartConfig, javax.annotation.security.RunAs, and javax.annotation.security.DeclareRoles. In addition, this method supports resource injection if the given clazz represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.
    
    指定者:
    
    createServlet 在接口中 javax.servlet.ServletContext
    
    参数:
    
    clazz - the Servlet class to instantiate
    
    返回:
    
    the new Servlet instance
    
    抛出:
    
    javax.servlet.ServletException - if the given clazz fails to be instantiated
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - getServletRegistration
```
public javax.servlet.ServletRegistration getServletRegistration(java.lang.String servletName)
```
    Gets the ServletRegistration corresponding to the servlet with the given servletName.
    
    指定者:
    
    getServletRegistration 在接口中 javax.servlet.ServletContext
    
    参数:
    
    servletName - the name of a servlet
    
    返回:
    
    the (complete or preliminary) ServletRegistration for the servlet with the given servletName, or null if no ServletRegistration exists under that name
    
    抛出:
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - getServletRegistrations
```
public java.util.Map<java.lang.String,? extends javax.servlet.ServletRegistration> getServletRegistrations()
```
    Gets a (possibly empty) Map of the ServletRegistration objects (keyed by servlet name) corresponding to all servlets registered with this ServletContext.
    
    The returned Map includes the ServletRegistration objects corresponding to all declared and annotated servlets, as well as the ServletRegistration objects corresponding to all servlets that have been added via one of the addServlet and addJspFile methods.
    
    If permitted, any changes to the returned Map must not affect this ServletContext.
    
    指定者:
    
    getServletRegistrations 在接口中 javax.servlet.ServletContext
    
    返回:
    
    Map of the (complete and preliminary) ServletRegistration objects corresponding to all servlets currently registered with this ServletContext
    
    抛出:
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(java.lang.String filterName,
                                                          java.lang.String className)
```
    Adds the filter with the given name and class name to this servlet context.
    
    The registered filter may be further configured via the returned FilterRegistration object.
    
    The specified className will be loaded using the classloader associated with the application represented by this ServletContext.
    
    If this ServletContext already contains a preliminary FilterRegistration for a filter with the given filterName, it will be completed (by assigning the given className to it) and returned.
    
    This method supports resource injection if the class with the given className represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.
    
    指定者:
    
    addFilter 在接口中 javax.servlet.ServletContext
    
    参数:
    
    filterName - the name of the filter
    
    className - the fully qualified class name of the filter
    
    返回:
    
    a FilterRegistration object that may be used to further configure the registered filter, or null if this ServletContext already contains a complete FilterRegistration for a filter with the given filterName
    
    抛出:
    
    java.lang.IllegalStateException - if this ServletContext has already been initialized
    
    java.lang.IllegalArgumentException - if filterName is null or an empty String
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(java.lang.String filterName,
                                                          javax.servlet.Filter filter)
```
    Registers the given filter instance with this ServletContext under the given filterName.
    
    The registered filter may be further configured via the returned FilterRegistration object.
    
    If this ServletContext already contains a preliminary FilterRegistration for a filter with the given filterName, it will be completed (by assigning the class name of the given filter instance to it) and returned.
    
    指定者:
    
    addFilter 在接口中 javax.servlet.ServletContext
    
    参数:
    
    filterName - the name of the filter
    
    filter - the filter instance to register
    
    返回:
    
    a FilterRegistration object that may be used to further configure the given filter, or null if this ServletContext already contains a complete FilterRegistration for a filter with the given filterName or if the same filter instance has already been registered with this or another ServletContext in the same container
    
    抛出:
    
    java.lang.IllegalStateException - if this ServletContext has already been initialized
    
    java.lang.IllegalArgumentException - if filterName is null or an empty String
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(java.lang.String filterName,
                                                          java.lang.Class<? extends javax.servlet.Filter> filterClass)
```
    Adds the filter with the given name and class type to this servlet context.
    
    The registered filter may be further configured via the returned FilterRegistration object.
    
    If this ServletContext already contains a preliminary FilterRegistration for a filter with the given filterName, it will be completed (by assigning the name of the given filterClass to it) and returned.
    
    This method supports resource injection if the given filterClass represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.
    
    指定者:
    
    addFilter 在接口中 javax.servlet.ServletContext
    
    参数:
    
    filterName - the name of the filter
    
    filterClass - the class object from which the filter will be instantiated
    
    返回:
    
    a FilterRegistration object that may be used to further configure the registered filter, or null if this ServletContext already contains a complete FilterRegistration for a filter with the given filterName
    
    抛出:
    
    java.lang.IllegalStateException - if this ServletContext has already been initialized
    
    java.lang.IllegalArgumentException - if filterName is null or an empty String
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - addFilterMapping
```
public void addFilterMapping(TPFilterMapping mapping,
                             boolean isMatchAfter)
```
  - createFilter
```
public <T extends javax.servlet.Filter> T createFilter(java.lang.Class<T> clazz)
                                                throws javax.servlet.ServletException
```
    Instantiates the given Filter class.
    
    The returned Filter instance may be further customized before it is registered with this ServletContext via a call to addFilter(String, Filter).
    
    The given Filter class must define a zero argument constructor, which is used to instantiate it.
    
    This method supports resource injection if the given clazz represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.
    
    指定者:
    
    createFilter 在接口中 javax.servlet.ServletContext
    
    参数:
    
    clazz - the Filter class to instantiate
    
    返回:
    
    the new Filter instance
    
    抛出:
    
    javax.servlet.ServletException - if the given clazz fails to be instantiated
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - getFilterRegistration
```
public javax.servlet.FilterRegistration getFilterRegistration(java.lang.String filterName)
```
    Gets the FilterRegistration corresponding to the filter with the given filterName.
    
    指定者:
    
    getFilterRegistration 在接口中 javax.servlet.ServletContext
    
    参数:
    
    filterName - the name of a filter
    
    返回:
    
    the (complete or preliminary) FilterRegistration for the filter with the given filterName, or null if no FilterRegistration exists under that name
    
    抛出:
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - getFilterRegistrations
```
public java.util.Map<java.lang.String,? extends javax.servlet.FilterRegistration> getFilterRegistrations()
```
    Gets a (possibly empty) Map of the FilterRegistration objects (keyed by filter name) corresponding to all filters registered with this ServletContext.
    
    The returned Map includes the FilterRegistration objects corresponding to all declared and annotated filters, as well as the FilterRegistration objects corresponding to all filters that have been added via one of the addFilter methods.
    
    Any changes to the returned Map must not affect this ServletContext.
    
    指定者:
    
    getFilterRegistrations 在接口中 javax.servlet.ServletContext
    
    返回:
    
    Map of the (complete and preliminary) FilterRegistration objects corresponding to all filters currently registered with this ServletContext
    
    抛出:
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - getSessionCookieConfig
```
public javax.servlet.SessionCookieConfig getSessionCookieConfig()
```
    Gets the SessionCookieConfig object through which various properties of the session tracking cookies created on behalf of this ServletContext may be configured.
    
    Repeated invocations of this method will return the same SessionCookieConfig instance.
    
    指定者:
    
    getSessionCookieConfig 在接口中 javax.servlet.ServletContext
    
    返回:
    
    the SessionCookieConfig object through which various properties of the session tracking cookies created on behalf of this ServletContext may be configured
    
    抛出:
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - setSessionTrackingModes
```
public void setSessionTrackingModes(java.util.Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)
```
    Sets the session tracking modes that are to become effective for this ServletContext.
    
    The given sessionTrackingModes replaces any session tracking modes set by a previous invocation of this method on this ServletContext.
    
    指定者:
    
    setSessionTrackingModes 在接口中 javax.servlet.ServletContext
    
    参数:
    
    sessionTrackingModes - the set of session tracking modes to become effective for this ServletContext
    
    抛出:
    
    java.lang.IllegalStateException - if this ServletContext has already been initialized
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    java.lang.IllegalArgumentException - if sessionTrackingModes specifies a combination of SessionTrackingMode.SSL with a session tracking mode other than SessionTrackingMode.SSL, or if sessionTrackingModes specifies a session tracking mode that is not supported by the servlet container
    
    从以下版本开始:
    
    Servlet 3.0
  - getDefaultSessionTrackingModes
```
public java.util.Set<javax.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()
```
    Gets the session tracking modes that are supported by default for this ServletContext.
    
    The returned set is not backed by the ServletContext object, so changes in the returned set are not reflected in the ServletContext object, and vice-versa.
    
    指定者:
    
    getDefaultSessionTrackingModes 在接口中 javax.servlet.ServletContext
    
    返回:
    
    set of the session tracking modes supported by default for this ServletContext
    
    抛出:
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - getEffectiveSessionTrackingModes
```
public java.util.Set<javax.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()
```
    Gets the session tracking modes that are in effect for this ServletContext.
    
    The session tracking modes in effect are those provided to setSessionTrackingModes.
    
    The returned set is not backed by the ServletContext object, so changes in the returned set are not reflected in the ServletContext object, and vice-versa.
    
    指定者:
    
    getEffectiveSessionTrackingModes 在接口中 javax.servlet.ServletContext
    
    返回:
    
    set of the session tracking modes in effect for this ServletContext
    
    抛出:
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - addListener
```
public void addListener(java.lang.String className)
```
    Adds the listener with the given class name to this ServletContext.
    
    The class with the given name will be loaded using the classloader associated with the application represented by this ServletContext, and must implement one or more of the following interfaces:
    - ServletContextAttributeListener
    - ServletRequestListener
    - ServletRequestAttributeListener
    - HttpSessionAttributeListener
    - HttpSessionIdListener
    - HttpSessionListener
    If this ServletContext was passed to ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, javax.servlet.ServletContext), then the class with the given name may also implement ServletContextListener, in addition to the interfaces listed above.
    
    As part of this method call, the container must load the class with the specified class name to ensure that it implements one of the required interfaces.
    
    If the class with the given name implements a listener interface whose invocation order corresponds to the declaration order (i.e., if it implements ServletRequestListener, ServletContextListener, or HttpSessionListener), then the new listener will be added to the end of the ordered list of listeners of that interface.
    
    This method supports resource injection if the class with the given className represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.
    指定者:
    
    addListener 在接口中 javax.servlet.ServletContext
    
    参数:
    
    className - the fully qualified class name of the listener
    
    抛出:
    
    java.lang.IllegalArgumentException - if the class with the given name does not implement any of the above interfaces, or if it implements ServletContextListener and this ServletContext was not passed to ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, javax.servlet.ServletContext)
    
    java.lang.IllegalStateException - if this ServletContext has already been initialized
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - addListener
```
public <T extends java.util.EventListener> void addListener(T t)
```
    Adds the given listener to this ServletContext.
    
    The given listener must be an instance of one or more of the following interfaces:
    - ServletContextAttributeListener
    - ServletRequestListener
    - ServletRequestAttributeListener
    - HttpSessionAttributeListener
    - HttpSessionIdListener
    - HttpSessionListener
    If this ServletContext was passed to ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, javax.servlet.ServletContext), then the given listener may also be an instance of ServletContextListener, in addition to the interfaces listed above.
    
    If the given listener is an instance of a listener interface whose invocation order corresponds to the declaration order (i.e., if it is an instance of ServletRequestListener, ServletContextListener, or HttpSessionListener), then the listener will be added to the end of the ordered list of listeners of that interface.
    指定者:
    
    addListener 在接口中 javax.servlet.ServletContext
    
    参数:
    
    t - the listener to be added
    
    抛出:
    
    java.lang.IllegalArgumentException - if the given listener is not an instance of any of the above interfaces, or if it is an instance of ServletContextListener and this ServletContext was not passed to ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, javax.servlet.ServletContext)
    
    java.lang.IllegalStateException - if this ServletContext has already been initialized
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - addListener
```
public void addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)
```
    Adds a listener of the given class type to this ServletContext.
    
    The given listenerClass must implement one or more of the following interfaces:
    - ServletContextAttributeListener
    - ServletRequestListener
    - ServletRequestAttributeListener
    - HttpSessionAttributeListener
    - HttpSessionIdListener
    - HttpSessionListener
    If this ServletContext was passed to ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, javax.servlet.ServletContext), then the given listenerClass may also implement ServletContextListener, in addition to the interfaces listed above.
    
    If the given listenerClass implements a listener interface whose invocation order corresponds to the declaration order (i.e., if it implements ServletRequestListener, ServletContextListener, or HttpSessionListener), then the new listener will be added to the end of the ordered list of listeners of that interface.
    
    This method supports resource injection if the given listenerClass represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.
    指定者:
    
    addListener 在接口中 javax.servlet.ServletContext
    
    参数:
    
    listenerClass - the listener class to be instantiated
    
    抛出:
    
    java.lang.IllegalArgumentException - if the given listenerClass does not implement any of the above interfaces, or if it implements ServletContextListener and this ServletContext was not passed to ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, javax.servlet.ServletContext)
    
    java.lang.IllegalStateException - if this ServletContext has already been initialized
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
  - createListener
```
public <T extends java.util.EventListener> T createListener(java.lang.Class<T> clazz)
                                                     throws javax.servlet.ServletException
```
    Instantiates the given EventListener class.
    
    The specified EventListener class must implement at least one of the ServletContextListener, ServletContextAttributeListener, ServletRequestListener, ServletRequestAttributeListener, HttpSessionAttributeListener, HttpSessionIdListener, or HttpSessionListener interfaces.
    
    The returned EventListener instance may be further customized before it is registered with this ServletContext via a call to addListener(EventListener).
    
    The given EventListener class must define a zero argument constructor, which is used to instantiate it.
    
    This method supports resource injection if the given clazz represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.
    
    指定者:
    
    createListener 在接口中 javax.servlet.ServletContext
    
    参数:
    
    clazz - the EventListener class to instantiate
    
    返回:
    
    the new EventListener instance
    
    抛出:
    
    javax.servlet.ServletException - if the given clazz fails to be instantiated
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    java.lang.IllegalArgumentException - if the specified EventListener class does not implement any of the ServletContextListener, ServletContextAttributeListener, ServletRequestListener, ServletRequestAttributeListener, HttpSessionAttributeListener, HttpSessionIdListener, or HttpSessionListener interfaces.
    
    从以下版本开始:
    
    Servlet 3.0
  - getListeners
```
public <T extends java.util.EventListener> java.util.Collection<T> getListeners(java.lang.Class<T> listenerClass)
```
  - getJspConfigDescriptor
```
public javax.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()
```
    Gets the <jsp-config> related configuration that was aggregated from the web.xml and web-fragment.xml descriptor files of the web application represented by this ServletContext.
    
    指定者:
    
    getJspConfigDescriptor 在接口中 javax.servlet.ServletContext
    
    返回:
    
    the <jsp-config> related configuration that was aggregated from the web.xml and web-fragment.xml descriptor files of the web application represented by this ServletContext, or null if no such configuration exists
    
    抛出:
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.0
    
    另请参阅:
    
    JspConfigDescriptor
  - getClassLoader
```
public java.lang.ClassLoader getClassLoader()
```
    Gets the class loader of the web application represented by this ServletContext.
    
    If a security manager exists, and the caller's class loader is not the same as, or an ancestor of the requested class loader, then the security manager's checkPermission method is called with a RuntimePermission("getClassLoader") permission to check whether access to the requested class loader should be granted.
    
    指定者:
    
    getClassLoader 在接口中 javax.servlet.ServletContext
    
    返回:
    
    the class loader of the web application represented by this ServletContext
    
    抛出:
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    java.lang.SecurityException - if a security manager denies access to the requested class loader
    
    从以下版本开始:
    
    Servlet 3.0
  - declareRoles
```
public void declareRoles(java.lang.String... roleNames)
```
    Declares role names that are tested using isUserInRole.
    
    Roles that are implicitly declared as a result of their use within the setServletSecurity or setRunAsRole methods of the ServletRegistration interface need not be declared.
    
    指定者:
    
    declareRoles 在接口中 javax.servlet.ServletContext
    
    参数:
    
    roleNames - the role names being declared
    
    抛出:
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    java.lang.IllegalArgumentException - if any of the argument roleNames is null or the empty string
    
    java.lang.IllegalStateException - if the ServletContext has already been initialized
    
    从以下版本开始:
    
    Servlet 3.0
  - getVirtualServerName
```
public java.lang.String getVirtualServerName()
```
    Returns the configuration name of the logical host on which the ServletContext is deployed.
    Servlet containers may support multiple logical hosts. This method must return the same name for all the servlet contexts deployed on a logical host, and the name returned by this method must be distinct, stable per logical host, and suitable for use in associating server configuration information with the logical host. The returned value is NOT expected or required to be equivalent to a network address or hostname of the logical host.
    
    指定者:
    
    getVirtualServerName 在接口中 javax.servlet.ServletContext
    
    返回:
    
    a String containing the configuration name of the logical host on which the servlet context is deployed.
    
    抛出:
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 3.1
  - getSessionTimeout
```
public int getSessionTimeout()
```
    Gets the session timeout in minutes that are supported by default for this ServletContext.
    
    指定者:
    
    getSessionTimeout 在接口中 javax.servlet.ServletContext
    
    返回:
    
    the session timeout in minutes that are supported by default for this ServletContext
    
    抛出:
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 4.0
  - setSessionTimeout
```
public void setSessionTimeout(int sessionTimeout)
```
    Sets the session timeout in minutes for this ServletContext.
    
    指定者:
    
    setSessionTimeout 在接口中 javax.servlet.ServletContext
    
    参数:
    
    sessionTimeout - session timeout in minutes
    
    抛出:
    
    java.lang.IllegalStateException - if this ServletContext has already been initialized
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 4.0
  - getRequestCharacterEncoding
```
public java.lang.String getRequestCharacterEncoding()
```
    Gets the request character encoding that are supported by default for this ServletContext. This method returns null if no request encoding character encoding has been specified in deployment descriptor or container specific configuration (for all web applications in the container).
    
    指定者:
    
    getRequestCharacterEncoding 在接口中 javax.servlet.ServletContext
    
    返回:
    
    the request character encoding that are supported by default for this ServletContext
    
    抛出:
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 4.0
  - setRequestCharacterEncoding
```
public void setRequestCharacterEncoding(java.lang.String encoding)
```
    Sets the request character encoding for this ServletContext.
    
    指定者:
    
    setRequestCharacterEncoding 在接口中 javax.servlet.ServletContext
    
    参数:
    
    encoding - request character encoding
    
    抛出:
    
    java.lang.IllegalStateException - if this ServletContext has already been initialized
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 4.0
  - getResponseCharacterEncoding
```
public java.lang.String getResponseCharacterEncoding()
```
    Gets the response character encoding that are supported by default for this ServletContext. This method returns null if no response encoding character encoding has been specified in deployment descriptor or container specific configuration (for all web applications in the container).
    
    指定者:
    
    getResponseCharacterEncoding 在接口中 javax.servlet.ServletContext
    
    返回:
    
    the request character encoding that are supported by default for this ServletContext
    
    抛出:
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 4.0
  - setResponseCharacterEncoding
```
public void setResponseCharacterEncoding(java.lang.String encoding)
```
    Sets the response character encoding for this ServletContext.
    
    指定者:
    
    setResponseCharacterEncoding 在接口中 javax.servlet.ServletContext
    
    参数:
    
    encoding - response character encoding
    
    抛出:
    
    java.lang.IllegalStateException - if this ServletContext has already been initialized
    
    java.lang.UnsupportedOperationException - if this ServletContext was passed to the ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method of a ServletContextListener that was neither declared in web.xml or web-fragment.xml, nor annotated with WebListener
    
    从以下版本开始:
    
    Servlet 4.0

类 TPServletContext

字段概要

从接口继承的字段 javax.servlet.ServletContext

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

TPServletContext

方法详细资料

loadConfigFile

scanAnnotations

enableJsp

startup

matchServletByPath

matchFilters

getContextPath

getContext

getMajorVersion

getMinorVersion

getEffectiveMajorVersion

getEffectiveMinorVersion

getMimeType

getResourcePaths

getResource

getResourceAsStream

getRequestDispatcher

getNamedDispatcher

getServlet

getServlets

getServletNames

log

log

log

getRealPath

getServerInfo

getInitParameter

getInitParameterNames

setInitParameter

getAttribute

getAttributeNames

setAttribute

removeAttribute

getServletContextName

addServlet

addServlet

addServlet

addServletMapping

addJspFile

createServlet

getServletRegistration

getServletRegistrations

addFilter

addFilter

addFilter

addFilterMapping

createFilter

getFilterRegistration

getFilterRegistrations

getSessionCookieConfig

setSessionTrackingModes

getDefaultSessionTrackingModes

getEffectiveSessionTrackingModes

addListener

addListener

addListener

createListener

getListeners

getJspConfigDescriptor

getClassLoader

declareRoles

getVirtualServerName

getSessionTimeout

setSessionTimeout

getRequestCharacterEncoding

setRequestCharacterEncoding

getResponseCharacterEncoding

setResponseCharacterEncoding