クラス WebSocketHttpRequestHandler

java.lang.ObjectSE
org.springframework.web.socket.server.support.WebSocketHttpRequestHandler
実装済みのインターフェース一覧:
Aware, Lifecycle, ServletContextAware, HttpRequestHandler
public class WebSocketHttpRequestHandler extends ObjectSE implements HttpRequestHandler, Lifecycle, ServletContextAware
WebSocket ハンドシェイクリクエストを処理するための HttpRequestHandler。

これは、特定の URL でサーバー WebSocket を設定する際に使用するメインクラスです。これは WebSocketHandler と HandshakeHandler をラップした非常に薄いラッパーであり、HttpServletRequest と HttpServletResponse をそれぞれ ServerHttpRequest と ServerHttpResponse に適合させます。

導入:
4.0
作成者:
Rossen Stoyanchev

  • コンストラクターの詳細

  • 方法の詳細

    • decorate

      protected WebSocketHandler decorate(WebSocketHandler handler)
      コンストラクターに渡された WebSocketHandler を装飾します。

      デフォルトでは、LoggingWebSocketHandlerDecorator および ExceptionWebSocketHandlerDecorator が追加されます。

      導入:
      5.2.2

    • getWebSocketHandler

      public WebSocketHandler getWebSocketHandler()
      WebSocketHandler を返します。

    • getHandshakeHandler

      public HandshakeHandler getHandshakeHandler()
      HandshakeHandler を返します。

    • setHandshakeInterceptors

      public void setHandshakeInterceptors(@Nullable ListSE<HandshakeInterceptor> interceptors)
      1 つ以上の WebSocket ハンドシェイクリクエストインターセプターを構成します。

    • getHandshakeInterceptors

      public ListSE<HandshakeInterceptor> getHandshakeInterceptors()
      構成された WebSocket ハンドシェイクリクエストインターセプターを返します。

    • setServletContext

      public void setServletContext(jakarta.servlet.ServletContext servletContext)
      インターフェースからコピーされた説明: ServletContextAware
      このオブジェクトが実行される ServletContext を設定します。

      通常の Bean プロパティの設定後、InitializingBean の afterPropertiesSet またはカスタム init メソッドのような初期コールバックの前に呼び出されます。ApplicationContextAware の setApplicationContext の後に呼び出されます。

      次で指定:
      インターフェース ServletContextAware 内の setServletContext 
      パラメーター:
      servletContext - このオブジェクトによって使用される ServletContext オブジェクト
      関連事項:

    • start

      public void start()
      インターフェースからコピーされた説明: Lifecycle
      このコンポーネントを起動します。

      コンポーネントがすでに実行されている場合は、例外をスローしないでください。

      コンテナーの場合、これにより、自動起動しないコンポーネントも含め、適用されるすべてのコンポーネントにハードスタートシグナルが伝播されます。

      次で指定:
      インターフェース Lifecycle 内の start 
      関連事項:

    • stop

      public void stop()
      インターフェースからコピーされた説明: Lifecycle
      このメソッドを返すとコンポーネントが完全に停止するように、通常は同期的にこのコンポーネントを停止します。非同期停止動作が必要な場合は、SmartLifecycle とその stop(Runnable) バリアントの実装を検討してください。

      この停止通知は破棄前に送信されるとは限らないことに注意してください。通常のシャットダウンでは、一般的な破棄コールバックが伝播される前に、Lifecycle Bean は最初に停止通知を受信します。ただし、コンテキストの存続期間中のホットリフレッシュまたは中断されたリフレッシュ試行では、特定の Bean の destroy メソッドが、停止シグナルを事前に考慮することなく呼び出されます。

      コンポーネントが実行されていない（まだ開始されていない）場合は、例外をスローしないでください。

      コンテナーの場合、これは停止シグナルを適用するすべてのコンポーネントに伝播します。

      次で指定:
      インターフェース Lifecycle 内の stop 
      関連事項:

    • isRunning

      public boolean isRunning()
      インターフェースからコピーされた説明: Lifecycle
      このコンポーネントが現在実行されているかどうかを確認します。

      コンテナーの場合、これは、適用されるすべてのコンポーネントが現在実行されている場合にのみ、true を返します。

      次で指定:
      インターフェース Lifecycle 内の isRunning 
      戻り値:
      コンポーネントが現在実行中かどうか

    • handleRequest

      public void handleRequest(jakarta.servlet.http.HttpServletRequest servletRequest, jakarta.servlet.http.HttpServletResponse servletResponse) throws jakarta.servlet.ServletException, IOExceptionSE
      インターフェースからコピーされた説明: HttpRequestHandler
      指定されたリクエストを処理し、レスポンスを生成します。
      次で指定:
      インターフェース HttpRequestHandler 内の handleRequest 
      パラメーター:
      servletRequest - 現在の HTTP リクエスト
      servletResponse - 現在の HTTP レスポンス
      例外:
      jakarta.servlet.ServletException - 一般的なエラーの場合
      IOExceptionSE - I/O エラーの場合