H2 Database Engine 2.3.232 · org.h2.server.web.WebServlet

Modifier and Type	Field and Description
private static final long	serialVersionUID
private transient WebServer	server

Access	Constructor and Description
public	WebServlet()

Method Summary

Modifier and Type	Method and Description
private boolean	allow(HttpServletRequest req)
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.
public 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) Overrides javax.servlet.http.HttpServlet.doGet. Called by the server (via the `service` method) to allow a servlet to handle a GET request.
public 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) Overrides javax.servlet.http.HttpServlet.doPost. Called by the server (via the `service` method) to allow a servlet to handle a POST request.
private String	getAllowedFile(HttpServletRequest req, String requestedFile)
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)`.

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

serialVersionUID	back to summary
private static final long serialVersionUID

server	back to summary
private transient WebServer server

WebServlet	back to summary
public WebServlet()

Method Detail

allow	back to summary
private boolean allow(HttpServletRequest req)

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`. Annotations @Override

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.

Annotations

@Override

doGet back to summary

doGet	back to summary
public void doGet(HttpServletRequest req, HttpServletResponse resp) throws 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 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 Annotations @Override Exceptions IOException: if an input or output error is detected when the servlet handles the GET request

public void doGet(HttpServletRequest req, HttpServletResponse resp) throws 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

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

Annotations

@Override

Exceptions

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

doPost back to summary

doPost	back to summary
public void doPost(HttpServletRequest req, HttpServletResponse resp) throws 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 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 Annotations @Override Exceptions IOException: if an input or output error is detected when the servlet handles the request

public void doPost(HttpServletRequest req, HttpServletResponse resp) throws 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

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

Annotations

@Override

Exceptions

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

getAllowedFile	back to summary
private String getAllowedFile(HttpServletRequest req, String requestedFile)

init back to summary

init	back to summary
public void init() 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`. Annotations @Override

public void init()

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.

Annotations

@Override

public Class WebServlet

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail