Package org.springframework.web.reactive.socket.server.support

Class HandshakeWebSocketService

java.lang.Object
org.springframework.web.reactive.socket.server.support.HandshakeWebSocketService
All Implemented Interfaces:
Lifecycle, WebSocketService
public class HandshakeWebSocketService extends Object implements WebSocketService, Lifecycle
WebSocketService implementation that handles a WebSocket HTTP handshake request by delegating to a RequestUpgradeStrategy which is either auto-detected (no-arg constructor) from the classpath but can also be explicitly configured.
Since:
5.0
Author:
Rossen Stoyanchev

  • Field Details

    • logger

      protected static final Log logger

  • Constructor Details

    • HandshakeWebSocketService

      public HandshakeWebSocketService()
      Default constructor automatic, classpath detection based discovery of the RequestUpgradeStrategy to use.

    • HandshakeWebSocketService

      public HandshakeWebSocketService(RequestUpgradeStrategy upgradeStrategy)
      Alternative constructor with the RequestUpgradeStrategy to use.
      Parameters:
      upgradeStrategy - the strategy to use

  • Method Details

    • getUpgradeStrategy

      public RequestUpgradeStrategy getUpgradeStrategy()
      Return the RequestUpgradeStrategy for WebSocket requests.

    • setSessionAttributePredicate

      public void setSessionAttributePredicate(@Nullable Predicate<String> predicate)
      Configure a predicate to use to extract WebSession attributes and use them to initialize the WebSocket session with.

      By default this is not set in which case no attributes are passed.

      Parameters:
      predicate - the predicate
      Since:
      5.1

    • getSessionAttributePredicate

      @Nullable public Predicate<String> getSessionAttributePredicate()
      Return the configured predicate for initialization WebSocket session attributes from WebSession attributes.
      Since:
      5.1

    • start

      public void start()
      Description copied from interface: Lifecycle
      Start this component.

      Should not throw an exception if the component is already running.

      In the case of a container, this will propagate the start signal to all components that apply.

      Specified by:
      start in interface Lifecycle
      See Also:

    • doStart

      protected void doStart()

    • stop

      public void stop()
      Description copied from interface: Lifecycle
      Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementing SmartLifecycle and its stop(Runnable) variant when asynchronous stop behavior is necessary.

      Note that this stop notification is not guaranteed to come before destruction: On regular shutdown, Lifecycle beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront.

      Should not throw an exception if the component is not running (not started yet).

      In the case of a container, this will propagate the stop signal to all components that apply.

      Specified by:
      stop in interface Lifecycle
      See Also:

    • doStop

      protected void doStop()

    • isRunning

      public boolean isRunning()
      Description copied from interface: Lifecycle
      Check whether this component is currently running.

      In the case of a container, this will return true only if all components that apply are currently running.

      Specified by:
      isRunning in interface Lifecycle
      Returns:
      whether the component is currently running

    • handleRequest

      public reactor.core.publisher.Mono<Void> handleRequest(ServerWebExchange exchange, WebSocketHandler handler)
      Description copied from interface: WebSocketService
      Handle the request with the given WebSocketHandler.
      Specified by:
      handleRequest in interface WebSocketService
      Parameters:
      exchange - the current exchange
      handler - handler for WebSocket session
      Returns:
      a Mono<Void> that completes when application handling of the WebSocket session completes.