Undertow 2.3.12.Final · io.undertow.servlet.websockets.WebSocketServlet

Modifier and Type	Field and Description
private WebSocketConnectionCallback	callback
private final List<Handshake>	handshakes
private Set<WebSocketChannel>	peerConnections
public static final String	SESSION_HANDLER

Access	Constructor and Description
public	WebSocketServlet()
public	WebSocketServlet(WebSocketConnectionCallback callback)

Method Summary

Modifier and Type	Method and Description
protected void	doGet(final HttpServletRequest an `HttpServletRequest` object that contains the request the client has made of the servlet req, final HttpServletResponse an `HttpServletResponse` object that contains the response the servlet sends to the client resp) Overrides jakarta.servlet.http.HttpServlet.doGet. Called by the server (via the `service` method) to allow a servlet to handle a GET request.
protected List<Handshake>	handshakes()
public void	init(final ServletConfig the `ServletConfig` object that contains configuration information for this servlet config) Overrides jakarta.servlet.http.HttpServlet.init. Implements jakarta.servlet.Servlet.init. Called by the servlet container to indicate to a servlet that the servlet is being placed into service.

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

callback	back to summary
private WebSocketConnectionCallback callback

handshakes	back to summary
private final List<Handshake> handshakes

peerConnections	back to summary
private Set<WebSocketChannel> peerConnections

SESSION_HANDLER	back to summary
public static final String SESSION_HANDLER

WebSocketServlet	back to summary
public WebSocketServlet()

WebSocketServlet	back to summary
public WebSocketServlet(WebSocketConnectionCallback callback)

Method Detail

doGet back to summary

doGet	back to summary
protected void doGet(final HttpServletRequest req, final HttpServletResponse resp) throws ServletException, IOException Overrides jakarta.servlet.http.HttpServlet.doGet. Doc from jakarta.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 `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 Annotations @Override 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(final HttpServletRequest req, final HttpServletResponse resp) throws ServletException, IOException

Overrides jakarta.servlet.http.HttpServlet.doGet.

Doc from jakarta.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 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

Annotations

@Override

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

handshakes	back to summary
protected List<Handshake> handshakes()

init back to summary

init	back to summary
public void init(final ServletConfig config) throws ServletException Overrides jakarta.servlet.http.HttpServlet.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

public void init(final ServletConfig config) throws ServletException

Overrides jakarta.servlet.http.HttpServlet.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

public Class WebSocketServlet

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail