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引擎支持的Servlet API的主版本号。例如对于2.1版，这个方法会返回一个整数2。

       5、getMinorVersion

       public int getMinorVersion();

       返回Servlet引擎支持的Servlet API的次版本号。例如对于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版本中，该方法将被取消。

 

 

参考资料：http://baike.baidu.com/view/3923348.htm?fr=aladdin