パッケージ org.springframework.web.socket.server

インターフェース RequestUpgradeStrategy

すべての既知の実装クラス:
AbstractStandardUpgradeStrategy、AbstractTyrusRequestUpgradeStrategy、GlassFishRequestUpgradeStrategy、JettyRequestUpgradeStrategy、StandardWebSocketUpgradeStrategy、TomcatRequestUpgradeStrategy、UndertowRequestUpgradeStrategy、WebLogicRequestUpgradeStrategy、WebSphereRequestUpgradeStrategy
public interface RequestUpgradeStrategy
WebSocket 交換への実際のアップグレードを実行するためのサーバー固有の戦略。
導入:
4.0
作成者:
Rossen Stoyanchev
関連事項:

  • メソッドの詳細

    • getSupportedVersions

      StringSE[] getSupportedVersions()
      サポートされている WebSocket プロトコルバージョンを返します。

    • getSupportedExtensions

      ListSE<WebSocketExtension> getSupportedExtensions(ServerHttpRequest request)
      基礎となる WebSocket サーバーによってサポートされる WebSocket プロトコル拡張機能を返します。

    • upgrade

      void upgrade(ServerHttpRequest request, ServerHttpResponse response, @Nullable StringSE selectedProtocol, ListSE<WebSocketExtension> selectedExtensions, @Nullable PrincipalSE user, WebSocketHandler wsHandler, MapSE<StringSE,ObjectSE> attributes) throws HandshakeFailureException
      ランタイム固有の手順を実行して、アップグレードを完了します。ハンドシェイクリクエストのネゴシエーションが成功した後に呼び出されます。
      パラメーター:
      request - 現在のリクエスト
      response - 現在のレスポンス
      selectedProtocol - 選択されたサブプロトコル（存在する場合）
      selectedExtensions - 選択された WebSocket プロトコル拡張
      user - WebSocket セッションに関連付けるユーザー
      wsHandler - WebSocket メッセージのハンドラー
      attributes - ハンドシェイクは、HandshakeInterceptor を介して WebSocket セッションで設定され、WebSocketHandler で利用可能になる特定の属性をリクエストします。
      例外:
      HandshakeFailureException - ハンドシェイクリクエストの要件のネゴシエーションに失敗したのではなく、内部の回復不可能なエラー、つまりサーバーエラーが原因でハンドシェイク処理が完了しなかった場合にスローされます。