Spring Framework 6.1.4 · org.springframework.web.socket.server.RequestUpgradeStrategy

Method Summary

Modifier and Type	Method and Description
public List<WebSocketExtension>	getSupportedExtensions(ServerHttpRequest request) Return the WebSocket protocol extensions supported by the underlying WebSocket server.
public String[]	getSupportedVersions() Return the supported WebSocket protocol versions.
public void	upgrade(ServerHttpRequest the current request request, ServerHttpResponse the current response response, String the selected sub-protocol, if any selectedProtocol, List<WebSocketExtension> the selected WebSocket protocol extensions selectedExtensions, Principal the user to associate with the WebSocket session user, WebSocketHandler the handler for WebSocket messages wsHandler, Map<String, Object> handshake request specific attributes to be set on the WebSocket session via `org.springframework.web.socket.server.HandshakeInterceptor` and thus made available to the `org.springframework.web.socket.WebSocketHandler` attributes) Perform runtime specific steps to complete the upgrade.

getSupportedExtensions	back to summary
public List<WebSocketExtension> getSupportedExtensions(ServerHttpRequest request) Return the WebSocket protocol extensions supported by the underlying WebSocket server.

getSupportedVersions	back to summary
public String[] getSupportedVersions() Return the supported WebSocket protocol versions.

upgrade back to summary

upgrade	back to summary
public void upgrade(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler wsHandler, Map<String, Object> attributes) throws HandshakeFailureException Perform runtime specific steps to complete the upgrade. Invoked after successful negotiation of the handshake request. Parameters request:ServerHttpRequest the current request response:ServerHttpResponse the current response selectedProtocol:String the selected sub-protocol, if any selectedExtensions:List<WebSocketExtension> the selected WebSocket protocol extensions user:Principal the user to associate with the WebSocket session wsHandler:WebSocketHandler the handler for WebSocket messages attributes:Map<String, Object> handshake request specific attributes to be set on the WebSocket session via `org.springframework.web.socket.server.HandshakeInterceptor` and thus made available to the `org.springframework.web.socket.WebSocketHandler` Exceptions HandshakeFailureException: thrown when handshake processing failed to complete due to an internal, unrecoverable error, i.e. a server error as opposed to a failure to successfully negotiate the requirements of the handshake request.

public void upgrade(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler wsHandler, Map<String, Object> attributes) throws HandshakeFailureException

Perform runtime specific steps to complete the upgrade. Invoked after successful negotiation of the handshake request.

Parameters

request:ServerHttpRequest: the current request
response:ServerHttpResponse: the current response
selectedProtocol:String: the selected sub-protocol, if any
selectedExtensions:List<WebSocketExtension>: the selected WebSocket protocol extensions
user:Principal: the user to associate with the WebSocket session
wsHandler:WebSocketHandler: the handler for WebSocket messages
attributes:Map<String, Object>: handshake request specific attributes to be set on the WebSocket session via org.springframework.web.socket.server.HandshakeInterceptor and thus made available to the org.springframework.web.socket.WebSocketHandler

Exceptions

HandshakeFailureException:: thrown when handshake processing failed to complete due to an internal, unrecoverable error, i.e. a server error as opposed to a failure to successfully negotiate the requirements of the handshake request.