org.springframework.web.socket.server

Interface HandshakeInterceptor

    • Method Detail

      • beforeHandshake

        boolean beforeHandshake(ServerHttpRequest request,
                                ServerHttpResponse response,
                                WebSocketHandler wsHandler,
                                java.util.Map<java.lang.String,java.lang.Object> attributes)
                         throws java.lang.Exception
        Invoked before the handshake is processed.
        Parameters:
        request - the current request
        response - the current response
        wsHandler - the target WebSocket handler
        attributes - 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:
        java.lang.Exception
      • afterHandshake

        void afterHandshake(ServerHttpRequest request,
                            ServerHttpResponse response,
                            WebSocketHandler wsHandler,
                            @Nullable
                            java.lang.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 request
        response - the current response
        wsHandler - the target WebSocket handler
        exception - an exception raised during the handshake, or null if none