org.springframework.web.reactive.socket.server.upgrade

Class JettyRequestUpgradeStrategy

  • java.lang.Object
    • org.springframework.web.reactive.socket.server.upgrade.JettyRequestUpgradeStrategy
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      org.eclipse.jetty.websocket.api.WebSocketPolicy getWebSocketPolicy()
      Return the configured WebSocketPolicy, if any.
      boolean isRunning()
      Check whether this component is currently running.
      void setWebSocketPolicy(org.eclipse.jetty.websocket.api.WebSocketPolicy webSocketPolicy)
      Configure a WebSocketPolicy to use to initialize WebSocketServerFactory.
      void start()
      Start this component.
      void stop()
      Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.
      reactor.core.publisher.Mono<java.lang.Void> upgrade(ServerWebExchange exchange, WebSocketHandler handler, java.lang.String subProtocol, java.util.function.Supplier<HandshakeInfo> handshakeInfoFactory)
      Upgrade to a WebSocket session and handle it with the given handler.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • JettyRequestUpgradeStrategy

        public JettyRequestUpgradeStrategy()
    • Method Detail

      • setWebSocketPolicy

        public void setWebSocketPolicy(org.eclipse.jetty.websocket.api.WebSocketPolicy webSocketPolicy)
        Configure a WebSocketPolicy to use to initialize WebSocketServerFactory.
        Parameters:
        webSocketPolicy - the WebSocket settings
      • getWebSocketPolicy

        @Nullable
        public org.eclipse.jetty.websocket.api.WebSocketPolicy getWebSocketPolicy()
        Return the configured WebSocketPolicy, if any.
      • 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:
        SmartLifecycle.isAutoStartup()
      • 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:
        SmartLifecycle.stop(Runnable), DisposableBean.destroy()
      • 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
      • upgrade

        public reactor.core.publisher.Mono<java.lang.Void> upgrade(ServerWebExchange exchange,
                                                                   WebSocketHandler handler,
                                                                   @Nullable
                                                                   java.lang.String subProtocol,
                                                                   java.util.function.Supplier<HandshakeInfo> handshakeInfoFactory)
        Description copied from interface: RequestUpgradeStrategy
        Upgrade to a WebSocket session and handle it with the given handler.
        Specified by:
        upgrade in interface RequestUpgradeStrategy
        Parameters:
        exchange - the current exchange
        handler - handler for the WebSocket session
        subProtocol - the selected sub-protocol got the handler
        handshakeInfoFactory - factory to create HandshakeInfo for the WebSocket session
        Returns:
        completion Mono<Void> to indicate the outcome of the WebSocket session handling.