org.springframework.http

Class ReadOnlyHttpHeaders

java.lang.Object

org.springframework.http.HttpHeaders

org.springframework.http.ReadOnlyHttpHeaders

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>

class ReadOnlyHttpHeaders
extends HttpHeaders

HttpHeaders object that can only be read, not written to.

Since:

5.1.1

Author:

Brian Clozel

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 java.util.List<MediaType>	cachedAccept
private MediaType	cachedContentType
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, EMPTY, ETAG, EXPECT, EXPIRES, FROM, headers, 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 and Description
ReadOnlyHttpHeaders(HttpHeaders headers)

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	addAll(MultiValueMap<java.lang.String,java.lang.String> values) Add all the values of the given MultiValueMap to the current values.
void	addAll(java.lang.String key, java.util.List<? extends java.lang.String> values) Add all the values of the given list to the current list of values for the given key.
void	clear()
java.util.Set<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>>	entrySet()
java.util.List<java.lang.String>	get(java.lang.Object key)
java.util.List<MediaType>	getAccept() Return the list of acceptable media types, as specified by the Accept header.
MediaType	getContentType() Return the media type of the body, as specified by the Content-Type header.
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>> map)
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.
java.util.Map<java.lang.String,java.lang.String>	toSingleValueMap() Return a Map with the first values contained in this MultiValueMap.
java.util.Collection<java.util.List<java.lang.String>>	values()

Methods inherited from class org.springframework.http.HttpHeaders

containsKey, containsValue, equals, formatDate, formatHeaders, getAcceptCharset, getAcceptLanguage, getAcceptLanguageAsLocales, getAccessControlAllowCredentials, getAccessControlAllowHeaders, getAccessControlAllowMethods, getAccessControlAllowOrigin, getAccessControlExposeHeaders, getAccessControlMaxAge, getAccessControlRequestHeaders, getAccessControlRequestMethod, getAllow, getCacheControl, getConnection, getContentDisposition, getContentLanguage, getContentLength, getDate, getETag, getETagValuesAsList, getExpires, getFieldValues, getFirst, getFirstDate, getFirstZonedDateTime, getHost, getIfMatch, getIfModifiedSince, getIfNoneMatch, getIfUnmodifiedSince, getLastModified, getLocation, getOrigin, getPragma, getRange, getUpgrade, getValuesAsList, getVary, hashCode, isEmpty, readOnlyHttpHeaders, setAccept, setAcceptCharset, setAcceptLanguage, setAcceptLanguageAsLocales, setAccessControlAllowCredentials, setAccessControlAllowHeaders, setAccessControlAllowMethods, setAccessControlAllowOrigin, setAccessControlExposeHeaders, setAccessControlMaxAge, setAccessControlMaxAge, setAccessControlRequestHeaders, setAccessControlRequestMethod, setAllow, 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, size, toCommaDelimitedString, toString, writableHttpHeaders

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

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

cachedContentType

@Nullable
private MediaType cachedContentType

cachedAccept

@Nullable
private java.util.List<MediaType> cachedAccept

Constructor Detail

ReadOnlyHttpHeaders

ReadOnlyHttpHeaders(HttpHeaders headers)

Method Detail

getContentType

public MediaType getContentType()

Description copied from class: HttpHeaders

Return the media type of the body, as specified by the Content-Type header.

Returns null when the content-type is unknown.

Overrides:

getContentType in class HttpHeaders

getAccept

public java.util.List<MediaType> getAccept()

Description copied from class: HttpHeaders

Return the list of acceptable media types, as specified by the Accept header.

Returns an empty list when the acceptable media types are unspecified.

Overrides:

getAccept 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

add

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

Description copied from class: HttpHeaders

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

See Also:

HttpHeaders.put(String, List), HttpHeaders.set(String, String)

addAll

public void addAll(java.lang.String key,
                   java.util.List<? extends java.lang.String> values)

Description copied from interface: MultiValueMap

Add all the values of the given list to the current list of values for the given key.

Specified by:

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

Overrides:

addAll in class HttpHeaders

Parameters:

key - they key

values - the values to be added

addAll

public void addAll(MultiValueMap<java.lang.String,java.lang.String> values)

Description copied from interface: MultiValueMap

Add all the values of the given MultiValueMap to the current values.

Specified by:

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

Overrides:

addAll in class HttpHeaders

Parameters:

values - the values to be added

set

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

Description copied from class: HttpHeaders

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

See Also:

HttpHeaders.put(String, List), HttpHeaders.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

Return a Map with 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

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

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>> map)

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

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