クラス StandardWebSocketUpgradeStrategy

java.lang.ObjectSE
org.springframework.web.socket.server.standard.StandardWebSocketUpgradeStrategy
実装されているすべてのインターフェース:
RequestUpgradeStrategy
public class StandardWebSocketUpgradeStrategy extends ObjectSE implements RequestUpgradeStrategy
Jakarta WebSocket API 2.1+ 用の WebSocket RequestUpgradeStrategy。

基礎となる ServerContainer のプロパティを変更するには、XML 構成で ServletServerContainerFactoryBean を使用するか、Java 構成を使用する場合は、"jakarta.websocket.server.ServerContainer" ServletContext 属性を介してコンテナーインスタンスにアクセスします。

導入:
6.0
作成者:
Juergen Hoeller, Rossen Stoyanchev
関連事項:
  • ServerContainer.upgradeHttpToWebSocket(Object, Object, ServerEndpointConfig, Map)

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

    • StandardWebSocketUpgradeStrategy

      public StandardWebSocketUpgradeStrategy()

  • メソッドの詳細

    • getSupportedVersions

      public StringSE[] getSupportedVersions()
      インターフェースからコピーされた説明: RequestUpgradeStrategy
      サポートされている WebSocket プロトコルバージョンを返します。
      次で指定:
      インターフェース RequestUpgradeStrategy の getSupportedVersions 

    • getSupportedExtensions

      public ListSE<WebSocketExtension> getSupportedExtensions(ServerHttpRequest request)
      インターフェースからコピーされた説明: RequestUpgradeStrategy
      基礎となる WebSocket サーバーによってサポートされる WebSocket プロトコル拡張機能を返します。
      次で指定:
      インターフェース RequestUpgradeStrategy の getSupportedExtensions 

    • getInstalledExtensions

      protected ListSE<WebSocketExtension> getInstalledExtensions(jakarta.websocket.WebSocketContainer container)

    • upgrade

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

    • getContainer

      protected jakarta.websocket.server.ServerContainer getContainer(jakarta.servlet.http.HttpServletRequest request)

    • getHttpServletRequest

      protected final jakarta.servlet.http.HttpServletRequest getHttpServletRequest(ServerHttpRequest request)

    • getHttpServletResponse

      protected final jakarta.servlet.http.HttpServletResponse getHttpServletResponse(ServerHttpResponse response)