Class WsHttpUpgradeHandler
- java.lang.Object
-
- org.apache.tomcat.websocket.server.WsHttpUpgradeHandler
-
- All Implemented Interfaces:
HttpUpgradeHandler
,InternalHttpUpgradeHandler
public class WsHttpUpgradeHandler extends java.lang.Object implements InternalHttpUpgradeHandler
Servlet 3.1 HTTP upgrade handler for WebSocket connections.
-
-
Constructor Summary
Constructors Constructor Description WsHttpUpgradeHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
destroy()
This method is called after the upgraded connection has been closed.UpgradeInfo
getUpgradeInfo()
void
init(WebConnection connection)
This method is called once the request/response pair whereHttpServletRequest.upgrade(Class)
is called has completed processing and is the point where control of the connection passes from the container to theHttpUpgradeHandler
.void
pause()
void
preInit(ServerEndpointConfig serverEndpointConfig, WsServerContainer wsc, WsHandshakeRequest handshakeRequest, java.util.List<Extension> negotiatedExtensionsPhase2, java.lang.String subProtocol, Transformation transformation, java.util.Map<java.lang.String,java.lang.String> pathParameters, boolean secure)
void
setSocketWrapper(SocketWrapperBase<?> socketWrapper)
void
setSslSupport(SSLSupport sslSupport)
void
timeoutAsync(long now)
AbstractEndpoint.Handler.SocketState
upgradeDispatch(SocketEvent status)
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler
hasAsyncIO
-
-
-
-
Method Detail
-
setSocketWrapper
public void setSocketWrapper(SocketWrapperBase<?> socketWrapper)
- Specified by:
setSocketWrapper
in interfaceInternalHttpUpgradeHandler
-
preInit
public void preInit(ServerEndpointConfig serverEndpointConfig, WsServerContainer wsc, WsHandshakeRequest handshakeRequest, java.util.List<Extension> negotiatedExtensionsPhase2, java.lang.String subProtocol, Transformation transformation, java.util.Map<java.lang.String,java.lang.String> pathParameters, boolean secure)
-
init
public void init(WebConnection connection)
Description copied from interface:jakarta.servlet.http.HttpUpgradeHandler
This method is called once the request/response pair whereHttpServletRequest.upgrade(Class)
is called has completed processing and is the point where control of the connection passes from the container to theHttpUpgradeHandler
.- Specified by:
init
in interfaceHttpUpgradeHandler
- Parameters:
connection
- The connection that has been upgraded
-
getUpgradeInfo
public UpgradeInfo getUpgradeInfo()
- Specified by:
getUpgradeInfo
in interfaceInternalHttpUpgradeHandler
-
upgradeDispatch
public AbstractEndpoint.Handler.SocketState upgradeDispatch(SocketEvent status)
- Specified by:
upgradeDispatch
in interfaceInternalHttpUpgradeHandler
-
timeoutAsync
public void timeoutAsync(long now)
- Specified by:
timeoutAsync
in interfaceInternalHttpUpgradeHandler
-
pause
public void pause()
- Specified by:
pause
in interfaceInternalHttpUpgradeHandler
-
destroy
public void destroy()
Description copied from interface:jakarta.servlet.http.HttpUpgradeHandler
This method is called after the upgraded connection has been closed.- Specified by:
destroy
in interfaceHttpUpgradeHandler
-
setSslSupport
public void setSslSupport(SSLSupport sslSupport)
- Specified by:
setSslSupport
in interfaceInternalHttpUpgradeHandler
-
-