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, 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(Object other)
void	forEach(BiConsumer<? super String,? super List<String>> action)	Perform an action over each header, as when iterated via HttpHeaders.entrySet().
List<String>	get(Object key)
String	getFirst(String headerName)	Return the first header value for the given header name, if any.
String	getSecWebSocketAccept()	Returns the value of the Sec-WebSocket-Accept header.
List<WebSocketExtension>	getSecWebSocketExtensions()	Returns the value of the Sec-WebSocket-Extensions header.
String	getSecWebSocketKey()	Returns the value of the Sec-WebSocket-Key header.
List<String>	getSecWebSocketProtocol()	Returns the value of the Sec-WebSocket-Key header.
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, 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(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(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(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, 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,