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

クラス WebSocketExtension

java.lang.ObjectSE
org.springframework.web.socket.WebSocketExtension
既知の直属サブクラス
StandardToWebSocketExtensionAdapter
public class WebSocketExtension extends ObjectSE
RFC 6455 で定義されている WebSocket 拡張機能を表します。WebSocket 拡張機能は、WebSocket プロトコルにプロトコル機能を追加します。セッション内で使用される拡張機能は、ハンドシェイクフェーズ中に次のようにネゴシエートされます。
  • クライアントは HTTP ハンドシェイクリクエストで特定の拡張をリクエストする場合があります
  • サーバーは、現在のセッションで使用する拡張機能の最終リストで応答します

WebSocket 拡張 HTTP ヘッダーにはパラメーターが含まれ、RFC 7230 セクション 3.2 に従う場合があります

HTTP ヘッダー内の拡張の順序は、それらの実行順序を定義することに注意してください。拡張機能「foo、bar」は「bar（foo（message））」として実行されます。

導入:
4.0
作成者:
Brian Clozel, Juergen Hoeller
関連事項:

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

    • WebSocketExtension

      public WebSocketExtension(StringSE name)
      指定された名前で WebSocketExtension を作成します。
      パラメーター:
      name - 拡張機能の名前

    • WebSocketExtension

      public WebSocketExtension(StringSE name, @Nullable MapSE<StringSE,StringSE> parameters)
      指定された名前とパラメーターで WebSocketExtension を作成します。
      パラメーター:
      name - 拡張機能の名前
      parameters - パラメーター

  • メソッドの詳細

    • getName

      public StringSE getName()
      拡張機能の名前を返します (決して null または空ではありません)。

    • getParameters

      public MapSE<StringSE,StringSE> getParameters()
      エクステンションのパラメーターを返します（決して null ではありません）。

    • equals

      public boolean equals(@Nullable ObjectSE other)
      オーバーライド:
      クラス ObjectSE の equalsSE 

    • hashCode

      public int hashCode()
      オーバーライド:
      クラス ObjectSE の hashCode 

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString 

    • parseExtensions

      public static ListSE<WebSocketExtension> parseExtensions(StringSE extensions)
      指定されたコンマ区切りの文字列を解析して、WebSocketExtension オブジェクトのリストにします。

      このメソッドを使用して、"Sec-WebSocket-Extension" ヘッダーを解析できます。

      パラメーター:
      extensions - 解析する文字列
      戻り値:
      拡張機能のリスト
      例外:
      IllegalArgumentExceptionSE - 文字列を解析できない場合