org.springframework.web.socket.client

Class AbstractWebSocketClient

  • java.lang.Object
    • org.springframework.web.socket.client.AbstractWebSocketClient
    • Field Detail

      • logger

        protected final Log logger
    • Constructor Detail

      • AbstractWebSocketClient

        public AbstractWebSocketClient()
    • Method Detail

      • assertUri

        protected void assertUri(java.net.URI uri)
      • doHandshakeInternal

        protected abstract ListenableFuture<WebSocketSession> doHandshakeInternal(WebSocketHandler webSocketHandler,
                                                                                  HttpHeaders headers,
                                                                                  java.net.URI uri,
                                                                                  java.util.List<java.lang.String> subProtocols,
                                                                                  java.util.List<WebSocketExtension> extensions,
                                                                                  java.util.Map<java.lang.String,java.lang.Object> attributes)
        Perform the actual handshake to establish a connection to the server.
        Parameters:
        webSocketHandler - the client-side handler for WebSocket messages
        headers - the HTTP headers to use for the handshake, with unwanted (forbidden) headers filtered out (never null)
        uri - the target URI for the handshake (never null)
        subProtocols - requested sub-protocols, or an empty list
        extensions - requested WebSocket extensions, or an empty list
        attributes - attributes to associate with the WebSocketSession, i.e. via WebSocketSession.getAttributes(); currently always an empty map.
        Returns:
        the established WebSocket session wrapped in a ListenableFuture.