Modifier and Type	Class and Description
pack-priv class	DefaultServlet.NIOResourceCache
private class	DefaultServlet.UnCachedContent

Modifier and Type	Field and Description
private boolean	_acceptRanges
private boolean	_aliases
private ResourceCache	_bioCache
pack-priv ByteArrayBuffer	_cacheControl
private ContextHandler.SContext	_context
private ServletHolder	_defaultHolder
private boolean	_dirAllowed
private boolean	_gzip
private MimeTypes	_mimeTypes
private DefaultServlet.NIOResourceCache	_nioCache
private boolean	_redirectWelcome
private Resource	_resourceBase
private ServletHandler	_servletHandler
private boolean	_useFileMappedBuffer
private String[]	_welcomes
private boolean	_welcomeServlets

Access	Constructor and Description
public	DefaultServlet()

Method Summary

Modifier and Type	Method and Description
public void	destroy() Overrides javax.servlet.GenericServlet.destroy. Implements javax.servlet.Servlet.destroy. Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.
protected void	doGet(HttpServletRequest an `HttpServletRequest` object that contains the request the client has made of the servlet request, HttpServletResponse an `HttpServletResponse` object that contains the response the servlet sends to the client response) Overrides javax.servlet.http.HttpServlet.doGet. Called by the server (via the `service` method) to allow a servlet to handle a GET request.
protected void	doPost(HttpServletRequest an `HttpServletRequest` object that contains the request the client has made of the servlet request, HttpServletResponse an `HttpServletResponse` object that contains the response the servlet sends to the client response) Overrides javax.servlet.http.HttpServlet.doPost. Called by the server (via the `service` method) to allow a servlet to handle a POST request.
protected void	doTrace(HttpServletRequest the `HttpServletRequest` object that contains the request the client made of the servlet req, HttpServletResponse the `HttpServletResponse` object that contains the response the servlet returns to the client resp) Overrides javax.servlet.http.HttpServlet.doTrace. Called by the server (via the `service` method) to allow a servlet to handle a TRACE request.
private boolean	getInitBoolean(String name, boolean dft)
private int	getInitInt(String name, int dft)
public String	getInitParameter(String a `String` specifying the name of the initialization parameter name) Overrides javax.servlet.GenericServlet.getInitParameter. Implements javax.servlet.ServletConfig.getInitParameter. Returns a `String` containing the value of the named initialization parameter, or `null` if the parameter does not exist.
public Resource	Returns: The resource to serve. getResource(String The path to find a resource for. pathInContext) Implements org.mortbay.resource.ResourceFactory.getResource. get Resource to serve.
private String	Returns: The path of the matching welcome file in context getWelcomeFile(String The path in Context in which we are looking for a welcome pathInContext) Finds a matching welcome file for the supplied `Resource`.
public void	init() Overrides javax.servlet.GenericServlet.init. A convenience method which can be overridden so that there's no need to call `super.init(config)`.
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<E> reqRanges)
protected void	sendDirectory(HttpServletRequest request, HttpServletResponse response, Resource resource, boolean parent)
protected void	writeHeaders(HttpServletResponse response, HttpContent content, long count)
protected void	writeOptionHeaders(HttpFields fields)
protected void	writeOptionHeaders(HttpServletResponse response)

Inherited from javax.servlet.http.HttpServlet:: doDelete doHead doOptions doPut getLastModified service service

Field Detail

_acceptRanges	back to summary
private boolean _acceptRanges

_aliases	back to summary
private boolean _aliases

_bioCache	back to summary
private ResourceCache _bioCache

_cacheControl	back to summary
pack-priv ByteArrayBuffer _cacheControl

_context	back to summary
private ContextHandler.SContext _context

_defaultHolder	back to summary
private ServletHolder _defaultHolder

_dirAllowed	back to summary
private boolean _dirAllowed

_gzip	back to summary
private boolean _gzip

_mimeTypes	back to summary
private MimeTypes _mimeTypes

_nioCache	back to summary
private DefaultServlet.NIOResourceCache _nioCache

_redirectWelcome	back to summary
private boolean _redirectWelcome

_resourceBase	back to summary
private Resource _resourceBase

_servletHandler	back to summary
private ServletHandler _servletHandler

_useFileMappedBuffer	back to summary
private boolean _useFileMappedBuffer

_welcomes	back to summary
private String[] _welcomes

_welcomeServlets	back to summary
private boolean _welcomeServlets

Constructor Detail

DefaultServlet	back to summary
public DefaultServlet()

Method Detail

destroy back to summary

destroy	back to summary
public void destroy() Overrides javax.servlet.GenericServlet.destroy. Implements javax.servlet.Servlet.destroy. Doc from javax.servlet.GenericServlet.destroy. Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. See `Servlet#destroy`.

public void destroy()

Overrides javax.servlet.GenericServlet.destroy.

Implements javax.servlet.Servlet.destroy.

Doc from javax.servlet.GenericServlet.destroy.

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

doGet back to summary

doGet	back to summary
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException Overrides javax.servlet.http.HttpServlet.doGet. Doc from javax.servlet.http.HttpServlet.doGet. 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 `javax.servlet.ServletResponse#setContentLength` 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. Parameters request:HttpServletRequest an `HttpServletRequest` object that contains the request the client has made of the servlet response:HttpServletResponse an `HttpServletResponse` object that contains the response the servlet sends to the client Exceptions 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

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

Overrides javax.servlet.http.HttpServlet.doGet.

Doc from javax.servlet.http.HttpServlet.doGet.

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 javax.servlet.ServletResponse#setContentLength 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.

Parameters

request:HttpServletRequest: an HttpServletRequest object that contains the request the client has made of the servlet
response:HttpServletResponse: an HttpServletResponse object that contains the response the servlet sends to the client

Exceptions

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

doPost back to summary

doPost	back to summary
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException Overrides javax.servlet.http.HttpServlet.doPost. Doc from javax.servlet.http.HttpServlet.doPost. 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 `javax.servlet.ServletResponse#setContentLength` 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. Parameters request:HttpServletRequest an `HttpServletRequest` object that contains the request the client has made of the servlet response:HttpServletResponse an `HttpServletResponse` object that contains the response the servlet sends to the client Exceptions 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

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

Overrides javax.servlet.http.HttpServlet.doPost.

Doc from javax.servlet.http.HttpServlet.doPost.

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.

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

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.

Parameters

request:HttpServletRequest: an HttpServletRequest object that contains the request the client has made of the servlet
response:HttpServletResponse: an HttpServletResponse object that contains the response the servlet sends to the client

Exceptions

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

doTrace back to summary

doTrace	back to summary
protected void doTrace(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException Overrides javax.servlet.http.HttpServlet.doTrace. Doc from javax.servlet.http.HttpServlet.doTrace. 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. Parameters req:HttpServletRequest the `HttpServletRequest` object that contains the request the client made of the servlet resp:HttpServletResponse the `HttpServletResponse` object that contains the response the servlet returns to the client Exceptions 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

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

Overrides javax.servlet.http.HttpServlet.doTrace.

Doc from javax.servlet.http.HttpServlet.doTrace.

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.

Parameters

req:HttpServletRequest: the HttpServletRequest object that contains the request the client made of the servlet
resp:HttpServletResponse: the HttpServletResponse object that contains the response the servlet returns to the client

Exceptions

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

getInitBoolean	back to summary
private boolean getInitBoolean(String name, boolean dft)

getInitInt	back to summary
private int getInitInt(String name, int dft)

getInitParameter back to summary

getInitParameter	back to summary
public String getInitParameter(String name) Overrides javax.servlet.GenericServlet.getInitParameter. Implements javax.servlet.ServletConfig.getInitParameter. Doc from javax.servlet.GenericServlet.getInitParameter. Returns a `String` containing the value of the named initialization parameter, or `null` if the parameter does not exist. See `ServletConfig#getInitParameter`. This method is supplied for convenience. It gets the value of the named parameter from the servlet's `ServletConfig` object. Parameters name:String a `String` specifying the name of the initialization parameter Returns:String String a `String` containing the value of the initialization parameter

public String getInitParameter(String name)

Overrides javax.servlet.GenericServlet.getInitParameter.

Implements javax.servlet.ServletConfig.getInitParameter.

Doc from javax.servlet.GenericServlet.getInitParameter.

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

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

Parameters

name:String: a String specifying the name of the initialization parameter

Returns:String

String a String containing the value of the initialization parameter

getResource	back to summary
public Resource getResource(String pathInContext) Implements org.mortbay.resource.ResourceFactory.getResource. get Resource to serve. Map a path to a resource. The default implementation calls HttpContext.getResource but derived servlets may provide their own mapping. Parameters pathInContext:String The path to find a resource for. Returns:Resource The resource to serve.

getResource

back to summary

public Resource getResource(String pathInContext)

Implements org.mortbay.resource.ResourceFactory.getResource.

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

Parameters

pathInContext:String: The path to find a resource for.

Returns:Resource

The resource to serve.

getWelcomeFile back to summary

getWelcomeFile	back to summary
private String getWelcomeFile(String pathInContext) throws MalformedURLException, IOException Finds a matching welcome file for the supplied `Resource`. This will be the first entry in the list of configured `welcome files` that existing within the directory referenced by the `Resource`. If the resource is not a directory, or no matching file is found, then it may look for a valid servlet mapping. If there is none, then `null` is returned. The list of welcome files is read from the `ContextHandler` for this servlet, or `"index.jsp" , "index.html"` if that is `null`. Parameters pathInContext:String The path in Context in which we are looking for a welcome Returns:String The path of the matching welcome file in context

private String getWelcomeFile(String pathInContext) throws MalformedURLException, IOException

Finds a matching welcome file for the supplied Resource. This will be the first entry in the list of configured welcome files that existing within the directory referenced by the Resource. If the resource is not a directory, or no matching file is found, then it may look for a valid servlet mapping. If there is none, then null is returned. The list of welcome files is read from the ContextHandler for this servlet, or "index.jsp" , "index.html" if that is null.

Parameters

pathInContext:String: The path in Context in which we are looking for a welcome

Returns:String

The path of the matching welcome file in context

init back to summary

init	back to summary
public void init() throws UnavailableException Overrides javax.servlet.GenericServlet.init. Doc from javax.servlet.GenericServlet.init. A convenience method which can be overridden so that there's no need to call `super.init(config)`. Instead of overriding `init(ServletConfig)`, simply override this method and it will be called by `GenericServlet.init(ServletConfig config)`. The `ServletConfig` object can still be retrieved via `getServletConfig`.

public void init() throws UnavailableException

Overrides javax.servlet.GenericServlet.init.

Doc from javax.servlet.GenericServlet.init.

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

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

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

sendData	back to summary
protected void sendData(HttpServletRequest request, HttpServletResponse response, boolean include, Resource resource, HttpContent content, Enumeration<E> reqRanges) throws IOException

sendDirectory	back to summary
protected void sendDirectory(HttpServletRequest request, HttpServletResponse response, Resource resource, boolean parent) throws IOException

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

writeOptionHeaders	back to summary
protected void writeOptionHeaders(HttpFields fields) throws IOException

writeOptionHeaders	back to summary
protected void writeOptionHeaders(HttpServletResponse response) throws IOException

Access	Constructor and Description
public	NIOResourceCache(MimeTypes mimeTypes)

Modifier and Type	Method and Description
protected void	fill(ResourceCache.Content content) Overrides org.mortbay.jetty.ResourceCache.fill.

NIOResourceCache	back to summary
public NIOResourceCache(MimeTypes mimeTypes)

fill	back to summary
protected void fill(ResourceCache.Content content) throws IOException Overrides org.mortbay.jetty.ResourceCache.fill.

org.mortbay.jetty.servlet back to summary

private Class DefaultServlet.UnCachedContent

Class Inheritance

extends Object
implements HttpContent

java.lang.Object
org.mortbay.jetty.servlet.DefaultServlet.UnCachedContent

All Implemented Interfaces

org.mortbay.jetty.HttpContent

Field Summary

Modifier and Type	Field and Description
pack-priv Resource	_resource

Constructor Summary

Access	Constructor and Description
pack-priv	UnCachedContent(Resource resource)

Method Summary

Modifier and Type	Method and Description
public Buffer	getBuffer() Implements org.mortbay.jetty.HttpContent.getBuffer.
public long	getContentLength() Implements org.mortbay.jetty.HttpContent.getContentLength.
public Buffer	getContentType() Implements org.mortbay.jetty.HttpContent.getContentType.
public InputStream	getInputStream() Implements org.mortbay.jetty.HttpContent.getInputStream.
public Buffer	getLastModified() Implements org.mortbay.jetty.HttpContent.getLastModified.
public Resource	getResource() Implements org.mortbay.jetty.HttpContent.getResource.
public void	release() Implements org.mortbay.jetty.HttpContent.release.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_resource	back to summary
pack-priv Resource _resource

Constructor Detail

UnCachedContent	back to summary
pack-priv UnCachedContent(Resource resource)

Method Detail

getBuffer	back to summary
public Buffer getBuffer() Implements org.mortbay.jetty.HttpContent.getBuffer.

getContentLength	back to summary
public long getContentLength() Implements org.mortbay.jetty.HttpContent.getContentLength.

getContentType	back to summary
public Buffer getContentType() Implements org.mortbay.jetty.HttpContent.getContentType.

getInputStream	back to summary
public InputStream getInputStream() throws IOException Implements org.mortbay.jetty.HttpContent.getInputStream.

getLastModified	back to summary
public Buffer getLastModified() Implements org.mortbay.jetty.HttpContent.getLastModified.

getResource	back to summary
public Resource getResource() Implements org.mortbay.jetty.HttpContent.getResource.

release	back to summary
public void release() Implements org.mortbay.jetty.HttpContent.release.

public Class DefaultServlet

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class DefaultServlet.NIOResourceCache

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class DefaultServlet.UnCachedContent

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail