org.springframework.web.socket.server

Interface HandshakeHandler

All Known Implementing Classes:

DefaultHandshakeHandler, WebSocketTransportHandler

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

public interface HandshakeHandler

Contract for processing a WebSocket handshake request.

Since:

4.0

Author:

Rossen Stoyanchev

See Also:

WebSocketHttpRequestHandler

Method Summary

Modifier and Type	Method and Description
boolean	doHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler webSocketHandler) Initiate the handshake.

Method Detail

doHandshake

boolean doHandshake(ServerHttpRequest request,
                  ServerHttpResponse response,
                  WebSocketHandler webSocketHandler)
                    throws java.io.IOException,
                           HandshakeFailureException

Initiate the handshake.

Parameters:

request - the current request

response - the current response

webSocketHandler - the handler to process WebSocket messages; see PerConnectionWebSocketHandler for providing a handler with per-connection lifecycle.

Returns:

whether the handshake negotiation was successful or not. In either case the response status, headers, and body will have been updated to reflect the result of the negotiation

Throws:

java.io.IOException - thrown when accessing or setting the response

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.