Top Description Fields Constructors Methods
org.apache.tomcat.websocket.server

public Class WsHttpUpgradeHandler

extends Object
implements InternalHttpUpgradeHandler
Class Inheritance
All Implemented Interfaces
org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler, jakarta.servlet.http.HttpUpgradeHandler
Imports
java.io.EOFException, .IOException, java.util.List, .Map, jakarta.servlet.http.HttpSession, .WebConnection, jakarta.websocket.CloseReason, .CloseReason.CloseCodes, .DeploymentException, .Endpoint, .Extension, jakarta.websocket.server.ServerEndpointConfig, org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler, .UpgradeInfo, org.apache.juli.logging.Log, .LogFactory, org.apache.tomcat.util.net.AbstractEndpoint.Handler.SocketState, .SSLSupport, .SocketEvent, .SocketWrapperBase, org.apache.tomcat.util.res.StringManager, org.apache.tomcat.websocket.Transformation, .WsIOException, .WsSession
Servlet 3.1 HTTP upgrade handler for WebSocket connections.

Field Summary

Modifier and TypeField and Description
private final ClassLoader
applicationClassLoader

private WebConnection
connection

private Endpoint
ep

private WsHandshakeRequest
handshakeRequest

private final Log
log

private List<Extension>
negotiatedExtensions

private Map<String, String>
pathParameters

private boolean
secure

private ServerEndpointConfig
serverEndpointConfig

private static final StringManager
sm

private SocketWrapperBase<?>
socketWrapper

private String
subProtocol

private Transformation
transformation

private UpgradeInfo
upgradeInfo

private WsServerContainer
webSocketContainer

private WsFrameServer
wsFrame

private WsRemoteEndpointImplServer
wsRemoteEndpointServer

private WsSession
wsSession

Constructor Summary

AccessConstructor and Description
public
WsHttpUpgradeHandler()

Method Summary

Modifier and TypeMethod and Description
private void
close(CloseReason cr)

public void
destroy()

Implements jakarta.servlet.http.HttpUpgradeHandler.destroy.

This method is called after the upgraded connection has been closed.

public UpgradeInfo
getUpgradeInfo()

Overrides default org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.getUpgradeInfo.

public void
init(WebConnection
The connection that has been upgraded
connection)

Implements jakarta.servlet.http.HttpUpgradeHandler.init.

This method is called once the request/response pair where HttpServletRequest#upgrade(Class) is called has completed processing and is the point where control of the connection passes from the container to the HttpUpgradeHandler.

private void
onError(Throwable throwable)

public void
pause()

Implements org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.pause.

public void
preInit(ServerEndpointConfig serverEndpointConfig, WsServerContainer wsc, WsHandshakeRequest handshakeRequest, List<Extension> negotiatedExtensionsPhase2, String subProtocol, Transformation transformation, Map<String, String> pathParameters, boolean secure)

public void
setSocketWrapper(SocketWrapperBase<?> socketWrapper)

Implements org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.setSocketWrapper.

public void
setSslSupport(SSLSupport sslSupport)

Implements org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.setSslSupport.

public void
timeoutAsync(long now)

Implements org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.timeoutAsync.

public AbstractEndpoint.Handler.SocketState
upgradeDispatch(SocketEvent status)

Implements org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.upgradeDispatch.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

applicationClassLoaderback to summary
private final ClassLoader applicationClassLoader
connectionback to summary
private WebConnection connection
epback to summary
private Endpoint ep
handshakeRequestback to summary
private WsHandshakeRequest handshakeRequest
logback to summary
private final Log log
negotiatedExtensionsback to summary
private List<Extension> negotiatedExtensions
pathParametersback to summary
private Map<String, String> pathParameters
secureback to summary
private boolean secure
serverEndpointConfigback to summary
private ServerEndpointConfig serverEndpointConfig
smback to summary
private static final StringManager sm
socketWrapperback to summary
private SocketWrapperBase<?> socketWrapper
subProtocolback to summary
private String subProtocol
transformationback to summary
private Transformation transformation
upgradeInfoback to summary
private UpgradeInfo upgradeInfo
webSocketContainerback to summary
private WsServerContainer webSocketContainer
wsFrameback to summary
private WsFrameServer wsFrame
wsRemoteEndpointServerback to summary
private WsRemoteEndpointImplServer wsRemoteEndpointServer
wsSessionback to summary
private WsSession wsSession

Constructor Detail

WsHttpUpgradeHandlerback to summary
public WsHttpUpgradeHandler()

Method Detail

closeback to summary
private void close(CloseReason cr)
destroyback to summary
public void destroy()

Implements jakarta.servlet.http.HttpUpgradeHandler.destroy.

Doc from jakarta.servlet.http.HttpUpgradeHandler.destroy.

This method is called after the upgraded connection has been closed.

Annotations
@Override
getUpgradeInfoback to summary
public UpgradeInfo getUpgradeInfo()

Overrides default org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.getUpgradeInfo.

Annotations
@Override
initback to summary
public void init(WebConnection connection)

Implements jakarta.servlet.http.HttpUpgradeHandler.init.

Doc from jakarta.servlet.http.HttpUpgradeHandler.init.

This method is called once the request/response pair where HttpServletRequest#upgrade(Class) is called has completed processing and is the point where control of the connection passes from the container to the HttpUpgradeHandler.

Parameters
connection:WebConnection

The connection that has been upgraded

Annotations
@Override
onErrorback to summary
private void onError(Throwable throwable)
pauseback to summary
public void pause()

Implements org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.pause.

Annotations
@Override
preInitback to summary
public void preInit(ServerEndpointConfig serverEndpointConfig, WsServerContainer wsc, WsHandshakeRequest handshakeRequest, List<Extension> negotiatedExtensionsPhase2, String subProtocol, Transformation transformation, Map<String, String> pathParameters, boolean secure)
setSocketWrapperback to summary
public void setSocketWrapper(SocketWrapperBase<?> socketWrapper)

Implements org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.setSocketWrapper.

Annotations
@Override
setSslSupportback to summary
public void setSslSupport(SSLSupport sslSupport)

Implements org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.setSslSupport.

Annotations
@Override
timeoutAsyncback to summary
public void timeoutAsync(long now)

Implements org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.timeoutAsync.

Annotations
@Override
upgradeDispatchback to summary
public AbstractEndpoint.Handler.SocketState upgradeDispatch(SocketEvent status)

Implements org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.upgradeDispatch.

Annotations
@Override