Package org.springframework.web.socket

Class WebSocketHttpHeaders

java.lang.Object

org.springframework.http.HttpHeaders

org.springframework.web.socket.WebSocketHttpHeaders

All Implemented Interfaces:

Serializable, Map<String,List<String>>, MultiValueMap<String,String>

public class WebSocketHttpHeaders
extends HttpHeaders

An HttpHeaders variant that adds support for the HTTP headers defined by the WebSocket specification RFC 6455.

Since:

4.0

Author:

Rossen Stoyanchev

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SEC_WEBSOCKET_ACCEPT
static final String	SEC_WEBSOCKET_EXTENSIONS
static final String	SEC_WEBSOCKET_KEY
static final String	SEC_WEBSOCKET_PROTOCOL
static final String	SEC_WEBSOCKET_VERSION

Fields inherited from class org.springframework.http.HttpHeaders

ACCEPT, ACCEPT_CHARSET, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ACCEPT_PATCH, 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

Constructor Summary

Constructors

Constructor	Description
WebSocketHttpHeaders()	Create a new instance.
WebSocketHttpHeaders(HttpHeaders headers)	Create an instance that wraps the given pre-existing HttpHeaders and also propagate all changes to it.

Method Summary

Modifier and Type	Method	Description
void	add(String headerName, @Nullable String headerValue)	Add the given, single header value under the given name.
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String,List<String>>>	entrySet()	Return a Set views of header entries, reconstructed from iterating over the HttpHeaders.keySet().
boolean	equals(@Nullable Object other)
void	forEach(BiConsumer<? super String,? super List<String>> action)	Perform an action over each header, as when iterated via HttpHeaders.entrySet().
@Nullable List<String>	get(Object key)
@Nullable String	getFirst(String headerName)	Return the first header value for the given header name, if any.
@Nullable String	getSecWebSocketAccept()	Returns the value of the Sec-WebSocket-Accept header.
List<WebSocketExtension>	getSecWebSocketExtensions()	Returns the value of the Sec-WebSocket-Extensions header.
@Nullable String	getSecWebSocketKey()	Returns the value of the Sec-WebSocket-Key header.
List<String>	getSecWebSocketProtocol()	Returns the value of the Sec-WebSocket-Key header.
@Nullable String	getSecWebSocketVersion()	Returns the value of the Sec-WebSocket-Version header.
int	hashCode()
boolean	isEmpty()
Set<String>	keySet()	Return a Set view of header names.
List<String>	put(String key, List<String> value)
void	putAll(Map<? extends String,? extends List<String>> m)
List<String>	putIfAbsent(String key, List<String> value)
List<String>	remove(Object key)
void	set(String headerName, @Nullable String headerValue)	Set the given, single header value under the given name.
void	setAll(Map<String,String> values)	Set the given values under.
void	setSecWebSocketAccept(@Nullable String secWebSocketAccept)	Sets the (new) value of the Sec-WebSocket-Accept header.
void	setSecWebSocketExtensions(List<WebSocketExtension> extensions)	Sets the (new) value(s) of the Sec-WebSocket-Extensions header.
void	setSecWebSocketKey(@Nullable String secWebSocketKey)	Sets the (new) value of the Sec-WebSocket-Key header.
void	setSecWebSocketProtocol(String secWebSocketProtocol)	Sets the (new) value of the Sec-WebSocket-Protocol header.
void	setSecWebSocketProtocol(List<String> secWebSocketProtocols)	Sets the (new) value of the Sec-WebSocket-Protocol header.
void	setSecWebSocketVersion(@Nullable String secWebSocketVersion)	Sets the (new) value of the Sec-WebSocket-Version header.
int	size()	Return the number of headers in the collection.
Map<String,String>	toSingleValueMap()	Return a Map with the first values contained in this MultiValueMap.
String	toString()
Collection<List<String>>	values()	Return a Collection view of all the header values, reconstructed from iterating over the HttpHeaders.keySet().

Methods inherited from class org.springframework.http.HttpHeaders

addAll, addAll, asSingleValueMap, clearContentHeaders, encodeBasicAuth, formatHeaders, getAccept, getAcceptCharset, getAcceptLanguage, getAcceptLanguageAsLocales, getAcceptPatch, 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, getOrEmpty, getOrigin, getPragma, getRange, getUpgrade, getValuesAsList, getVary, headerSet, readOnlyHttpHeaders, readOnlyHttpHeaders, setAccept, setAcceptCharset, setAcceptLanguage, setAcceptLanguageAsLocales, setAcceptPatch, setAccessControlAllowCredentials, setAccessControlAllowHeaders, setAccessControlAllowMethods, setAccessControlAllowOrigin, setAccessControlExposeHeaders, setAccessControlMaxAge, setAccessControlMaxAge, setAccessControlRequestHeaders, setAccessControlRequestMethod, setAllow, setBasicAuth, setBasicAuth, setBasicAuth, setBearerAuth, setCacheControl, setCacheControl, setConnection, setConnection, setContentDisposition, setContentDispositionFormData, setContentLanguage, setContentLength, setContentType, setDate, setDate, setDate, setDate, setETag, setExpires, setExpires, setExpires, setHost, setIfMatch, setIfMatch, setIfModifiedSince, setIfModifiedSince, setIfModifiedSince, setIfNoneMatch, setIfNoneMatch, setIfUnmodifiedSince, setIfUnmodifiedSince, setIfUnmodifiedSince, setInstant, setLastModified, setLastModified, setLastModified, setLocation, setOrigin, setPragma, setRange, setUpgrade, setVary, setZonedDateTime, toCommaDelimitedString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, getOrDefault, merge, remove, replace, replace, replaceAll

Methods inherited from interface org.springframework.util.MultiValueMap

addIfAbsent

Field Details

SEC_WEBSOCKET_ACCEPT

public static final String SEC_WEBSOCKET_ACCEPT

See Also:

• Constant Field Values

SEC_WEBSOCKET_EXTENSIONS

public static final String SEC_WEBSOCKET_EXTENSIONS

See Also:

• Constant Field Values

SEC_WEBSOCKET_KEY

public static final String SEC_WEBSOCKET_KEY

See Also:

• Constant Field Values

SEC_WEBSOCKET_PROTOCOL

public static final String SEC_WEBSOCKET_PROTOCOL

See Also:

• Constant Field Values

SEC_WEBSOCKET_VERSION

public static final String SEC_WEBSOCKET_VERSION

See Also:

• Constant Field Values

Constructor Details

WebSocketHttpHeaders

public WebSocketHttpHeaders()

Create a new instance.

WebSocketHttpHeaders

public WebSocketHttpHeaders(HttpHeaders headers)

Create an instance that wraps the given pre-existing HttpHeaders and also propagate all changes to it.

Parameters:

headers - the HTTP headers to wrap

Method Details

setSecWebSocketAccept

public void setSecWebSocketAccept(@Nullable String secWebSocketAccept)

Sets the (new) value of the Sec-WebSocket-Accept header.

Parameters:

secWebSocketAccept - the value of the header

getSecWebSocketAccept

public @Nullable String getSecWebSocketAccept()

Returns the value of the Sec-WebSocket-Accept header.

Returns:

the value of the header

getSecWebSocketExtensions

public List<WebSocketExtension> getSecWebSocketExtensions()

Returns the value of the Sec-WebSocket-Extensions header.

Returns:

the value of the header

setSecWebSocketExtensions

public void setSecWebSocketExtensions(List<WebSocketExtension> extensions)

Sets the (new) value(s) of the Sec-WebSocket-Extensions header.

Parameters:

extensions - the values for the header

setSecWebSocketKey

public void setSecWebSocketKey(@Nullable String secWebSocketKey)

Sets the (new) value of the Sec-WebSocket-Key header.

Parameters:

secWebSocketKey - the value of the header

getSecWebSocketKey

public @Nullable String getSecWebSocketKey()

Returns the value of the Sec-WebSocket-Key header.

Returns:

the value of the header

setSecWebSocketProtocol

public void setSecWebSocketProtocol(String secWebSocketProtocol)

Sets the (new) value of the Sec-WebSocket-Protocol header.

Parameters:

secWebSocketProtocol - the value of the header

setSecWebSocketProtocol

public void setSecWebSocketProtocol(List<String> secWebSocketProtocols)

Sets the (new) value of the Sec-WebSocket-Protocol header.

Parameters:

secWebSocketProtocols - the value of the header

getSecWebSocketProtocol

public List<String> getSecWebSocketProtocol()

Returns the value of the Sec-WebSocket-Key header.

Returns:

the value of the header

setSecWebSocketVersion

public void setSecWebSocketVersion(@Nullable String secWebSocketVersion)

Sets the (new) value of the Sec-WebSocket-Version header.

Parameters:

secWebSocketVersion - the value of the header

getSecWebSocketVersion

public @Nullable String getSecWebSocketVersion()

Returns the value of the Sec-WebSocket-Version header.

Returns:

the value of the header

getFirst

public @Nullable String getFirst(String headerName)

Return the first header value for the given header name, if any.

Specified by:

getFirst in interface MultiValueMap<String,String>

Overrides:

getFirst in class HttpHeaders

Parameters:

headerName - the header name

Returns:

the first header value; or null

add

public void add(String headerName,
 @Nullable String headerValue)

Add the given, single header value under the given name.

Specified by:

add in interface MultiValueMap<String,String>

Overrides:

add in class HttpHeaders

Parameters:

headerName - the header name

headerValue - the header value

Throws:

UnsupportedOperationException - if adding headers is not supported

See Also:

• put(String, List)
• set(String, String)

set

public void set(String headerName,
 @Nullable String headerValue)

Set the given, single header value under the given name.

Specified by:

set in interface MultiValueMap<String,String>

Overrides:

set in class HttpHeaders

Parameters:

headerName - the header name

headerValue - the header value

Throws:

UnsupportedOperationException - if adding headers is not supported

See Also:

• put(String, List)
• add(String, String)

setAll

public void setAll(Map<String,String> values)

Description copied from interface: MultiValueMap

Set the given values under.

Specified by:

setAll in interface MultiValueMap<String,String>

Overrides:

setAll in class HttpHeaders

Parameters:

values - the values.

toSingleValueMap

public Map<String,String> toSingleValueMap()

Description copied from interface: MultiValueMap

Return a Map with the first values contained in this MultiValueMap. The difference between this method and MultiValueMap.asSingleValueMap() is that this method returns a copy of the entries of this map, whereas the latter returns a view.

Specified by:

toSingleValueMap in interface MultiValueMap<String,String>

Overrides:

toSingleValueMap in class HttpHeaders

Returns:

a single value representation of this map

size

public int size()

Description copied from class: HttpHeaders

Return the number of headers in the collection. This can be inflated, see class level javadoc.

Specified by:

size in interface Map<String,List<String>>

Overrides:

size in class HttpHeaders

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,List<String>>

Overrides:

isEmpty in class HttpHeaders

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,List<String>>

Overrides:

containsKey in class HttpHeaders

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,List<String>>

Overrides:

containsValue in class HttpHeaders

get

public @Nullable List<String> get(Object key)

Specified by:

get in interface Map<String,List<String>>

Overrides:

get in class HttpHeaders

put

public List<String> put(String key,
 List<String> value)

Specified by:

put in interface Map<String,List<String>>

Overrides:

put in class HttpHeaders

remove

public List<String> remove(Object key)

Specified by:

remove in interface Map<String,List<String>>

Overrides:

remove in class HttpHeaders

putAll

public void putAll(Map<? extends String,? extends List<String>> m)

Specified by:

putAll in interface Map<String,List<String>>

Overrides:

putAll in class HttpHeaders

clear

public void clear()

Specified by:

clear in interface Map<String,List<String>>

Overrides:

clear in class HttpHeaders

keySet

public Set<String> keySet()

Description copied from class: HttpHeaders

Return a Set view of header names. This can include multiple casing variants of a given header name, see class level javadoc.

Specified by:

keySet in interface Map<String,List<String>>

Overrides:

keySet in class HttpHeaders

values

public Collection<List<String>> values()

Description copied from class: HttpHeaders

Return a Collection view of all the header values, reconstructed from iterating over the HttpHeaders.keySet(). This can include duplicates if multiple casing variants of a given header name are tracked, see class level javadoc.

Specified by:

values in interface Map<String,List<String>>

Overrides:

values in class HttpHeaders

entrySet

public Set<Map.Entry<String,List<String>>> entrySet()

Description copied from class: HttpHeaders

Return a Set views of header entries, reconstructed from iterating over the HttpHeaders.keySet(). This can include duplicate entries if multiple casing variants of a given header name are tracked, see class level javadoc.

Specified by:

entrySet in interface Map<String,List<String>>

Overrides:

entrySet in class HttpHeaders

See Also:

• HttpHeaders.headerSet()

forEach

public void forEach(BiConsumer<? super String,? super List<String>> action)

Description copied from class: HttpHeaders

Perform an action over each header, as when iterated via HttpHeaders.entrySet(). This can include duplicate entries if multiple casing variants of a given header name are tracked, see class level javadoc.

Specified by:

forEach in interface Map<String,List<String>>

Overrides:

forEach in class HttpHeaders

Parameters:

action - the action to be performed for each entry

putIfAbsent

public List<String> putIfAbsent(String key,
 List<String> value)

Specified by:

putIfAbsent in interface Map<String,List<String>>

Overrides:

putIfAbsent in class HttpHeaders

equals

public boolean equals(@Nullable Object other)

Specified by:

equals in interface Map<String,List<String>>

Overrides:

equals in class HttpHeaders

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,List<String>>

Overrides:

hashCode in class HttpHeaders

toString

public String toString()

Overrides:

toString in class HttpHeaders