当前位置:早雪网网络学院编程文档Java → Java Servlet API说明文档(2.1a版)(二)

Java Servlet API说明文档(2.1a版)(二)

减小字体 增大字体 作者:不详  来源:supcode.com收集整理  发布时间:2005-7-22 18:46:28
API对象的说明
      这一部分包含了对Java Servlet API的全部类和接口的详细说明。这个说明与Javadoc API差不多,但是这份文档提供了更多的信息。
API包含了两个软件包,十二个接口和九个类。
软件包:javax.servlet 
所包含的接口:RequestDispatcher;Servlet;ServletConfig;ServletContext;ServletRequest;ServletResponse;SingleThreadModel。
所包含的类:GenericServlet;ServletInputStream;ServletOutputStream;ServletException;UnavailableException。

      一、RequestDispatcher接口:
      定义:
      public interface RequestDispatcher;
      定义一个对象,从客户端接收请求,然后将它发给服务器的可用资源(例如Servlet、CGI、HTML文件、JSP文件)。Servlet引擎创建request dispatcher对象,用于封装由一个特定的URL定义的服务器资源。
      这个接口是专用于封装Servlet的,但是一个Servlet引擎可以创建request dispatcher对象用于封装任何类型的资源。
      request dispatcher对象是由Servlet引擎建立的,而不是由Servlet开发者建立的。
      方法
      1、forward
      public void forward(ServletRequest request, ServletReponse response)
            throws ServletException, IOException;
      被用来从这个Servlet向其它服务器资源传递请求。当一个Servlet对响应作了初步的处理,并要求其它的对象对此作出响应时,可以使用这个方法。
      当request对象被传递到目标对象时,请求的URL路径和其他路径参数会被调整为反映目标对象的目标URL路径。
      如果已经通过响应返回了一个ServletOutputStream对象或PrintWriter对象,这个方法将不能使用,否则,这个方法会抛出一个IllegalStateException。
      2、include
      public void include(ServletRequest request, ServletResponse response)
            throws ServletException, IOException
      用来包括发送给其他服务器资源的响应的内容。本质上来说,这个方法反映了服务器端的内容。
      请求对象传到目标对象后会反映调用请求的请求URL路径和路径信息。这个响应对象只能调用这个Servlet的ServletOutputStream对象和PrintWriter对象。
      一个调用include的Servlet不能设置头域,如果这个Servlet调用了必须设置头域的方法(例如cookie),这个方法将不能保证正常使用。作为一个Servlet开发者,你必须妥善地解决那些可能直接存储头域的方法。例如,即使你使用会话跟踪,为了保证session的正常工作,你必须在一个调用include的Servlet之外开始你的session

      二、Servlet接口。
      定义
      public interface Servlet
      这个接口定义了一个Servlet:一个在Web服务器上继承了这个功能的Java类。
      方法
      1、init
      public void init(ServletConfig config) throws ServletException;
      Servlet引擎会在Servlet实例化之后,置入服务之前精确地调用init方法。在调用service方法之前,init方法必须成功退出。
      如果init方法抛出一个ServletException,你不能将这个Servlet置入服务中,如果init方法在超时范围内没完成,我们也可以假定这个Servlet是不具备功能的,也不能置入服务中。
      2、service
      public void service(ServletRequest request, ServletResponse response)
            throws ServletException, IOException;
      Servlet引擎调用这个方法以允许Servlet响应请求。这个方法在Servlet未成功初始化之前无法调用。在Servlet被初始化之前,Servlet引擎能够封锁未决的请求。
      在一个Servlet对象被卸载后,直到一个新的Servelt被初始化,Servlet引擎不能调用这个方法
      3、destroy
      public void destroy();
      当一个Servlet被从服务中去除时,Servlet引擎调用这个方法。在这个对象的service方法所有线程未全部退出或者没被引擎认为发生超时操作时,destroy方法不能被调用。
      4、getServletConfig
      public ServletConfig getServletConfig();
      返回一个ServletConfig对象,作为一个Servlet的开发者,你应该通过init方法存储ServletConfig对象以便这个方法能返回这个对象。为了你的便利,GenericServlet在执行这个接口时,已经这样做了。
      5、getServletInfo
      public String getServletInfo();
      允许Servlet向主机的Servlet运行者提供有关它本身的信息。返回的字符串应该是纯文本格式而不应有任何标志(例如HTML,XML等)。

      三、ServletConfig接口
      定义
      public interface ServletConfig
      这个接口定义了一个对象,通过这个对象,Servlet引擎配置一个Servlet并且允许Servlet获得一个有关它的ServletContext接口的说明。每一个ServletConfig对象对应着一个唯一的Servlet。
      方法
      1、getInitParameter
      public String getInitParameter(String name);
      这个方法返回一个包含Servlet指定的初始化参数的String。如果这个参数不存在,返加空值。
      2、getInitParameterNames
      public Enumeration getInitParameterNames();
      这个方法返回一个列表String对象,该对象包括Servlet的所有初始化参数名。如果Servlet没有初始化参数,getInitParameterNames返回一个空的列表。
      3、getServletContext
      public ServletContext getServletContext();
      返回这个Servlet的ServletContext对象。

      四、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的主版本号。例

[1] [2] [3] [4]  下一页

[数据载入中...] [返回上一页] [打 印]