org.springframework.web.socket.server

Interface RequestUpgradeStrategy

All Known Implementing Classes:

AbstractStandardUpgradeStrategy, GlassFishRequestUpgradeStrategy, JettyRequestUpgradeStrategy, TomcatRequestUpgradeStrategy

public interface RequestUpgradeStrategy

A strategy for performing container-specific steps to upgrade an HTTP request during a WebSocket handshake. Intended for use within HandshakeHandler implementations.

Since:

4.0

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getSupportedVersions() Return the supported WebSocket protocol versions.
void	upgrade(ServerHttpRequest request, ServerHttpResponse response, java.lang.String selectedProtocol, WebSocketHandler webSocketHandler) Perform runtime specific steps to complete the upgrade.

Method Detail

getSupportedVersions

java.lang.String[] getSupportedVersions()

Return the supported WebSocket protocol versions.

upgrade

void upgrade(ServerHttpRequest request,
           ServerHttpResponse response,
           java.lang.String selectedProtocol,
           WebSocketHandler webSocketHandler)
             throws java.io.IOException,
                    HandshakeFailureException

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

Parameters:

webSocketHandler - the handler for WebSocket messages

Throws:

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.

java.io.IOException