org.eclipse.jetty.servlet
类 DefaultServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.eclipse.jetty.servlet.DefaultServlet

所有已实现的接口：

Serializable, Servlet, ServletConfig, ResourceFactory

public class DefaultServlet
extends HttpServlet
implements ResourceFactory

The default servlet. This servlet, normally mapped to /, provides the handling for static content, OPTION and TRACE methods for the context. The following initParameters are supported, these can be set either on the servlet itself or as ServletContext initParameters with a prefix of org.eclipse.jetty.servlet.Default. :

  acceptRanges      If true, range requests and responses are
                    supported

  dirAllowed        If true, directory listings are returned if no
                    welcome file is found. Else 403 Forbidden.

  welcomeServlets   If true, attempt to dispatch to welcome files
                    that are servlets, but only after no matching static
                    resources could be found. If false, then a welcome
                    file must exist on disk. If "exact", then exact
                    servlet matches are supported without an existing file.
                    Default is true.

                    This must be false if you want directory listings,
                    but have index.jsp in your welcome file list.

  redirectWelcome   If true, welcome files are redirected rather than
                    forwarded to.

  gzip              If set to true, then static content will be served as
                    gzip content encoded if a matching resource is
                    found ending with ".gz"

  resourceBase      Set to replace the context resource base

  resourceCache     If set, this is a context attribute name, which the servlet 
                    will use to look for a shared ResourceCache instance. 
                        
  relativeResourceBase
                    Set with a pathname relative to the base of the
                    servlet context root. Useful for only serving static content out
                    of only specific subdirectories.

  pathInfoOnly      If true, only the path info will be applied to the resourceBase 
                        
  stylesheet          Set with the location of an optional stylesheet that will be used
                    to decorate the directory listing html.

  aliases           If True, aliases of resources are allowed (eg. symbolic
                    links and caps variations). May bypass security constraints.
                    
  etags             If True, weak etags will be handled.

  maxCacheSize      The maximum total size of the cache or 0 for no cache.
  maxCachedFileSize The maximum size of a file to cache
  maxCachedFiles    The maximum number of files to cache

  useFileMappedBuffer
                    If set to true, it will use mapped file buffer to serve static content
                    when using NIO connector. Setting this value to false means that
                    a direct buffer will be used instead of a mapped file buffer.
                    By default, this is set to true.

  cacheControl      If set, all static content will have this value set as the cache-control
                    header.


 

另请参见：

序列化表格

构造方法摘要

DefaultServlet()

方法摘要

void	destroy() Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.
protected void	doGet(HttpServletRequest request, HttpServletResponse response) Called by the server (via the service method) to allow a servlet to handle a GET request.
protected void	doOptions(HttpServletRequest req, HttpServletResponse resp) Called by the server (via the service method) to allow a servlet to handle a OPTIONS request.
protected void	doPost(HttpServletRequest request, HttpServletResponse response) Called by the server (via the service method) to allow a servlet to handle a POST request.
protected void	doTrace(HttpServletRequest req, HttpServletResponse resp) Called by the server (via the service method) to allow a servlet to handle a TRACE request.
String	getInitParameter(String name) Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
Resource	getResource(String pathInContext) get Resource to serve.
void	init() A convenience method which can be overridden so that there's no need to call super.init(config).
protected ContextHandler	initContextHandler(ServletContext servletContext) Compute the field _contextHandler.
protected boolean	passConditionalHeaders(HttpServletRequest request, HttpServletResponse response, Resource resource, HttpContent content)
protected void	sendData(HttpServletRequest request, HttpServletResponse response, boolean include, Resource resource, HttpContent content, Enumeration reqRanges)
protected void	sendDirectory(HttpServletRequest request, HttpServletResponse response, Resource resource, String pathInContext)
protected void	writeHeaders(HttpServletResponse response, HttpContent content, long count)
protected void	writeOptionHeaders(HttpFields fields)
protected void	writeOptionHeaders(HttpServletResponse response)

从类 javax.servlet.http.HttpServlet 继承的方法

doDelete, doHead, doPut, getLastModified, service, service

从类 javax.servlet.GenericServlet 继承的方法

getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造方法详细信息

DefaultServlet

public DefaultServlet()

方法详细信息

init

public void init()
          throws UnavailableException

从类 GenericServlet 复制的描述

A convenience method which can be overridden so that there's no need to call super.init(config).

Instead of overriding GenericServlet.init(ServletConfig), simply override this method and it will be called by GenericServlet.init(ServletConfig config). The ServletConfig object can still be retrieved via GenericServlet.getServletConfig().

覆盖：

类 GenericServlet 中的 init

抛出：

UnavailableException

initContextHandler

protected ContextHandler initContextHandler(ServletContext servletContext)

Compute the field _contextHandler.
In the case where the DefaultServlet is deployed on the HttpService it is likely that this method needs to be overwritten to unwrap the ServletContext facade until we reach the original jetty's ContextHandler.

参数：

servletContext - The servletContext of this servlet.

返回：

the jetty's ContextHandler for this servletContext.

getInitParameter

public String getInitParameter(String name)

从类 GenericServlet 复制的描述

Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist. See ServletConfig.getInitParameter(java.lang.String).

This method is supplied for convenience. It gets the value of the named parameter from the servlet's ServletConfig object.

指定者：

接口 ServletConfig 中的 getInitParameter

覆盖：

类 GenericServlet 中的 getInitParameter

参数：

name - a String specifying the name of the initialization parameter

返回：

String a String containing the value of the initialization parameter

getResource

public Resource getResource(String pathInContext)

get Resource to serve. Map a path to a resource. The default implementation calls HttpContext.getResource but derived servlets may provide their own mapping.

指定者：

接口 ResourceFactory 中的 getResource

参数：

pathInContext - The path to find a resource for.

返回：

The resource to serve.

doGet

protected void doGet(HttpServletRequest request,
                     HttpServletResponse response)
              throws ServletException,
                     IOException

从类 HttpServlet 复制的描述

Called by the server (via the service method) to allow a servlet to handle a GET request.

Overriding this method to support a GET request also automatically supports an HTTP HEAD request. A HEAD request is a GET request that returns no body in the response, only the request header fields.

When overriding this method, read the request data, write the response headers, get the response's writer or output stream object, and finally, write the response data. It's best to include content type and encoding. When using a PrintWriter object to return the response, set the content type before accessing the PrintWriter object.

The servlet container must write the headers before committing the response, because in HTTP the headers must be sent before the response body.

Where possible, set the Content-Length header (with the ServletResponse.setContentLength(int) method), to allow the servlet container to use a persistent connection to return its response to the client, improving performance. The content length is automatically set if the entire response fits inside the response buffer.

When using HTTP 1.1 chunked encoding (which means that the response has a Transfer-Encoding header), do not set the Content-Length header.

The GET method should be safe, that is, without any side effects for which users are held responsible. For example, most form queries have no side effects. If a client request is intended to change stored data, the request should use some other HTTP method.

The GET method should also be idempotent, meaning that it can be safely repeated. Sometimes making a method safe also makes it idempotent. For example, repeating queries is both safe and idempotent, but buying a product online or modifying data is neither safe nor idempotent.

If the request is incorrectly formatted, doGet returns an HTTP "Bad Request" message.

覆盖：

类 HttpServlet 中的 doGet

参数：

request - an HttpServletRequest object that contains the request the client has made of the servlet

response - an HttpServletResponse object that contains the response the servlet sends to the client

抛出：

ServletException - if the request for the GET could not be handled

IOException - if an input or output error is detected when the servlet handles the GET request

另请参见：

ServletResponse.setContentType(java.lang.String)

doPost

protected void doPost(HttpServletRequest request,
                      HttpServletResponse response)
               throws ServletException,
                      IOException

从类 HttpServlet 复制的描述

Called by the server (via the service method) to allow a servlet to handle a POST request. The HTTP POST method allows the client to send data of unlimited length to the Web server a single time and is useful when posting information such as credit card numbers.

When overriding this method, read the request data, write the response headers, get the response's writer or output stream object, and finally, write the response data. It's best to include content type and encoding. When using a PrintWriter object to return the response, set the content type before accessing the PrintWriter object.

The servlet container must write the headers before committing the response, because in HTTP the headers must be sent before the response body.

Where possible, set the Content-Length header (with the ServletResponse.setContentLength(int) method), to allow the servlet container to use a persistent connection to return its response to the client, improving performance. The content length is automatically set if the entire response fits inside the response buffer.

When using HTTP 1.1 chunked encoding (which means that the response has a Transfer-Encoding header), do not set the Content-Length header.

This method does not need to be either safe or idempotent. Operations requested through POST can have side effects for which the user can be held accountable, for example, updating stored data or buying items online.

If the HTTP POST request is incorrectly formatted, doPost returns an HTTP "Bad Request" message.

覆盖：

类 HttpServlet 中的 doPost

参数：

request - an HttpServletRequest object that contains the request the client has made of the servlet

response - an HttpServletResponse object that contains the response the servlet sends to the client

抛出：

ServletException - if the request for the POST could not be handled

IOException - if an input or output error is detected when the servlet handles the request

另请参见：

ServletOutputStream, ServletResponse.setContentType(java.lang.String)

doTrace

protected void doTrace(HttpServletRequest req,
                       HttpServletResponse resp)
                throws ServletException,
                       IOException

从类 HttpServlet 复制的描述

Called by the server (via the service method) to allow a servlet to handle a TRACE request. A TRACE returns the headers sent with the TRACE request to the client, so that they can be used in debugging. There's no need to override this method.

覆盖：

类 HttpServlet 中的 doTrace

参数：

req - the HttpServletRequest object that contains the request the client made of the servlet

resp - the HttpServletResponse object that contains the response the servlet returns to the client

抛出：

ServletException - if the request for the TRACE cannot be handled

IOException - if an input or output error occurs while the servlet is handling the TRACE request

doOptions

protected void doOptions(HttpServletRequest req,
                         HttpServletResponse resp)
                  throws ServletException,
                         IOException

从类 HttpServlet 复制的描述

Called by the server (via the service method) to allow a servlet to handle a OPTIONS request. The OPTIONS request determines which HTTP methods the server supports and returns an appropriate header. For example, if a servlet overrides doGet, this method returns the following header:

Allow: GET, HEAD, TRACE, OPTIONS

There's no need to override this method unless the servlet implements new HTTP methods, beyond those implemented by HTTP 1.1.

覆盖：

类 HttpServlet 中的 doOptions

参数：

req - the HttpServletRequest object that contains the request the client made of the servlet

resp - the HttpServletResponse object that contains the response the servlet returns to the client

抛出：

ServletException - if the request for the OPTIONS cannot be handled

IOException - if an input or output error occurs while the servlet is handling the OPTIONS request

passConditionalHeaders

protected boolean passConditionalHeaders(HttpServletRequest request,
                                         HttpServletResponse response,
                                         Resource resource,
                                         HttpContent content)
                                  throws IOException

抛出：

IOException

sendDirectory

protected void sendDirectory(HttpServletRequest request,
                             HttpServletResponse response,
                             Resource resource,
                             String pathInContext)
                      throws IOException

抛出：

IOException

sendData

protected void sendData(HttpServletRequest request,
                        HttpServletResponse response,
                        boolean include,
                        Resource resource,
                        HttpContent content,
                        Enumeration reqRanges)
                 throws IOException

抛出：

IOException

writeHeaders

protected void writeHeaders(HttpServletResponse response,
                            HttpContent content,
                            long count)
                     throws IOException

抛出：

IOException

writeOptionHeaders

protected void writeOptionHeaders(HttpFields fields)
                           throws IOException

抛出：

IOException

writeOptionHeaders

protected void writeOptionHeaders(HttpServletResponse response)
                           throws IOException

抛出：

IOException

destroy

public void destroy()

从类 GenericServlet 复制的描述

Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. See Servlet.destroy().

指定者：

接口 Servlet 中的 destroy

覆盖：

类 GenericServlet 中的 destroy