org.apache.tomcat.websocket.server

Class UpgradeUtil

java.lang.Object

org.apache.tomcat.websocket.server.UpgradeUtil

public class UpgradeUtil
extends Object

Method Summary

Modifier and Type	Method and Description
static void	doUpgrade(WsServerContainer sc, HttpServletRequest req, HttpServletResponse resp, ServerEndpointConfig sec, Map<String,String> pathParams)
static boolean	isWebSocketUpgradeRequest(ServletRequest request, ServletResponse response) Checks to see if this is an HTTP request that includes a valid upgrade request to web socket.

Methods inherited from class java.lang.Object

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

Method Detail

isWebSocketUpgradeRequest

public static boolean isWebSocketUpgradeRequest(ServletRequest request,
                                                ServletResponse response)

Checks to see if this is an HTTP request that includes a valid upgrade request to web socket.

Note: RFC 2616 does not limit HTTP upgrade to GET requests but the Java WebSocket spec 1.0, section 8.2 implies such a limitation and RFC 6455 section 4.1 requires that a WebSocket Upgrade uses GET.

Parameters:

request - The request to check if it is an HTTP upgrade request for a WebSocket connection

response - The response associated with the request

Returns:

true if the request includes a HTTP Upgrade request for the WebSocket protocol, otherwise false

doUpgrade

public static void doUpgrade(WsServerContainer sc,
                             HttpServletRequest req,
                             HttpServletResponse resp,
                             ServerEndpointConfig sec,
                             Map<String,String> pathParams)
                      throws ServletException,
                             IOException

Throws:

ServletException

IOException