Servlet--ServletContext接口

• Servlet--ServletContext接口

定义public interface ServletContext

定义了一个 Servlet 的环境对象，通过这个对象，Servlet 引擎向 Servlet 提供环境信息。一个 Servlet 的环境对象必须至少与它所驻留的主机是一一对应的。在一个处理多个虚拟主机的 Servlet 引擎中（例如，使用了 HTTP1.1 的主机 头域） ，每一个虚拟主机必须被视为一个单独的环境。此外，Servlet 引擎还可以创建对应于一组 Servlet 的环境对象。

方法

1、getAttribute

public Object getAttribute(String name);

返回 Servlet 环境对象中指定的属性对象。如果该属性对象不存在，返回空值。这个方法允许访问有关这个 Servlet 引擎的在该接口的其他方法中尚未提供的附加信息。

2、getAttributeNames

public Enumeration getAttributeNames();

返回一个 Servlet 环境对象中可用的属性名的列表。

3、getContext

public ServletContext getContext(String uripath);

返回一个 Servlet 环境对象，这个对象包括了特定 URI 路径的 Servlets 和资源，如果该路径不存在，则返回一个空值。URI 路径格式是/dir/dir/filename.ext。为了安全，如果通过这个方法访问一个受限制的 Servlet 的环境对象，会返回一个空值 。

4、getMajorVersion

public int getMajorVersion();

返回 Servlet 引擎支持的 ServletAPI 的主版本号。例如对于 2.1 版，这个方法会返回一个整数 2。

5、getMinorVersion

public int getMinorVersion();

返回 Servlet 引擎支持的 ServletAPI 的次版本号。例如对于 2.1 版，这个方法会返回一个整数 2。

6、getMimeType

public String getMimeType(String file);

返回指定文件的 MIME 类型，如果这种 MIME 类型未知，则返回一个空值。MIME 类型是由 Servlet 引擎的配置决定的。

7、getRealPath

public String getRealPath(String path);

一个符合 URL 路径格式的指定的虚拟路径的格式是： /dir/dir/filename.ext。 用这个方法 ，可以返回与一个符合该格式的虚拟路径相对应 的真实路径的 String。这个真实路径的格式应该适合于运行这个 Servlet 引擎的计算机（包括其相应的路径解析器） 。

不管是什么原因， 如果这一从虚拟路径转换成实际路径的过程不能执行， 该方法将会返回一个空值。

8、getResource

public URL getResource(String uripath);

返回一个 URL 对象，该对象反映位于给定的 URL 地址（格式：/dir/dir/filename.ext ） 的Servlet 环境对象已知的资源。 无论 URLStreamHandlers 对于访问给定的环境是不是必须的 ，Servlet 引擎都必须执行。如果给定的路径的 Servlet 环境没有已知的资 源，该方法会返回一个空值。这个方法和 java.lang.Class 的 getResource 方法不完全相同。 java.lang.Class 的

getResource 方法通过装载类来寻找资源。而这个方法允许服务器产生环境变量给任何资源的任何 Servlet， 而不必依赖于装载类、特定区域等等。

9、getResourceAsStream

public InputStream getResourceAsStream(String uripath);

返回一个 InputStream 对象，该对象引用指定的 URL 的 Servlet 环境对象的内容。如果没找到 Servlet 环境变量，就会返回空值，URL 路径应该具有这种格式：/dir/dir/filename.ext 。这个方法是一个通过 getResource 方法获得 URL 对象的方便的途径。请注意，当你使用这个方法时，meta-information（例如内容长度、内容类型）会丢失。

10、getRequestDispatcher

public RequestDispatcher getRequestDispatcher(String uripath);

如果这个指定的路径下能够找到活动的资源(例如一个 Servlet，JSP 页面，CGI 等等)就返回一个特定 URL 的RequestDispatcher 对象，否则，就返回一个空值，Servlet 引擎负责用一个 request dispatcher 对象封装目标路径。这个 request dispatcher 对象可以用来完全请求的传送。

11、getServerInfo

public String getServerInfo();

返回一个 String 对象，该对象至少包括 Servlet 引擎的名字和版本号。

12、log

public void log(String msg);

public void log(String msg, Throwable t);

public void log(Exception exception, String msg); // 这种用法将被取消

写指定的信息到一个 Servlet 环境对象的 log 文件中。被写入的 log 文件由 Servlet 引擎指定，但是通常这是一个事件 log。当这个方法被一个异常调用时，log 中将包括堆栈跟踪 。

13、setAttribute

public void setAttribute(String name, Object o);

给予 Servlet 环境对象中你所指定的对象一个名称。

14、removeAttribute

public void removeAttribute(String name);

从指定的 Servlet 环境对象中删除一个属性。

注：以下几个方法将被取消

15、getServlet

public Servlet getServlet(String name) throws ServletException;

最初用来返回一个指定名称的 Servlet，如果没找到就返回一个空值。如果这个 Servlet能够返回，这就意味着它已经被初始化，而且已经可以接受 service 请求。这是一个危险的方法。当调用这个方法时，可能并不知道 Servlet 的状态，这就可能导致有关服务器状态的问题。而允许一个 Servlet 访问其他 Servlet 的这个方法也同样的危险。现在这个方法返回一个空值， 为了保持和以前版本的兼容性， 现在这个方法还没有被取消。在以后的 API 版本中，该方法将被取消。

16、getServletNames

public Enumeration getServletNames();

最初用来返回一个 String 对象的列表，该列表表示了在这个 Servlet 环境下所有已知的Servlet 对象名。这个列表总是包含这个 Servlet 自身。基于与上一个方法同样的理由，这也是一个危险的方法。现在这个方法返回一个空的列表。 为了保持和以前版本的兼容性， 现在这个方法还没有被取消。在以后的 API 版本中，该方法将被取消。

17、getServlets

public Enumeration getServlets();

最初用来返回在这个 Servelet 环境下所有已知的 Servlet 对象的列表。这个列表总是包含这个 Servlet 自身。基于与 getServlet 方法同样的理由，这也是一个危险的方法。现在这个方法返回一个空的列表。 为了保持和以前版本的兼容性， 现在这个方法还没有被取消。在以后的 API 版本中，该方法将被取消。

这个类一般不怎么用到，下面贴出这个类的源码：

package javax.servlet;

import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Enumeration;
import java.util.Set;

public abstract interface ServletContext
{
  public abstract ServletContext getContext(String paramString);

  public abstract String getContextPath();

  public abstract int getMajorVersion();

  public abstract int getMinorVersion();

  public abstract String getMimeType(String paramString);

  public abstract Set getResourcePaths(String paramString);

  public abstract URL getResource(String paramString)
    throws MalformedURLException;

  public abstract InputStream getResourceAsStream(String paramString);

  public abstract RequestDispatcher getRequestDispatcher(String paramString);

  public abstract RequestDispatcher getNamedDispatcher(String paramString);

  /** @deprecated */
  public abstract Servlet getServlet(String paramString)
    throws ServletException;

  /** @deprecated */
  public abstract Enumeration getServlets();

  /** @deprecated */
  public abstract Enumeration getServletNames();

  public abstract void log(String paramString);

  /** @deprecated */
  public abstract void log(Exception paramException, String paramString);

  public abstract void log(String paramString, Throwable paramThrowable);

  public abstract String getRealPath(String paramString);

  public abstract String getServerInfo();

  public abstract String getInitParameter(String paramString);

  public abstract Enumeration getInitParameterNames();

  public abstract Object getAttribute(String paramString);

  public abstract Enumeration getAttributeNames();

  public abstract void setAttribute(String paramString, Object paramObject);

  public abstract void removeAttribute(String paramString);

  public abstract String getServletContextName();
}