WebSocketHttpHeaders (Spring Framework 5.0.6.RELEASE API)

java.lang.Object
- org.springframework.http.HttpHeaders
- - org.springframework.web.socket.WebSocketHttpHeaders

実装済みのインターフェース一覧:
java.io.Serializable, java.util.Map<java.lang.String,java.util.List<java.lang.String>>, MultiValueMap<java.lang.String,java.lang.String>
```
public class WebSocketHttpHeaders
extends HttpHeaders
```
WebSocket 仕様 RFC 6455 で定義された HTTP ヘッダーのサポートを追加する HttpHeaders バリアント。
導入:
4.0
作成者:
Rossen Stoyanchev
関連事項:
連載形式

ネストされたクラスの概要
- インターフェース java.util.Map から継承されたネストクラス / インターフェース
  java.util.Map.Entry<K,V>

フィールド概要

フィールド
修飾子と型	フィールドと説明
`static java.lang.String`	`SEC_WEBSOCKET_ACCEPT`
`static java.lang.String`	`SEC_WEBSOCKET_EXTENSIONS`
`static java.lang.String`	`SEC_WEBSOCKET_KEY`
`static java.lang.String`	`SEC_WEBSOCKET_PROTOCOL`
`static java.lang.String`	`SEC_WEBSOCKET_VERSION`

クラス org.springframework.http.HttpHeaders から継承されたフィールド
ACCEPT, ACCEPT_CHARSET, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ACCEPT_RANGES, ACCESS_CONTROL_ALLOW_CREDENTIALS, ACCESS_CONTROL_ALLOW_HEADERS, ACCESS_CONTROL_ALLOW_METHODS, ACCESS_CONTROL_ALLOW_ORIGIN, ACCESS_CONTROL_EXPOSE_HEADERS, ACCESS_CONTROL_MAX_AGE, ACCESS_CONTROL_REQUEST_HEADERS, ACCESS_CONTROL_REQUEST_METHOD, AGE, ALLOW, AUTHORIZATION, CACHE_CONTROL, CONNECTION, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_RANGE, CONTENT_TYPE, COOKIE, DATE, EMPTY, ETAG, EXPECT, EXPIRES, FROM, HOST, IF_MATCH, IF_MODIFIED_SINCE, IF_NONE_MATCH, IF_RANGE, IF_UNMODIFIED_SINCE, LAST_MODIFIED, LINK, LOCATION, MAX_FORWARDS, ORIGIN, PRAGMA, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, RANGE, REFERER, RETRY_AFTER, SERVER, SET_COOKIE, SET_COOKIE2, TE, TRAILER, TRANSFER_ENCODING, UPGRADE, USER_AGENT, VARY, VIA, WARNING, WWW_AUTHENTICATE

コンストラクター概要

コンストラクター
コンストラクターと説明
`WebSocketHttpHeaders()` 新しいインスタンスを作成します。
`WebSocketHttpHeaders(HttpHeaders headers)` 指定された既存の HttpHeaders をラップするインスタンスを作成し、それにすべての変更を伝播します。

方法の概要

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`add(java.lang.String headerName, java.lang.String headerValue)` 指定された名前に、指定された単一のヘッダー値を追加します。
`void`	`clear()`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`java.util.Set<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>>`	`entrySet()`
`boolean`	`equals(java.lang.Object other)`
`java.util.List<java.lang.String>`	`get(java.lang.Object key)`
`java.lang.String`	`getFirst(java.lang.String headerName)` 指定されたヘッダー名の最初のヘッダー値があれば、それを返します。
`java.lang.String`	`getSecWebSocketAccept()` `Sec-WebSocket-Accept` ヘッダーの値を返します。
`java.util.List<WebSocketExtension>`	`getSecWebSocketExtensions()` `Sec-WebSocket-Extensions` ヘッダーの値を返します。
`java.lang.String`	`getSecWebSocketKey()` `Sec-WebSocket-Key` ヘッダーの値を返します。
`java.util.List<java.lang.String>`	`getSecWebSocketProtocol()` `Sec-WebSocket-Key` ヘッダーの値を返します。
`java.lang.String`	`getSecWebSocketVersion()` `Sec-WebSocket-Version` ヘッダーの値を返します。
`int`	`hashCode()`
`boolean`	`isEmpty()`
`java.util.Set<java.lang.String>`	`keySet()`
`java.util.List<java.lang.String>`	`put(java.lang.String key, java.util.List<java.lang.String> value)`
`void`	`putAll(java.util.Map<? extends java.lang.String,? extends java.util.List<java.lang.String>> m)`
`static WebSocketHttpHeaders`	`readOnlyWebSocketHttpHeaders(WebSocketHttpHeaders headers)` 読み取りのみが可能で、書き込みはできない `WebSocketHttpHeaders` オブジェクトを返します。
`java.util.List<java.lang.String>`	`remove(java.lang.Object key)`
`void`	`set(java.lang.String headerName, java.lang.String headerValue)` 指定された名前に、指定された単一のヘッダー値を設定します。
`void`	`setAll(java.util.Map<java.lang.String,java.lang.String> values)` 指定された値を下に設定します。
`void`	`setSecWebSocketAccept(java.lang.String secWebSocketAccept)` `Sec-WebSocket-Accept` ヘッダーの（新しい）値を設定します。
`void`	`setSecWebSocketExtensions(java.util.List<WebSocketExtension> extensions)` `Sec-WebSocket-Extensions` ヘッダーの（新しい）値を設定します。
`void`	`setSecWebSocketKey(java.lang.String secWebSocketKey)` `Sec-WebSocket-Key` ヘッダーの（新しい）値を設定します。
`void`	`setSecWebSocketProtocol(java.util.List<java.lang.String> secWebSocketProtocols)` `Sec-WebSocket-Protocol` ヘッダーの（新しい）値を設定します。
`void`	`setSecWebSocketProtocol(java.lang.String secWebSocketProtocol)` `Sec-WebSocket-Protocol` ヘッダーの（新しい）値を設定します。
`void`	`setSecWebSocketVersion(java.lang.String secWebSocketVersion)` `Sec-WebSocket-Version` ヘッダーの（新しい）値を設定します。
`int`	`size()`
`java.util.Map<java.lang.String,java.lang.String>`	`toSingleValueMap()` この `MultiValueMap` に含まれる最初の値を返します。
`java.lang.String`	`toString()`
`java.util.Collection<java.util.List<java.lang.String>>`	`values()`

クラス org.springframework.http.HttpHeaders から継承されたメソッド
addAll, addAll, getAccept, getAcceptCharset, getAcceptLanguage, getAcceptLanguageAsLocales, getAccessControlAllowCredentials, getAccessControlAllowHeaders, getAccessControlAllowMethods, getAccessControlAllowOrigin, getAccessControlExposeHeaders, getAccessControlMaxAge, getAccessControlRequestHeaders, getAccessControlRequestMethod, getAllow, getCacheControl, getConnection, getContentDisposition, getContentLanguage, getContentLength, getContentType, getDate, getETag, getETagValuesAsList, getExpires, getFieldValues, getFirstDate, getFirstZonedDateTime, getHost, getIfMatch, getIfModifiedSince, getIfNoneMatch, getIfUnmodifiedSince, getLastModified, getLocation, getOrigin, getPragma, getRange, getUpgrade, getValuesAsList, getVary, readOnlyHttpHeaders, setAccept, setAcceptCharset, setAcceptLanguage, setAcceptLanguageAsLocales, setAccessControlAllowCredentials, setAccessControlAllowHeaders, setAccessControlAllowMethods, setAccessControlAllowOrigin, setAccessControlExposeHeaders, setAccessControlMaxAge, setAccessControlRequestHeaders, setAccessControlRequestMethod, setAllow, setCacheControl, setCacheControl, setConnection, setConnection, setContentDisposition, setContentDispositionFormData, setContentLanguage, setContentLength, setContentType, setDate, setDate, setETag, setExpires, setExpires, setHost, setIfMatch, setIfMatch, setIfModifiedSince, setIfNoneMatch, setIfNoneMatch, setIfUnmodifiedSince, setLastModified, setLocation, setOrigin, setPragma, setRange, setUpgrade, setVary, setZonedDateTime, toCommaDelimitedString

クラス java.lang.Object から継承されたメソッド
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

インターフェース java.util.Map から継承されたメソッド
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- フィールドの詳細
  - SEC_WEBSOCKET_ACCEPT
```
public static final java.lang.String SEC_WEBSOCKET_ACCEPT
```
    関連事項:
    定数フィールド値
  - SEC_WEBSOCKET_EXTENSIONS
```
public static final java.lang.String SEC_WEBSOCKET_EXTENSIONS
```
    関連事項:
    定数フィールド値
  - SEC_WEBSOCKET_KEY
```
public static final java.lang.String SEC_WEBSOCKET_KEY
```
    関連事項:
    定数フィールド値
  - SEC_WEBSOCKET_PROTOCOL
```
public static final java.lang.String SEC_WEBSOCKET_PROTOCOL
```
    関連事項:
    定数フィールド値
  - SEC_WEBSOCKET_VERSION
```
public static final java.lang.String SEC_WEBSOCKET_VERSION
```
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - WebSocketHttpHeaders
```
public WebSocketHttpHeaders()
```
    新しいインスタンスを作成します。
  - WebSocketHttpHeaders
```
public WebSocketHttpHeaders(HttpHeaders headers)
```
    指定された既存の HttpHeaders をラップするインスタンスを作成し、それにすべての変更を伝播します。
    パラメーター:
    headers - ラップする HTTP ヘッダー
- メソッドの詳細
  - readOnlyWebSocketHttpHeaders
```
public static WebSocketHttpHeaders readOnlyWebSocketHttpHeaders(WebSocketHttpHeaders headers)
```
    読み取りのみが可能で、書き込みはできない WebSocketHttpHeaders オブジェクトを返します。
  - setSecWebSocketAccept
```
public void setSecWebSocketAccept(@Nullable
                                  java.lang.String secWebSocketAccept)
```
    Sec-WebSocket-Accept ヘッダーの（新しい）値を設定します。
    パラメーター:
    secWebSocketAccept - ヘッダーの値
  - getSecWebSocketAccept
```
@Nullable
public java.lang.String getSecWebSocketAccept()
```
    Sec-WebSocket-Accept ヘッダーの値を返します。
    戻り値:
    ヘッダーの値
  - getSecWebSocketExtensions
```
public java.util.List<WebSocketExtension> getSecWebSocketExtensions()
```
    Sec-WebSocket-Extensions ヘッダーの値を返します。
    戻り値:
    ヘッダーの値
  - setSecWebSocketExtensions
```
public void setSecWebSocketExtensions(java.util.List<WebSocketExtension> extensions)
```
    Sec-WebSocket-Extensions ヘッダーの（新しい）値を設定します。
    パラメーター:
    extensions - ヘッダーの値
  - setSecWebSocketKey
```
public void setSecWebSocketKey(@Nullable
                               java.lang.String secWebSocketKey)
```
    Sec-WebSocket-Key ヘッダーの（新しい）値を設定します。
    パラメーター:
    secWebSocketKey - ヘッダーの値
  - getSecWebSocketKey
```
@Nullable
public java.lang.String getSecWebSocketKey()
```
    Sec-WebSocket-Key ヘッダーの値を返します。
    戻り値:
    ヘッダーの値
  - setSecWebSocketProtocol
```
public void setSecWebSocketProtocol(java.lang.String secWebSocketProtocol)
```
    Sec-WebSocket-Protocol ヘッダーの（新しい）値を設定します。
    パラメーター:
    secWebSocketProtocol - ヘッダーの値
  - setSecWebSocketProtocol
```
public void setSecWebSocketProtocol(java.util.List<java.lang.String> secWebSocketProtocols)
```
    Sec-WebSocket-Protocol ヘッダーの（新しい）値を設定します。
    パラメーター:
    secWebSocketProtocols - ヘッダーの値
  - getSecWebSocketProtocol
```
public java.util.List<java.lang.String> getSecWebSocketProtocol()
```
    Sec-WebSocket-Key ヘッダーの値を返します。
    戻り値:
    ヘッダーの値
  - setSecWebSocketVersion
```
public void setSecWebSocketVersion(@Nullable
                                   java.lang.String secWebSocketVersion)
```
    Sec-WebSocket-Version ヘッダーの（新しい）値を設定します。
    パラメーター:
    secWebSocketVersion - ヘッダーの値
  - getSecWebSocketVersion
```
@Nullable
public java.lang.String getSecWebSocketVersion()
```
    Sec-WebSocket-Version ヘッダーの値を返します。
    戻り値:
    ヘッダーの値
  - getFirst
```
@Nullable
public java.lang.String getFirst(java.lang.String headerName)
```
    指定されたヘッダー名の最初のヘッダー値があれば、それを返します。
    次で指定:
    インターフェース MultiValueMap<java.lang.String,java.lang.String> 内の getFirst
    オーバーライド:
    クラス HttpHeaders の getFirst
    パラメーター:
    headerName - ヘッダー名
    戻り値:
    最初のヘッダー値。または null
  - add
```
public void add(java.lang.String headerName,
                @Nullable
                java.lang.String headerValue)
```
    指定された名前に、指定された単一のヘッダー値を追加します。
    次で指定:
    インターフェース MultiValueMap<java.lang.String,java.lang.String> 内の add
    オーバーライド:
    クラス HttpHeaders の add
    パラメーター:
    headerName - ヘッダー名
    headerValue - ヘッダー値
    例外:
    java.lang.UnsupportedOperationException - ヘッダーの追加がサポートされていない場合
    関連事項:
    put(String, List), set(String, String)
  - set
```
public void set(java.lang.String headerName,
                @Nullable
                java.lang.String headerValue)
```
    指定された名前に、指定された単一のヘッダー値を設定します。
    次で指定:
    インターフェース MultiValueMap<java.lang.String,java.lang.String> 内の set
    オーバーライド:
    クラス HttpHeaders の set
    パラメーター:
    headerName - ヘッダー名
    headerValue - ヘッダー値
    例外:
    java.lang.UnsupportedOperationException - ヘッダーの追加がサポートされていない場合
    関連事項:
    put(String, List), add(String, String)
  - setAll
```
public void setAll(java.util.Map<java.lang.String,java.lang.String> values)
```
    インターフェースからコピーされた説明: MultiValueMap
    指定された値を下に設定します。
    次で指定:
    インターフェース MultiValueMap<java.lang.String,java.lang.String> 内の setAll
    オーバーライド:
    クラス HttpHeaders の setAll
    パラメーター:
    values - 値。
  - toSingleValueMap
```
public java.util.Map<java.lang.String,java.lang.String> toSingleValueMap()
```
    インターフェースからコピーされた説明: MultiValueMap
    この MultiValueMap に含まれる最初の値を返します。
    次で指定:
    インターフェース MultiValueMap<java.lang.String,java.lang.String> 内の toSingleValueMap
    オーバーライド:
    クラス HttpHeaders の toSingleValueMap
    戻り値:
    このマップの単一値表現
  - size
```
public int size()
```
    次で指定:
    インターフェース java.util.Map<java.lang.String,java.util.List<java.lang.String>> 内の size
    オーバーライド:
    クラス HttpHeaders の size
  - isEmpty
```
public boolean isEmpty()
```
    次で指定:
    インターフェース java.util.Map<java.lang.String,java.util.List<java.lang.String>> 内の isEmpty
    オーバーライド:
    クラス HttpHeaders の isEmpty
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    次で指定:
    インターフェース java.util.Map<java.lang.String,java.util.List<java.lang.String>> 内の containsKey
    オーバーライド:
    クラス HttpHeaders の containsKey
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    次で指定:
    インターフェース java.util.Map<java.lang.String,java.util.List<java.lang.String>> 内の containsValue
    オーバーライド:
    クラス HttpHeaders の containsValue
  - get
```
public java.util.List<java.lang.String> get(java.lang.Object key)
```
    次で指定:
    インターフェース java.util.Map<java.lang.String,java.util.List<java.lang.String>> 内の get
    オーバーライド:
    クラス HttpHeaders の get
  - put
```
public java.util.List<java.lang.String> put(java.lang.String key,
                                            java.util.List<java.lang.String> value)
```
    次で指定:
    インターフェース java.util.Map<java.lang.String,java.util.List<java.lang.String>> 内の put
    オーバーライド:
    クラス HttpHeaders の put
  - remove
```
public java.util.List<java.lang.String> remove(java.lang.Object key)
```
    次で指定:
    インターフェース java.util.Map<java.lang.String,java.util.List<java.lang.String>> 内の remove
    オーバーライド:
    クラス HttpHeaders の remove
  - putAll
```
public void putAll(java.util.Map<? extends java.lang.String,? extends java.util.List<java.lang.String>> m)
```
    次で指定:
    インターフェース java.util.Map<java.lang.String,java.util.List<java.lang.String>> 内の putAll
    オーバーライド:
    クラス HttpHeaders の putAll
  - clear
```
public void clear()
```
    次で指定:
    インターフェース java.util.Map<java.lang.String,java.util.List<java.lang.String>> 内の clear
    オーバーライド:
    クラス HttpHeaders の clear
  - keySet
```
public java.util.Set<java.lang.String> keySet()
```
    次で指定:
    インターフェース java.util.Map<java.lang.String,java.util.List<java.lang.String>> 内の keySet
    オーバーライド:
    クラス HttpHeaders の keySet
  - values
```
public java.util.Collection<java.util.List<java.lang.String>> values()
```
    次で指定:
    インターフェース java.util.Map<java.lang.String,java.util.List<java.lang.String>> 内の values
    オーバーライド:
    クラス HttpHeaders の values
  - entrySet
```
public java.util.Set<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>> entrySet()
```
    次で指定:
    インターフェース java.util.Map<java.lang.String,java.util.List<java.lang.String>> 内の entrySet
    オーバーライド:
    クラス HttpHeaders の entrySet
  - equals
```
public boolean equals(java.lang.Object other)
```
    次で指定:
    インターフェース java.util.Map<java.lang.String,java.util.List<java.lang.String>> 内の equals
    オーバーライド:
    クラス HttpHeaders の equals
  - hashCode
```
public int hashCode()
```
    次で指定:
    インターフェース java.util.Map<java.lang.String,java.util.List<java.lang.String>> 内の hashCode
    オーバーライド:
    クラス HttpHeaders の hashCode
  - toString
```
public java.lang.String toString()
```
    オーバーライド:
    クラス HttpHeaders の toString

クラス WebSocketHttpHeaders

ネストされたクラスの概要

インターフェース java.util.Map から継承されたネストクラス / インターフェース

フィールド概要

クラス org.springframework.http.HttpHeaders から継承されたフィールド

コンストラクター概要

方法の概要

クラス org.springframework.http.HttpHeaders から継承されたメソッド

クラス java.lang.Object から継承されたメソッド

インターフェース java.util.Map から継承されたメソッド

フィールドの詳細

SEC_WEBSOCKET_ACCEPT

SEC_WEBSOCKET_EXTENSIONS

SEC_WEBSOCKET_KEY

SEC_WEBSOCKET_PROTOCOL

SEC_WEBSOCKET_VERSION

コンストラクターの詳細

WebSocketHttpHeaders

WebSocketHttpHeaders

メソッドの詳細

readOnlyWebSocketHttpHeaders

setSecWebSocketAccept

getSecWebSocketAccept

getSecWebSocketExtensions

setSecWebSocketExtensions

setSecWebSocketKey

getSecWebSocketKey

setSecWebSocketProtocol

setSecWebSocketProtocol

getSecWebSocketProtocol

setSecWebSocketVersion

getSecWebSocketVersion

getFirst

add

set

setAll

toSingleValueMap

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

equals

hashCode

toString