Top Description Fields Constructors Methods
jakarta.servlet.http

public abstract Class HttpServlet

Additional top-level classes in compilation unit: NoBodyResponse, NoBodyOutputStream.

extends GenericServlet
Class Inheritance
Imports
jakarta.servlet.GenericServlet, .ServletConfig, .ServletException, .ServletOutputStream, .ServletRequest, .ServletResponse, .WriteListener, java.io.IOException, .OutputStreamWriter, .PrintWriter, .UnsupportedEncodingException, java.lang.reflect.Method, java.text.MessageFormat, java.util.Enumeration, .ResourceBundle
Provides an abstract class to be subclassed to create an HTTP servlet suitable for a Web site. A subclass of HttpServlet must override at least one method, usually one of these:

There's almost no reason to override the service method. service handles standard HTTP requests by dispatching them to the handler methods for each HTTP request type (the doXXX methods listed above).

Likewise, there's almost no reason to override the doOptions and doTrace methods.

Servlets typically run on multithreaded servers, so be aware that a servlet must handle concurrent requests and be careful to synchronize access to shared resources. Shared resources include in-memory data such as instance or class variables and external objects such as files, database connections, and network connections. See the Java Tutorial on Multithreaded Programming for more information on handling multiple threads in a Java program.

Author
Various

Field Summary

Modifier and TypeField and Description
private static final String
HEADER_IFMODSINCE

private static final String
HEADER_LASTMOD

public static final String
LEGACY_DO_HEAD

The parameter obtained ServletConfig#getInitParameter(String) to determine if legacy processing of doHead(HttpServletRequest, HttpServletResponse) is provided.

private boolean
legacyHeadHandling

private static final String
LSTRING_FILE

Hides jakarta.servlet.GenericServlet.LSTRING_FILE.

private static ResourceBundle
lStrings

Hides jakarta.servlet.GenericServlet.lStrings.

private static final String
METHOD_DELETE

private static final String
METHOD_GET

private static final String
METHOD_HEAD

private static final String
METHOD_OPTIONS

private static final String
METHOD_POST

private static final String
METHOD_PUT

private static final String
METHOD_TRACE

private static final long
serialVersionUID

Hides jakarta.servlet.GenericServlet.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
HttpServlet()

Does nothing, because this is an abstract class.

Method Summary

Modifier and TypeMethod and Description
protected void
doDelete(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)

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

protected void
doGet(HttpServletRequest
an HttpServletRequest object that contains the request the client has made of the servlet
req, HttpServletResponse
an HttpServletResponse object that contains the response the servlet sends to the client
resp)

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

protected void
doHead(HttpServletRequest
the request object that is passed to the servlet
req, HttpServletResponse
the response object that the servlet uses to return the headers to the clien
resp)

Receives an HTTP HEAD request from the protected service method and handles the request.

protected void
doOptions(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)

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

protected void
doPost(HttpServletRequest
an HttpServletRequest object that contains the request the client has made of the servlet
req, HttpServletResponse
an HttpServletResponse object that contains the response the servlet sends to the client
resp)

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

protected void
doPut(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)

Called by the server (via the service method) to allow a servlet to handle a PUT 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)

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

private Method[]
getAllDeclaredMethods(Class<? extends HttpServlet> c)

protected long

Returns:

a long integer specifying the time the HttpServletRequest object was last modified, in milliseconds since midnight, January 1, 1970 GMT, or -1 if the time is not known
getLastModified(HttpServletRequest
the HttpServletRequest object that is sent to the servlet
req)

Returns the time the HttpServletRequest object was last modified, in milliseconds since midnight January 1, 1970 GMT.

private int
getMethodNotSupportedCode(String protocol)

public void
init(ServletConfig
the ServletConfig object that contains configuration information for this servlet
config)

Overrides jakarta.servlet.GenericServlet.init.

Implements jakarta.servlet.Servlet.init.

Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
private void
maybeSetLastModified(HttpServletResponse resp, long lastModified)

protected void
service(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)

Receives standard HTTP requests from the public service method and dispatches them to the doXXX methods defined in this class.

public void
service(ServletRequest
the HttpServletRequest object that contains the request the client made of the servlet
req, ServletResponse
the HttpServletResponse object that contains the response the servlet returns to the client
res)

Implements abstract jakarta.servlet.GenericServlet.service.

Implements jakarta.servlet.Servlet.service.

Dispatches client requests to the protected service method.
Inherited from jakarta.servlet.GenericServlet:
destroygetInitParametergetInitParameterNamesgetServletConfiggetServletContextgetServletInfogetServletNameinitloglog

Field Detail

HEADER_IFMODSINCEback to summary
private static final String HEADER_IFMODSINCE
HEADER_LASTMODback to summary
private static final String HEADER_LASTMOD
LEGACY_DO_HEADback to summary
public static final String LEGACY_DO_HEAD

Deprecated

for removal since Servlet 6.0.

may be removed in future releases

The parameter obtained ServletConfig#getInitParameter(String) to determine if legacy processing of doHead(HttpServletRequest, HttpServletResponse) is provided.

Annotations
@Deprecated
forRemoval:true
since:Servlet 6.0
Since
Servlet 6.0
legacyHeadHandlingback to summary
private boolean legacyHeadHandling
LSTRING_FILEback to summary
private static final String LSTRING_FILE

Hides jakarta.servlet.GenericServlet.LSTRING_FILE.

lStringsback to summary
private static ResourceBundle lStrings

Hides jakarta.servlet.GenericServlet.lStrings.

METHOD_DELETEback to summary
private static final String METHOD_DELETE
METHOD_GETback to summary
private static final String METHOD_GET
METHOD_HEADback to summary
private static final String METHOD_HEAD
METHOD_OPTIONSback to summary
private static final String METHOD_OPTIONS
METHOD_POSTback to summary
private static final String METHOD_POST
METHOD_PUTback to summary
private static final String METHOD_PUT
METHOD_TRACEback to summary
private static final String METHOD_TRACE
serialVersionUIDback to summary
private static final long serialVersionUID

Hides jakarta.servlet.GenericServlet.serialVersionUID.

Constructor Detail

HttpServletback to summary
public HttpServlet()

Does nothing, because this is an abstract class.

Method Detail

doDeleteback to summary
protected void doDelete(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException

Called by the server (via the service method) to allow a servlet to handle a DELETE request. The DELETE operation allows a client to remove a document or Web page from the server.

This method does not need to be either safe or idempotent. Operations requested through DELETE can have side effects for which users can be held accountable. When using this method, it may be useful to save a copy of the affected URL in temporary storage.

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

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 DELETE cannot be handled
IOException:
if an input or output error occurs while the servlet is handling the DELETE request
doGetback to summary
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException

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 jakarta.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
req:HttpServletRequest

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

resp: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
See Also
jakarta.servlet.ServletResponse#setContentType
doHeadback to summary
protected void doHead(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException

Receives an HTTP HEAD request from the protected service method and handles the request. The client sends a HEAD request when it wants to see only the headers of a response, such as Content-Type or Content-Length. The HTTP HEAD method counts the output bytes in the response to set the Content-Length header accurately.

If you override this method, you can avoid computing the response body and just set the response headers directly to improve performance. Make sure that the doHead method you write is both safe and idempotent (that is, protects itself from being called multiple times for one HTTP HEAD request).

The default implementation calls doGet(HttpServletRequest, HttpServletResponse). If the ServletConfig init parameter LEGACY_DO_HEAD is set to "TRUE", then the response instance is wrapped so that the response body is discarded.

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

Parameters
req:HttpServletRequest

the request object that is passed to the servlet

resp:HttpServletResponse

the response object that the servlet uses to return the headers to the clien

Exceptions
ServletException:
if the request for the HEAD could not be handled
IOException:
if an input or output error occurs
doOptionsback to summary
protected void doOptions(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException

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.

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 OPTIONS cannot be handled
IOException:
if an input or output error occurs while the servlet is handling the OPTIONS request
doPostback to summary
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException

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 jakarta.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
req:HttpServletRequest

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

resp: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
See Also
jakarta.servlet.ServletOutputStream, jakarta.servlet.ServletResponse#setContentType
doPutback to summary
protected void doPut(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException

Called by the server (via the service method) to allow a servlet to handle a PUT request. The PUT operation allows a client to place a file on the server and is similar to sending a file by FTP.

When overriding this method, leave intact any content headers sent with the request (including Content-Length, Content-Type, Content-Transfer-Encoding, Content-Encoding, Content-Base, Content-Language, Content-Location, Content-MD5, and Content-Range). If your method cannot handle a content header, it must issue an error message (HTTP 501 - Not Implemented) and discard the request. For more information on HTTP 1.1 and the PUT method, see RFC 7231 .

This method does not need to be either safe or idempotent. Operations that doPut performs can have side effects for which the user can be held accountable. When using this method, it may be useful to save a copy of the affected URL in temporary storage.

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

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 PUT cannot be handled
IOException:
if an input or output error occurs while the servlet is handling the PUT request
doTraceback to summary
protected void doTrace(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException

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
getAllDeclaredMethodsback to summary
private Method[] getAllDeclaredMethods(Class<? extends HttpServlet> c)
getLastModifiedback to summary
protected long getLastModified(HttpServletRequest req)

Returns the time the HttpServletRequest object was last modified, in milliseconds since midnight January 1, 1970 GMT. If the time is unknown, this method returns a negative number (the default).

Servlets that support HTTP GET requests and can quickly determine their last modification time should override this method. This makes browser and proxy caches work more effectively, reducing the load on server and network resources.

Parameters
req:HttpServletRequest

the HttpServletRequest object that is sent to the servlet

Returns:long

a long integer specifying the time the HttpServletRequest object was last modified, in milliseconds since midnight, January 1, 1970 GMT, or -1 if the time is not known

getMethodNotSupportedCodeback to summary
private int getMethodNotSupportedCode(String protocol)
initback to summary
public void init(ServletConfig config) throws ServletException

Overrides jakarta.servlet.GenericServlet.init.

Implements jakarta.servlet.Servlet.init.

Doc from jakarta.servlet.GenericServlet.init.

Called by the servlet container to indicate to a servlet that the servlet is being placed into service. See Servlet#init.

This implementation stores the ServletConfig object it receives from the servlet container for later use. When overriding this form of the method, call super.init(config).

Parameters
config:ServletConfig

the ServletConfig object that contains configuration information for this servlet

Annotations
@Override
Exceptions
ServletException:
if an exception occurs that interrupts the servlet's normal operation
maybeSetLastModifiedback to summary
private void maybeSetLastModified(HttpServletResponse resp, long lastModified)
serviceback to summary
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException

Receives standard HTTP requests from the public service method and dispatches them to the doXXX methods defined in this class. This method is an HTTP-specific version of the jakarta.servlet.Servlet#service method. 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 HTTP request cannot be handled
IOException:
if an input or output error occurs while the servlet is handling the HTTP request
See Also
jakarta.servlet.Servlet#service
serviceback to summary
public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException

Implements abstract jakarta.servlet.GenericServlet.service.

Implements jakarta.servlet.Servlet.service.

Dispatches client requests to the protected service method. There's no need to override this method.

Parameters
req:ServletRequest

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

res:ServletResponse

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

Annotations
@Override
Exceptions
ServletException:
if the HTTP request cannot be handled or if either parameter is not an instance of its respective HttpServletRequest or HttpServletResponse counterparts.
IOException:
if an input or output error occurs while the servlet is handling the HTTP request
See Also
jakarta.servlet.Servlet#service