Interface HandshakeInterceptor
- All Known Implementing Classes:
HttpSessionHandshakeInterceptor
,OriginHandshakeInterceptor
public interface HandshakeInterceptor
Interceptor for WebSocket handshake requests. Can be used to inspect the handshake request and response as well as to pass attributes to the targetWebSocketHandler
.- Since:
- 4.0
- Author:
- Rossen Stoyanchev
- See Also:
WebSocketHttpRequestHandler
,DefaultSockJsService
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception exception)
Invoked after the handshake is done.boolean
beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes)
Invoked before the handshake is processed.
Method Detail
beforeHandshake
boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes) throws Exception
Invoked before the handshake is processed.- Parameters:
request
- the current requestresponse
- the current responsewsHandler
- the target WebSocket handlerattributes
- the attributes from the HTTP handshake to associate with the WebSocket session; the provided attributes are copied, the original map is not used.- Returns:
- whether to proceed with the handshake (
true
) or abort (false
) - Throws:
Exception
afterHandshake
void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, @Nullable Exception exception)
Invoked after the handshake is done. The response status and headers indicate the results of the handshake, i.e. whether it was successful or not.- Parameters:
request
- the current requestresponse
- the current responsewsHandler
- the target WebSocket handlerexception
- an exception raised during the handshake, ornull
if none