Class StandardWebSocketClient

All Implemented Interfaces:

public class StandardWebSocketClient extends AbstractWebSocketClient
A WebSocketClient based on standard Java WebSocket API.
Rossen Stoyanchev
  • Constructor Details

    • StandardWebSocketClient

      public StandardWebSocketClient()
      Default constructor that calls ContainerProvider.getWebSocketContainer() to obtain a (new) WebSocketContainer instance. Also see constructor accepting existing WebSocketContainer instance.
    • StandardWebSocketClient

      public StandardWebSocketClient(WebSocketContainer webSocketContainer)
      Constructor accepting an existing WebSocketContainer instance.

      For XML configuration, see WebSocketContainerFactoryBean. For Java configuration, use ContainerProvider.getWebSocketContainer() to obtain the WebSocketContainer instance.

  • Method Details

    • setUserProperties

      public void setUserProperties(@Nullable Map<String,Object> userProperties)
      The standard Java WebSocket API allows passing "user properties" to the server via userProperties. Use this property to configure one or more properties to be passed on every handshake.
    • getUserProperties

      public Map<String,Object> getUserProperties()
      The configured user properties.
    • setTaskExecutor

      public void setTaskExecutor(@Nullable AsyncListenableTaskExecutor taskExecutor)
      Set an AsyncListenableTaskExecutor to use when opening connections. If this property is set to null, calls to any of the doHandshake methods will block until the connection is established.

      By default, an instance of SimpleAsyncTaskExecutor is used.

    • getTaskExecutor

      @Nullable public AsyncListenableTaskExecutor getTaskExecutor()
      Return the configured TaskExecutor.
    • doHandshakeInternal

      protected ListenableFuture<WebSocketSession> doHandshakeInternal(WebSocketHandler webSocketHandler, HttpHeaders headers, URI uri, List<String> protocols, List<WebSocketExtension> extensions, Map<String,Object> attributes)
      Description copied from class: AbstractWebSocketClient
      Perform the actual handshake to establish a connection to the server.
      Specified by:
      doHandshakeInternal in class AbstractWebSocketClient
      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)
      protocols - requested sub-protocols, or an empty list
      extensions - requested WebSocket extensions, or an empty list
      attributes - the attributes to associate with the WebSocketSession, i.e. via WebSocketSession.getAttributes(); currently always an empty map.
      the established WebSocket session wrapped in a ListenableFuture.