クラス WebSocketHttpHeaders

java.lang.ObjectSE
org.springframework.http.HttpHeaders
org.springframework.web.socket.WebSocketHttpHeaders
実装されているすべてのインターフェース:
SerializableSE
public class WebSocketHttpHeaders extends HttpHeaders
WebSocket 仕様 RFC 6455 で定義された HTTP ヘッダーのサポートを追加する HttpHeaders バリアント。
導入:
4.0
作成者:
Rossen Stoyanchev
関連事項:

  • フィールドの詳細

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

    • WebSocketHttpHeaders

      public WebSocketHttpHeaders()
      新しいインスタンスを作成します。

    • WebSocketHttpHeaders

      public WebSocketHttpHeaders(HttpHeaders headers)
      指定された既存の HttpHeaders をラップするインスタンスを作成し、それにすべての変更を伝播します。
      パラメーター:
      headers - ラップする HTTP ヘッダー

  • メソッドの詳細

    • setSecWebSocketAccept

      public void setSecWebSocketAccept(@Nullable StringSE secWebSocketAccept)
      Sec-WebSocket-Accept ヘッダーの（新しい）値を設定します。
      パラメーター:
      secWebSocketAccept - ヘッダーの値

    • getSecWebSocketAccept

      public @Nullable StringSE getSecWebSocketAccept()
      Sec-WebSocket-Accept ヘッダーの値を返します。
      戻り値:
      ヘッダーの値

    • getSecWebSocketExtensions

      public ListSE<WebSocketExtension> getSecWebSocketExtensions()
      Sec-WebSocket-Extensions ヘッダーの値を返します。
      戻り値:
      ヘッダーの値

    • setSecWebSocketExtensions

      public void setSecWebSocketExtensions(ListSE<WebSocketExtension> extensions)
      Sec-WebSocket-Extensions ヘッダーの（新しい）値を設定します。
      パラメーター:
      extensions - ヘッダーの値

    • setSecWebSocketKey

      public void setSecWebSocketKey(@Nullable StringSE secWebSocketKey)
      Sec-WebSocket-Key ヘッダーの（新しい）値を設定します。
      パラメーター:
      secWebSocketKey - ヘッダーの値

    • getSecWebSocketKey

      public @Nullable StringSE getSecWebSocketKey()
      Sec-WebSocket-Key ヘッダーの値を返します。
      戻り値:
      ヘッダーの値

    • setSecWebSocketProtocol

      public void setSecWebSocketProtocol(StringSE secWebSocketProtocol)
      Sec-WebSocket-Protocol ヘッダーの（新しい）値を設定します。
      パラメーター:
      secWebSocketProtocol - ヘッダーの値

    • setSecWebSocketProtocol

      public void setSecWebSocketProtocol(ListSE<StringSE> secWebSocketProtocols)
      Sec-WebSocket-Protocol ヘッダーの（新しい）値を設定します。
      パラメーター:
      secWebSocketProtocols - ヘッダーの値

    • getSecWebSocketProtocol

      public ListSE<StringSE> getSecWebSocketProtocol()
      Sec-WebSocket-Protocol ヘッダーの値を返します。
      戻り値:
      ヘッダーの値

    • setSecWebSocketVersion

      public void setSecWebSocketVersion(@Nullable StringSE secWebSocketVersion)
      Sec-WebSocket-Version ヘッダーの（新しい）値を設定します。
      パラメーター:
      secWebSocketVersion - ヘッダーの値

    • getSecWebSocketVersion

      public @Nullable StringSE getSecWebSocketVersion()
      Sec-WebSocket-Version ヘッダーの値を返します。
      戻り値:
      ヘッダーの値

    • getFirst

      public @Nullable StringSE getFirst(StringSE headerName)
      指定されたヘッダー名の最初のヘッダー値があれば、それを返します。
      オーバーライド:
      クラス HttpHeaders の getFirst 
      パラメーター:
      headerName - ヘッダー名
      戻り値:
      最初のヘッダー値。または null

    • add

      public void add(StringSE headerName, @Nullable StringSE headerValue)
      指定された名前に、指定された単一のヘッダー値を追加します。
      オーバーライド:
      クラス HttpHeaders の add 
      パラメーター:
      headerName - ヘッダー名
      headerValue - ヘッダー値
      例外:
      UnsupportedOperationExceptionSE - ヘッダーの追加がサポートされていない場合
      関連事項:

    • set

      public void set(StringSE headerName, @Nullable StringSE headerValue)
      指定された名前に、指定された単一のヘッダー値を設定します。
      オーバーライド:
      クラス HttpHeaders の set 
      パラメーター:
      headerName - ヘッダー名
      headerValue - ヘッダー値
      例外:
      UnsupportedOperationExceptionSE - ヘッダーの追加がサポートされていない場合
      関連事項:

    • setAll

      public void setAll(MapSE<StringSE,StringSE> values)
      クラスからコピーされた説明: HttpHeaders
      指定されたマップから、対応する名前ごとにすべての単一ヘッダー値を設定します。
      オーバーライド:
      クラス HttpHeaders の setAll 
      パラメーター:
      values - 名前と単一値のペア
      関連事項:

    • toSingleValueMap

      public MapSE<StringSE,StringSE> toSingleValueMap()
      クラスからコピーされた説明: HttpHeaders
      この HttpHeaders を、各ヘッダー名の最初の値を持つ Map として返します。

      このメソッドと HttpHeaders.asSingleValueMap() メソッドの違いは、このメソッドがヘッダーのコピーを返すのに対し、HttpHeaders.asSingleValueMap() メソッドはビューを返すことです。このコピーにより、entrySet() のようなコレクション反復メソッドは大文字と小文字を区別しなくなります。

      オーバーライド:
      クラス HttpHeaders の toSingleValueMap 
      戻り値:
      これらのヘッダーの単一の値表現

    • size

      public int size()
      クラスからコピーされた説明: HttpHeaders
      コレクション内のヘッダーの数を返します。これは増加される可能性があります。class level javadoc を参照してください。
      オーバーライド:
      クラス HttpHeaders の size 

    • isEmpty

      public boolean isEmpty()
      クラスからコピーされた説明: HttpHeaders
      この HttpHeaders にヘッダーエントリが含まれていない場合は、true を返します。
      オーバーライド:
      クラス HttpHeaders の isEmpty 

    • containsHeader

      public boolean containsHeader(StringSE key)
      クラスからコピーされた説明: HttpHeaders
      この HttpHeaders に指定されたヘッダー名のエントリが含まれている場合は、true を返します。
      オーバーライド:
      クラス HttpHeaders の containsHeader 
      パラメーター:
      key - ヘッダー名

    • get

      public @Nullable ListSE<StringSE> get(StringSE headerName)
      クラスからコピーされた説明: HttpHeaders
      指定されたヘッダー名に関連付けられた値のリスト、または null を取得します。

      二重引用符で囲まれた値のサポートを確実にするには、HttpHeaders.getValuesAsList(String) も参照してください。

      オーバーライド:
      クラス HttpHeaders の get 
      パラメーター:
      headerName - ヘッダー名
      関連事項:

    • put

      public @Nullable ListSE<StringSE> put(StringSE key, ListSE<StringSE> value)
      クラスからコピーされた説明: HttpHeaders
      指定されたヘッダー名に関連付けられた値のリストを設定します。以前の値のリストを返します。ヘッダーが存在しない場合は null を返します。
      オーバーライド:
      クラス HttpHeaders の put 
      パラメーター:
      key - ヘッダー名
      value - 新しい価値観
      戻り値:
      指定されたヘッダー名の古い値

    • remove

      public @Nullable ListSE<StringSE> remove(StringSE key)
      クラスからコピーされた説明: HttpHeaders
      この HttpHeaders インスタンスからヘッダーを削除し、関連付けられた値リストを返します。そのヘッダーが存在しない場合は、null を返します。
      オーバーライド:
      クラス HttpHeaders の remove 
      パラメーター:
      key - 削除するヘッダーの名前
      戻り値:
      削除されたヘッダー名に関連付けられた値リスト

    • putAll

      public void putAll(HttpHeaders headers)
      クラスからコピーされた説明: HttpHeaders
      指定された HttpHeaders のすべてのエントリをこの HttpHeaders に格納します。
      オーバーライド:
      クラス HttpHeaders の putAll 
      パラメーター:
      headers - 指定されたヘッダー
      関連事項:

    • putAll

      public void putAll(MapSE<? extends StringSE, ? extends ListSE<StringSE>> m)
      クラスからコピーされた説明: HttpHeaders
      指定された MultiValueMap のすべてのエントリをこの HttpHeaders に格納します。
      オーバーライド:
      クラス HttpHeaders の putAll 
      パラメーター:
      m - 指定されたヘッダー
      関連事項:

    • clear

      public void clear()
      クラスからコピーされた説明: HttpHeaders
      この HttpHeaders インスタンスからすべてのヘッダーを削除します。
      オーバーライド:
      クラス HttpHeaders の clear 

    • headerNames

      public SetSE<StringSE> headerNames()
      クラスからコピーされた説明: HttpHeaders
      ヘッダー名のセットを返します。Set.remove(Object)SE と Set.clear() の両方の演算がサポートされており、ヘッダーを変更します。

      このコレクションには、バックエンド構造に複数の大文字小文字のバリエーションが格納されている場合でも、各ヘッダー名の大文字小文字のバリエーションが 1 つだけ含まれることが保証されます。最初に検出されたバリエーションが保持されます。

      オーバーライド:
      クラス HttpHeaders の headerNames 
      戻り値:
      すべてのヘッダー名の Set 

    • headerSet

      public SetSE<Map.EntrySE<StringSE, ListSE<StringSE>>> headerSet()
      クラスからコピーされた説明: HttpHeaders
      キーリストペアのエントリ Set としてヘッダーのビューを返します。Iterator.remove() と Map.Entry.setValue(V)SE の両方がサポートされており、ヘッダーを変更します。

      このコレクションには、バッキング構造に複数の大文字と小文字の異なる名前が格納されている場合でも、反復処理をフィルタリングするために大文字と小文字を区別しないセットに最初に名前をコピーするというコストをかけて、ヘッダー名ごとに 1 つのエントリが含まれることが保証されます。

      オーバーライド:
      クラス HttpHeaders の headerSet 
      戻り値:
      大文字と小文字を区別せずにすべてのヘッダーを反復処理する Set ビュー

    • forEach

      public void forEach(BiConsumerSE<? super StringSE, ? super ListSE<StringSE>> action)
      クラスからコピーされた説明: HttpHeaders
      HttpHeaders.headerSet() を介して反復処理する場合と同様に、各ヘッダーに対してアクションを実行します。
      オーバーライド:
      クラス HttpHeaders の forEach 
      パラメーター:
      action - 各エントリに対して実行されるアクション

    • putIfAbsent

      public @Nullable ListSE<StringSE> putIfAbsent(StringSE headerName, ListSE<StringSE> headerValues)
      クラスからコピーされた説明: HttpHeaders
      指定されたヘッダー名がこの HttpHeaders にまだ存在しない場合、そのヘッダー名にヘッダー値を設定し、null を返します。ヘッダーがすでに存在する場合は、代わりに関連付けられた値のリストを返します。
      オーバーライド:
      クラス HttpHeaders の putIfAbsent 
      パラメーター:
      headerName - ヘッダー名
      headerValues - ヘッダーが存在しない場合に設定するヘッダー値
      戻り値:
      前の値または null

    • equals

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

    • hashCode

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

    • toString

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