org.springframework.web.socket

Class WebSocketHttpHeaders

java.lang.Object

org.springframework.http.HttpHeaders

org.springframework.web.socket.WebSocketHttpHeaders

All Implemented Interfaces:

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

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

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
private HttpHeaders	headers
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
private static long	serialVersionUID

Fields inherited from class 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, 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

Modifier	Constructor and 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.
private	WebSocketHttpHeaders(HttpHeaders headers, boolean readOnly) Private constructor that can create read-only WebSocketHttpHeader instances.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String headerName, java.lang.String headerValue) Add the given, single header value under the given name.
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) Return the first header value for the given header name, if any.
java.lang.String	getSecWebSocketAccept() Returns the value of the Sec-WebSocket-Accept header.
java.util.List<WebSocketExtension>	getSecWebSocketExtensions() Returns the value of the Sec-WebSocket-Extensions header.
java.lang.String	getSecWebSocketKey() Returns the value of the Sec-WebSocket-Key header.
java.util.List<java.lang.String>	getSecWebSocketProtocol() Returns the value of the Sec-WebSocket-Key header.
java.lang.String	getSecWebSocketVersion() Returns the value of the Sec-WebSocket-Version header.
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) Returns WebSocketHttpHeaders object that can only be read, not written to.
java.util.List<java.lang.String>	remove(java.lang.Object key)
void	set(java.lang.String headerName, java.lang.String headerValue) Set the given, single header value under the given name.
void	setAll(java.util.Map<java.lang.String,java.lang.String> values) Set the given values under.
void	setSecWebSocketAccept(java.lang.String secWebSocketAccept) Sets the (new) value of the Sec-WebSocket-Accept header.
void	setSecWebSocketExtensions(java.util.List<WebSocketExtension> extensions) Sets the (new) value(s) of the Sec-WebSocket-Extensions header.
void	setSecWebSocketKey(java.lang.String secWebSocketKey) Sets the (new) value of the Sec-WebSocket-Key header.
void	setSecWebSocketProtocol(java.util.List<java.lang.String> secWebSocketProtocols) Sets the (new) value of the Sec-WebSocket-Protocol header.
void	setSecWebSocketProtocol(java.lang.String secWebSocketProtocol) Sets the (new) value of the Sec-WebSocket-Protocol header.
void	setSecWebSocketVersion(java.lang.String secWebSocketVersion) Sets the (new) value of the Sec-WebSocket-Version header.
int	size()
java.util.Map<java.lang.String,java.lang.String>	toSingleValueMap() Returns the first values contained in this MultiValueMap.
java.lang.String	toString()
java.util.Collection<java.util.List<java.lang.String>>	values()

Methods inherited from class org.springframework.http.HttpHeaders

getAccept, getAcceptCharset, getAccessControlAllowCredentials, getAccessControlAllowHeaders, getAccessControlAllowMethods, getAccessControlAllowOrigin, getAccessControlExposeHeaders, getAccessControlMaxAge, getAccessControlRequestHeaders, getAccessControlRequestMethod, getAllow, getCacheControl, getConnection, getContentLength, getContentType, getDate, getETag, getExpires, getFirstDate, getFirstValueAsList, getIfModifiedSince, getIfNoneMatch, getLastModified, getLocation, getOrigin, getPragma, getRange, getUpgrade, readOnlyHttpHeaders, setAccept, setAcceptCharset, setAccessControlAllowCredentials, setAccessControlAllowHeaders, setAccessControlAllowMethods, setAccessControlAllowOrigin, setAccessControlExposeHeaders, setAccessControlMaxAge, setAccessControlRequestHeaders, setAccessControlRequestMethod, setAllow, setCacheControl, setConnection, setConnection, setContentDispositionFormData, setContentLength, setContentType, setDate, setDate, setETag, setExpires, setIfModifiedSince, setIfNoneMatch, setIfNoneMatch, setLastModified, setLocation, setOrigin, setPragma, setRange, setUpgrade, 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, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

SEC_WEBSOCKET_ACCEPT

public static final java.lang.String SEC_WEBSOCKET_ACCEPT

See Also:

Constant Field Values

SEC_WEBSOCKET_EXTENSIONS

public static final java.lang.String SEC_WEBSOCKET_EXTENSIONS

See Also:

Constant Field Values

SEC_WEBSOCKET_KEY

public static final java.lang.String SEC_WEBSOCKET_KEY

See Also:

Constant Field Values

SEC_WEBSOCKET_PROTOCOL

public static final java.lang.String SEC_WEBSOCKET_PROTOCOL

See Also:

Constant Field Values

SEC_WEBSOCKET_VERSION

public static final java.lang.String SEC_WEBSOCKET_VERSION

See Also:

Constant Field Values

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

headers

private final HttpHeaders headers

Constructor Detail

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

WebSocketHttpHeaders

private WebSocketHttpHeaders(HttpHeaders headers,
                             boolean readOnly)

Private constructor that can create read-only WebSocketHttpHeader instances.

Method Detail

readOnlyWebSocketHttpHeaders

public static WebSocketHttpHeaders readOnlyWebSocketHttpHeaders(WebSocketHttpHeaders headers)

Returns WebSocketHttpHeaders object that can only be read, not written to.

setSecWebSocketAccept

public void setSecWebSocketAccept(java.lang.String secWebSocketAccept)

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

Parameters:

secWebSocketAccept - the value of the header

getSecWebSocketAccept

public java.lang.String getSecWebSocketAccept()

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

Returns:

the value of the header

getSecWebSocketExtensions

public java.util.List<WebSocketExtension> getSecWebSocketExtensions()

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

Returns:

the value of the header

setSecWebSocketExtensions

public void setSecWebSocketExtensions(java.util.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(java.lang.String secWebSocketKey)

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

Parameters:

secWebSocketKey - the value of the header

getSecWebSocketKey

public java.lang.String getSecWebSocketKey()

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

Returns:

the value of the header

setSecWebSocketProtocol

public void setSecWebSocketProtocol(java.lang.String secWebSocketProtocol)

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

Parameters:

secWebSocketProtocol - the value of the header

setSecWebSocketProtocol

public void setSecWebSocketProtocol(java.util.List<java.lang.String> secWebSocketProtocols)

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

Parameters:

secWebSocketProtocols - the value of the header

getSecWebSocketProtocol

public java.util.List<java.lang.String> getSecWebSocketProtocol()

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

Returns:

the value of the header

setSecWebSocketVersion

public void setSecWebSocketVersion(java.lang.String secWebSocketVersion)

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

Parameters:

secWebSocketVersion - the value of the header

getSecWebSocketVersion

public java.lang.String getSecWebSocketVersion()

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

Returns:

the value of the header

getFirst

public java.lang.String getFirst(java.lang.String headerName)

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

Specified by:

getFirst in interface MultiValueMap<java.lang.String,java.lang.String>

Overrides:

getFirst in class HttpHeaders

Parameters:

headerName - the header name

Returns:

the first header value; or null

add

public void add(java.lang.String headerName,
                java.lang.String headerValue)

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

Specified by:

add in interface MultiValueMap<java.lang.String,java.lang.String>

Overrides:

add in class HttpHeaders

Parameters:

headerName - the header name

headerValue - the header value

Throws:

java.lang.UnsupportedOperationException - if adding headers is not supported

See Also:

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

set

public void set(java.lang.String headerName,
                java.lang.String headerValue)

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

Specified by:

set in interface MultiValueMap<java.lang.String,java.lang.String>

Overrides:

set in class HttpHeaders

Parameters:

headerName - the header name

headerValue - the header value

Throws:

java.lang.UnsupportedOperationException - if adding headers is not supported

See Also:

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

setAll

public void setAll(java.util.Map<java.lang.String,java.lang.String> values)

Description copied from interface: MultiValueMap

Set the given values under.

Specified by:

setAll in interface MultiValueMap<java.lang.String,java.lang.String>

Overrides:

setAll in class HttpHeaders

Parameters:

values - the values.

toSingleValueMap

public java.util.Map<java.lang.String,java.lang.String> toSingleValueMap()

Description copied from interface: MultiValueMap

Returns the first values contained in this MultiValueMap.

Specified by:

toSingleValueMap in interface MultiValueMap<java.lang.String,java.lang.String>

Overrides:

toSingleValueMap in class HttpHeaders

Returns:

a single value representation of this map

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

Overrides:

size in class HttpHeaders

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

Overrides:

isEmpty in class HttpHeaders

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

Overrides:

containsKey in class HttpHeaders

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

Overrides:

containsValue in class HttpHeaders

get

public java.util.List<java.lang.String> get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

Overrides:

get in class HttpHeaders

put

public java.util.List<java.lang.String> put(java.lang.String key,
                                            java.util.List<java.lang.String> value)

Specified by:

put in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

Overrides:

put in class HttpHeaders

remove

public java.util.List<java.lang.String> remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

Overrides:

remove in class HttpHeaders

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.util.List<java.lang.String>> m)

Specified by:

putAll in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

Overrides:

putAll in class HttpHeaders

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

Overrides:

clear in class HttpHeaders

keySet

public java.util.Set<java.lang.String> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

Overrides:

keySet in class HttpHeaders

values

public java.util.Collection<java.util.List<java.lang.String>> values()

Specified by:

values in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

Overrides:

values in class HttpHeaders

entrySet

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

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

Overrides:

entrySet in class HttpHeaders

equals

public boolean equals(java.lang.Object other)

Specified by:

equals in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

Overrides:

equals in class HttpHeaders

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<java.lang.String,java.util.List<java.lang.String>>

Overrides:

hashCode in class HttpHeaders

toString

public java.lang.String toString()

Overrides:

toString in class HttpHeaders