org.springframework.http
Class HttpHeaders

java.lang.Object
  org.springframework.http.HttpHeaders

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 HttpHeaders
extends java.lang.Object
implements MultiValueMap<java.lang.String,java.lang.String>, java.io.Serializable

Represents HTTP request and response headers, mapping string header names to list of string values.

In addition to the normal methods defined by Map, this class offers the following convenience methods:

• getFirst(String) returns the first value associated with a given header name
• add(String, String) adds a header value to the list of values for a header name
• set(String, String) sets the header value to a single string value

Inspired by com.sun.net.httpserver.Headers.

Since:

1.0

Author:

Arjen Poutsma, Roy Clarkson, Sebastien Deleuze

See Also:

Serialized Form

Nested Class Summary

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

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

Field Summary

static java.lang.String	ACCEPT The HTTP Accept header field name.
static java.lang.String	ACCEPT_CHARSET The HTTP Accept-Charset header field name.
static java.lang.String	ACCEPT_ENCODING The HTTP Accept-Encoding header field name.
static java.lang.String	ACCEPT_LANGUAGE The HTTP Accept-Language header field name.
static java.lang.String	ACCEPT_RANGES The HTTP Accept-Ranges header field name.
static java.lang.String	AGE The HTTP Age header field name.
static java.lang.String	ALLOW The HTTP Allow header field name.
static java.lang.String	AUTHORIZATION The HTTP Authorization header field name.
static java.lang.String	CACHE_CONTROL The HTTP Cache-Control header field name.
static java.lang.String	CONNECTION The HTTP Connection header field name.
static java.lang.String	CONTENT_DISPOSITION The HTTP Content-Disposition header field name
static java.lang.String	CONTENT_ENCODING The HTTP Content-Encoding header field name.
static java.lang.String	CONTENT_LANGUAGE The HTTP Content-Language header field name.
static java.lang.String	CONTENT_LENGTH The HTTP Content-Length header field name.
static java.lang.String	CONTENT_LOCATION The HTTP Content-Location header field name.
static java.lang.String	CONTENT_RANGE The HTTP Content-Range header field name.
static java.lang.String	CONTENT_TYPE The HTTP Content-Type header field name.
static java.lang.String	COOKIE The HTTP Cookie header field name.
static java.lang.String	DATE The HTTP Date header field name.
static java.lang.String	ETAG The HTTP ETag header field name.
static java.lang.String	EXPECT The HTTP Expect header field name.
static java.lang.String	EXPIRES The HTTP Expires header field name.
static java.lang.String	FROM The HTTP From header field name.
static java.lang.String	HOST The HTTP Host header field name.
static java.lang.String	IF_MATCH The HTTP If-Match header field name.
static java.lang.String	IF_MODIFIED_SINCE The HTTP If-Modified-Since header field name.
static java.lang.String	IF_NONE_MATCH The HTTP If-None-Match header field name.
static java.lang.String	IF_RANGE The HTTP If-Range header field name.
static java.lang.String	IF_UNMODIFIED_SINCE The HTTP If-Unmodified-Since header field name.
static java.lang.String	LAST_MODIFIED The HTTP Last-Modified header field name.
static java.lang.String	LINK The HTTP Link header field name.
static java.lang.String	LOCATION The HTTP Location header field name.
static java.lang.String	MAX_FORWARDS The HTTP Max-Forwards header field name.
static java.lang.String	ORIGIN The HTTP Origin header field name.
static java.lang.String	PRAGMA The HTTP Pragma header field name.
static java.lang.String	PROXY_AUTHENTICATE The HTTP Proxy-Authenticate header field name.
static java.lang.String	PROXY_AUTHORIZATION The HTTP Proxy-Authorization header field name.
static java.lang.String	RANGE The HTTP Range header field name.
static java.lang.String	REFERER The HTTP Referer header field name.
static java.lang.String	RETRY_AFTER The HTTP Retry-After header field name.
static java.lang.String	SERVER The HTTP Server header field name.
static java.lang.String	SET_COOKIE The HTTP Set-Cookie header field name.
static java.lang.String	SET_COOKIE2 The HTTP Set-Cookie2 header field name.
static java.lang.String	TE The HTTP TE header field name.
static java.lang.String	TRAILER The HTTP Trailer header field name.
static java.lang.String	TRANSFER_ENCODING The HTTP Transfer-Encoding header field name.
static java.lang.String	UPGRADE The HTTP Upgrade header field name.
static java.lang.String	USER_AGENT The HTTP User-Agent header field name.
static java.lang.String	VARY The HTTP Vary header field name.
static java.lang.String	VIA The HTTP Via header field name.
static java.lang.String	WARNING The HTTP Warning header field name.
static java.lang.String	WWW_AUTHENTICATE The HTTP WWW-Authenticate header field name.

Constructor Summary

HttpHeaders()
Constructs a new, empty instance of the HttpHeaders object.

Method Summary

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.util.List<MediaType>	getAccept() Return the list of acceptable media types, as specified by the Accept header.
java.util.List<java.nio.charset.Charset>	getAcceptCharset() Return the list of acceptable charsets, as specified by the Accept-Charset header.
java.util.List<ContentCodingType>	getAcceptEncoding() Return the list of acceptable coding types, as specified by the Accept-Encoding header.
java.lang.String	getAcceptLanguage() Return the accept language, as specified by the Accept-Language header.
java.util.Set<HttpMethod>	getAllow() Return the set of allowed HTTP methods, as specified by the Allow header.
java.lang.String	getAuthorization() Returns the value of the Authorization header.
java.lang.String	getCacheControl() Returns the value of the Cache-Control header.
java.util.List<java.lang.String>	getConnection() Returns the value of the Connection header.
java.util.List<ContentCodingType>	getContentEncoding() Return the list of content coding types, as specified by the Content-Encoding header.
long	getContentLength() Return the length of the body in bytes, as specified by the Content-Length header.
MediaType	getContentType() Return the media type of the body, as specified by the Content-Type header.
long	getDate() Return the date and time at which the message was created, as specified by the Date header.
java.lang.String	getETag() Return the entity tag of the body, as specified by the ETag header.
long	getExpires() Return the date and time at which the message is no longer valid, as specified by the Expires header.
java.lang.String	getFirst(java.lang.String headerName) Return the first header value for the given header name, if any.
long	getFirstDate(java.lang.String headerName) Parse the first header value for the given header name as a date, return -1 if there is no value, or raise IllegalArgumentException if the value cannot be parsed as a date.
protected java.util.List<java.lang.String>	getFirstValueAsList(java.lang.String header)
long	getIfModifiedSince() Return the value of the If-Modified-Since header.
java.util.List<java.lang.String>	getIfNoneMatch() Return the value of the If-None-Match header.
long	getIfNotModifiedSince() Deprecated. use getIfModifiedSince()
long	getLastModified() Return the time the resource was last changed, as specified by the Last-Modified header.
java.net.URI	getLocation() Return the (new) location of a resource as specified by the Location header.
java.lang.String	getOrigin() Return the value of the Origin header.
java.lang.String	getPragma() Return the value of the Pragma header.
java.lang.String	getUpgrade() Returns the value of the Upgrade header.
java.lang.String	getUserAgent() Returns the value of the User-Agent 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>> map)
static HttpHeaders	readOnlyHttpHeaders(HttpHeaders headers) Return a HttpHeaders 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	setAccept(java.util.List<MediaType> acceptableMediaTypes) Set the list of acceptable media types, as specified by the Accept header.
void	setAcceptCharset(java.util.List<java.nio.charset.Charset> acceptableCharsets) Set the list of acceptable charsets, as specified by the Accept-Charset header.
void	setAcceptEncoding(ContentCodingType acceptableEncodingType) Set the acceptable coding type, as specified by the Accept-Encoding header.
void	setAcceptEncoding(java.util.List<ContentCodingType> acceptableEncodingTypes) Set the list of acceptable coding types, as specified by the Accept-Encoding header.
void	setAcceptLanguage(java.lang.String acceptLanguage) Set the accept language, as specified by the Accept-Language header.
void	setAll(java.util.Map<java.lang.String,java.lang.String> values) Set the given values under.
void	setAllow(java.util.Set<HttpMethod> allowedMethods) Set the set of allowed HTTP methods, as specified by the Allow header.
void	setAuthorization(HttpAuthentication httpAuthentication) Sets a value for the Authorization header.
void	setCacheControl(java.lang.String cacheControl) Set the (new) value of the Cache-Control header.
void	setConnection(java.util.List<java.lang.String> connection) Set the (new) value of the Connection header.
void	setConnection(java.lang.String connection) Set the (new) value of the Connection header.
void	setContentDispositionFormData(java.lang.String name, java.lang.String filename) Set the (new) value of the Content-Disposition header for form-data.
void	setContentEncoding(ContentCodingType contentEncodingType) Set the content coding type, as specified by the Content-Encoding header.
void	setContentEncoding(java.util.List<ContentCodingType> contentEncodingTypes) Set the list of content coding types, as specified by the Content-Encoding header.
void	setContentLength(long contentLength) Set the length of the body in bytes, as specified by the Content-Length header.
void	setContentType(MediaType mediaType) Set the media type of the body, as specified by the Content-Type header.
void	setDate(long date) Set the date and time at which the message was created, as specified by the Date header.
void	setDate(java.lang.String headerName, long date) Set the given date under the given header name after formatting it as a string using the pattern "EEE, dd MMM yyyy HH:mm:ss zzz".
void	setETag(java.lang.String eTag) Set the (new) entity tag of the body, as specified by the ETag header.
void	setExpires(long expires) Set the date and time at which the message is no longer valid, as specified by the Expires header.
void	setIfModifiedSince(long ifModifiedSince) Set the (new) value of the If-Modified-Since header.
void	setIfNoneMatch(java.util.List<java.lang.String> ifNoneMatchList) Set the (new) values of the If-None-Match header.
void	setIfNoneMatch(java.lang.String ifNoneMatch) Set the (new) value of the If-None-Match header.
void	setLastModified(long lastModified) Set the time the resource was last changed, as specified by the Last-Modified header.
void	setLocation(java.net.URI location) Set the (new) location of a resource, as specified by the Location header.
void	setOrigin(java.lang.String origin) Set the (new) value of the Origin header.
void	setPragma(java.lang.String pragma) Set the (new) value of the Pragma header.
void	setUpgrade(java.lang.String upgrade) Set the (new) value of the Upgrade header.
void	setUserAgent(java.lang.String userAgent) Set the (new) value of the User-Agent header.
int	size()
protected java.lang.String	toCommaDelimitedString(java.util.List<java.lang.String> list)
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 java.lang.Object

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

Field Detail

ACCEPT

public static final java.lang.String ACCEPT

The HTTP Accept header field name.

See Also:

Section 5.3.2 of RFC 7231, Constant Field Values

ACCEPT_CHARSET

public static final java.lang.String ACCEPT_CHARSET

The HTTP Accept-Charset header field name.

See Also:

Section 5.3.3 of RFC 7231, Constant Field Values

ACCEPT_ENCODING

public static final java.lang.String ACCEPT_ENCODING

The HTTP Accept-Encoding header field name.

See Also:

Section 5.3.4 of RFC 7231, Constant Field Values

ACCEPT_LANGUAGE

public static final java.lang.String ACCEPT_LANGUAGE

The HTTP Accept-Language header field name.

See Also:

Section 5.3.5 of RFC 7231, Constant Field Values

ACCEPT_RANGES

public static final java.lang.String ACCEPT_RANGES

The HTTP Accept-Ranges header field name.

See Also:

Section 5.3.5 of RFC 7233, Constant Field Values

AGE

public static final java.lang.String AGE

The HTTP Age header field name.

See Also:

Section 5.1 of RFC 7234, Constant Field Values

ALLOW

public static final java.lang.String ALLOW

The HTTP Allow header field name.

See Also:

Section 7.4.1 of RFC 7231, Constant Field Values

AUTHORIZATION

public static final java.lang.String AUTHORIZATION

The HTTP Authorization header field name.

See Also:

Section 4.2 of RFC 7235, Constant Field Values

CACHE_CONTROL

public static final java.lang.String CACHE_CONTROL

The HTTP Cache-Control header field name.

See Also:

Section 5.2 of RFC 7234, Constant Field Values

CONNECTION

public static final java.lang.String CONNECTION

The HTTP Connection header field name.

See Also:

Section 6.1 of RFC 7230, Constant Field Values

CONTENT_ENCODING

public static final java.lang.String CONTENT_ENCODING

The HTTP Content-Encoding header field name.

See Also:

Section 3.1.2.2 of RFC 7231, Constant Field Values

CONTENT_DISPOSITION

public static final java.lang.String CONTENT_DISPOSITION

The HTTP Content-Disposition header field name

See Also:

RFC 6266, Constant Field Values

CONTENT_LANGUAGE

public static final java.lang.String CONTENT_LANGUAGE

The HTTP Content-Language header field name.

See Also:

Section 3.1.3.2 of RFC 7231, Constant Field Values

CONTENT_LENGTH

public static final java.lang.String CONTENT_LENGTH

The HTTP Content-Length header field name.

See Also:

Section 3.3.2 of RFC 7230, Constant Field Values

CONTENT_LOCATION

public static final java.lang.String CONTENT_LOCATION

The HTTP Content-Location header field name.

See Also:

Section 3.1.4.2 of RFC 7231, Constant Field Values

CONTENT_RANGE

public static final java.lang.String CONTENT_RANGE

The HTTP Content-Range header field name.

See Also:

Section 4.2 of RFC 7233, Constant Field Values

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

The HTTP Content-Type header field name.

See Also:

Section 3.1.1.5 of RFC 7231, Constant Field Values

COOKIE

public static final java.lang.String COOKIE

The HTTP Cookie header field name.

See Also:

Section 4.3.4 of RFC 2109, Constant Field Values

DATE

public static final java.lang.String DATE

The HTTP Date header field name.

See Also:

Section 7.1.1.2 of RFC 7231, Constant Field Values

ETAG

public static final java.lang.String ETAG

The HTTP ETag header field name.

See Also:

Section 2.3 of RFC 7232, Constant Field Values

EXPECT

public static final java.lang.String EXPECT

The HTTP Expect header field name.

See Also:

Section 5.1.1 of RFC 7231, Constant Field Values

EXPIRES

public static final java.lang.String EXPIRES

The HTTP Expires header field name.

See Also:

Section 5.3 of RFC 7234, Constant Field Values

FROM

public static final java.lang.String FROM

The HTTP From header field name.

See Also:

Section 5.5.1 of RFC 7231, Constant Field Values

HOST

public static final java.lang.String HOST

The HTTP Host header field name.

See Also:

Section 5.4 of RFC 7230, Constant Field Values

IF_MATCH

public static final java.lang.String IF_MATCH

The HTTP If-Match header field name.

See Also:

Section 3.1 of RFC 7232, Constant Field Values

IF_MODIFIED_SINCE

public static final java.lang.String IF_MODIFIED_SINCE

The HTTP If-Modified-Since header field name.

See Also:

Section 3.3 of RFC 7232, Constant Field Values

IF_NONE_MATCH

public static final java.lang.String IF_NONE_MATCH

The HTTP If-None-Match header field name.

See Also:

Section 3.2 of RFC 7232, Constant Field Values

IF_RANGE

public static final java.lang.String IF_RANGE

The HTTP If-Range header field name.

See Also:

Section 3.2 of RFC 7233, Constant Field Values

IF_UNMODIFIED_SINCE

public static final java.lang.String IF_UNMODIFIED_SINCE

The HTTP If-Unmodified-Since header field name.

See Also:

Section 3.4 of RFC 7232, Constant Field Values

LAST_MODIFIED

public static final java.lang.String LAST_MODIFIED

The HTTP Last-Modified header field name.

See Also:

Section 2.2 of RFC 7232, Constant Field Values

LINK

public static final java.lang.String LINK

The HTTP Link header field name.

See Also:

RFC 5988, Constant Field Values

LOCATION

public static final java.lang.String LOCATION

The HTTP Location header field name.

See Also:

Section 7.1.2 of RFC 7231, Constant Field Values

MAX_FORWARDS

public static final java.lang.String MAX_FORWARDS

The HTTP Max-Forwards header field name.

See Also:

Section 5.1.2 of RFC 7231, Constant Field Values

ORIGIN

public static final java.lang.String ORIGIN

The HTTP Origin header field name.

See Also:

RFC 6454, Constant Field Values

PRAGMA

public static final java.lang.String PRAGMA

The HTTP Pragma header field name.

See Also:

Section 5.4 of RFC 7234, Constant Field Values

PROXY_AUTHENTICATE

public static final java.lang.String PROXY_AUTHENTICATE

The HTTP Proxy-Authenticate header field name.

See Also:

Section 4.3 of RFC 7235, Constant Field Values

PROXY_AUTHORIZATION

public static final java.lang.String PROXY_AUTHORIZATION

The HTTP Proxy-Authorization header field name.

See Also:

Section 4.4 of RFC 7235, Constant Field Values

RANGE

public static final java.lang.String RANGE

The HTTP Range header field name.

See Also:

Section 3.1 of RFC 7233, Constant Field Values

REFERER

public static final java.lang.String REFERER

The HTTP Referer header field name.

See Also:

Section 5.5.2 of RFC 7231, Constant Field Values

RETRY_AFTER

public static final java.lang.String RETRY_AFTER

The HTTP Retry-After header field name.

See Also:

Section 7.1.3 of RFC 7231, Constant Field Values

SERVER

public static final java.lang.String SERVER

The HTTP Server header field name.

See Also:

Section 7.4.2 of RFC 7231, Constant Field Values

SET_COOKIE

public static final java.lang.String SET_COOKIE

The HTTP Set-Cookie header field name.

See Also:

Section 4.2.2 of RFC 2109, Constant Field Values

SET_COOKIE2

public static final java.lang.String SET_COOKIE2

The HTTP Set-Cookie2 header field name.

See Also:

RFC 2965, Constant Field Values

TE

public static final java.lang.String TE

The HTTP TE header field name.

See Also:

Section 4.3 of RFC 7230, Constant Field Values

TRAILER

public static final java.lang.String TRAILER

The HTTP Trailer header field name.

See Also:

Section 4.4 of RFC 7230, Constant Field Values

TRANSFER_ENCODING

public static final java.lang.String TRANSFER_ENCODING

The HTTP Transfer-Encoding header field name.

See Also:

Section 3.3.1 of RFC 7230, Constant Field Values

UPGRADE

public static final java.lang.String UPGRADE

The HTTP Upgrade header field name.

See Also:

Section 6.7 of RFC 7230, Constant Field Values

USER_AGENT

public static final java.lang.String USER_AGENT

The HTTP User-Agent header field name.

See Also:

Section 5.5.3 of RFC 7231, Constant Field Values

VARY

public static final java.lang.String VARY

The HTTP Vary header field name.

See Also:

Section 7.1.4 of RFC 7231, Constant Field Values

VIA

public static final java.lang.String VIA

The HTTP Via header field name.

See Also:

Section 5.7.1 of RFC 7230, Constant Field Values

WARNING

public static final java.lang.String WARNING

The HTTP Warning header field name.

See Also:

Section 5.5 of RFC 7234, Constant Field Values

WWW_AUTHENTICATE

public static final java.lang.String WWW_AUTHENTICATE

The HTTP WWW-Authenticate header field name.

See Also:

Section 4.1 of RFC 7235, Constant Field Values

Constructor Detail

HttpHeaders

public HttpHeaders()

Constructs a new, empty instance of the HttpHeaders object.

Method Detail

setAccept

public void setAccept(java.util.List<MediaType> acceptableMediaTypes)

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

getAccept

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

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

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

setAcceptCharset

public void setAcceptCharset(java.util.List<java.nio.charset.Charset> acceptableCharsets)

Set the list of acceptable charsets, as specified by the Accept-Charset header.

getAcceptCharset

public java.util.List<java.nio.charset.Charset> getAcceptCharset()

Return the list of acceptable charsets, as specified by the Accept-Charset header.

setAcceptEncoding

public void setAcceptEncoding(java.util.List<ContentCodingType> acceptableEncodingTypes)

Set the list of acceptable coding types, as specified by the Accept-Encoding header.

Parameters:

acceptableEncodingTypes - the acceptable content coding types

See Also:

setAcceptEncoding(ContentCodingType)

setAcceptEncoding

public void setAcceptEncoding(ContentCodingType acceptableEncodingType)

Set the acceptable coding type, as specified by the Accept-Encoding header.

Parameters:

acceptableEncodingType - the acceptable content coding type

See Also:

setAcceptEncoding(List)

getAcceptEncoding

public java.util.List<ContentCodingType> getAcceptEncoding()

Return the list of acceptable coding types, as specified by the Accept-Encoding header.

Returns an empty list when the acceptable content coding types are unspecified.

Returns:

the acceptable content coding types

setAcceptLanguage

public void setAcceptLanguage(java.lang.String acceptLanguage)

Set the accept language, as specified by the Accept-Language header.

Parameters:

acceptLanguage - the accept language

getAcceptLanguage

public java.lang.String getAcceptLanguage()

Return the accept language, as specified by the Accept-Language header.

Returns:

the accept language

setAllow

public void setAllow(java.util.Set<HttpMethod> allowedMethods)

Set the set of allowed HTTP methods, as specified by the Allow header.

getAllow

public java.util.Set<HttpMethod> getAllow()

Return the set of allowed HTTP methods, as specified by the Allow header.

Returns an empty set when the allowed methods are unspecified.

setAuthorization

public void setAuthorization(HttpAuthentication httpAuthentication)

Sets a value for the Authorization header.

Parameters:

httpAuthentication - an http-based authentication representation

getAuthorization

public java.lang.String getAuthorization()

Returns the value of the Authorization header.

Returns:

the Authorization header value

setCacheControl

public void setCacheControl(java.lang.String cacheControl)

Set the (new) value of the Cache-Control header.

getCacheControl

public java.lang.String getCacheControl()

Returns the value of the Cache-Control header.

setConnection

public void setConnection(java.lang.String connection)

Set the (new) value of the Connection header.

setConnection

public void setConnection(java.util.List<java.lang.String> connection)

Set the (new) value of the Connection header.

getConnection

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

Returns the value of the Connection header.

setContentDispositionFormData

public void setContentDispositionFormData(java.lang.String name,
                                          java.lang.String filename)

Set the (new) value of the Content-Disposition header for form-data.

Parameters:

name - the control name

filename - the filename (may be null)

setContentEncoding

public void setContentEncoding(java.util.List<ContentCodingType> contentEncodingTypes)

Set the list of content coding types, as specified by the Content-Encoding header.

Parameters:

contentEncodingTypes - the content coding types

See Also:

setContentEncoding(ContentCodingType)

setContentEncoding

public void setContentEncoding(ContentCodingType contentEncodingType)

Set the content coding type, as specified by the Content-Encoding header.

Parameters:

contentEncodingType - the content coding type

See Also:

setContentEncoding(List)

getContentEncoding

public java.util.List<ContentCodingType> getContentEncoding()

Return the list of content coding types, as specified by the Content-Encoding header.

Returns an empty list when the content coding type(s) are unspecified.

Returns:

the content coding types

setContentLength

public void setContentLength(long contentLength)

Set the length of the body in bytes, as specified by the Content-Length header.

getContentLength

public long getContentLength()

Return the length of the body in bytes, as specified by the Content-Length header.

Returns -1 when the content-length is unknown.

setContentType

public void setContentType(MediaType mediaType)

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

getContentType

public MediaType getContentType()

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

Returns null when the content-type is unknown.

setDate

public void setDate(long date)

Set the date and time at which the message was created, as specified by the Date header.

The date should be specified as the number of milliseconds since January 1, 1970 GMT.

getDate

public long getDate()

Return the date and time at which the message was created, as specified by the Date header.

The date is returned as the number of milliseconds since January 1, 1970 GMT. Returns -1 when the date is unknown.

Throws:

java.lang.IllegalArgumentException - if the value can't be converted to a date

setETag

public void setETag(java.lang.String eTag)

Set the (new) entity tag of the body, as specified by the ETag header.

getETag

public java.lang.String getETag()

Return the entity tag of the body, as specified by the ETag header.

setExpires

public void setExpires(long expires)

Set the date and time at which the message is no longer valid, as specified by the Expires header.

The date should be specified as the number of milliseconds since January 1, 1970 GMT.

getExpires

public long getExpires()

Return the date and time at which the message is no longer valid, as specified by the Expires header.

The date is returned as the number of milliseconds since January 1, 1970 GMT. Returns -1 when the date is unknown.

setIfModifiedSince

public void setIfModifiedSince(long ifModifiedSince)

Set the (new) value of the If-Modified-Since header.

The date should be specified as the number of milliseconds since January 1, 1970 GMT.

getIfNotModifiedSince

@Deprecated
public long getIfNotModifiedSince()

Deprecated. use getIfModifiedSince()

Return the value of the IfModifiedSince header.

The date is returned as the number of milliseconds since January 1, 1970 GMT. Returns -1 when the date is unknown.

getIfModifiedSince

public long getIfModifiedSince()

Return the value of the If-Modified-Since header.

The date is returned as the number of milliseconds since January 1, 1970 GMT. Returns -1 when the date is unknown.

setIfNoneMatch

public void setIfNoneMatch(java.lang.String ifNoneMatch)

Set the (new) value of the If-None-Match header.

setIfNoneMatch

public void setIfNoneMatch(java.util.List<java.lang.String> ifNoneMatchList)

Set the (new) values of the If-None-Match header.

toCommaDelimitedString

protected java.lang.String toCommaDelimitedString(java.util.List<java.lang.String> list)

getIfNoneMatch

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

Return the value of the If-None-Match header.

getFirstValueAsList

protected java.util.List<java.lang.String> getFirstValueAsList(java.lang.String header)

setLastModified

public void setLastModified(long lastModified)

Set the time the resource was last changed, as specified by the Last-Modified header.

The date should be specified as the number of milliseconds since January 1, 1970 GMT.

getLastModified

public long getLastModified()

Return the time the resource was last changed, as specified by the Last-Modified header.

The date is returned as the number of milliseconds since January 1, 1970 GMT. Returns -1 when the date is unknown.

setLocation

public void setLocation(java.net.URI location)

Set the (new) location of a resource, as specified by the Location header.

getLocation

public java.net.URI getLocation()

Return the (new) location of a resource as specified by the Location header.

Returns null when the location is unknown.

setOrigin

public void setOrigin(java.lang.String origin)

Set the (new) value of the Origin header.

getOrigin

public java.lang.String getOrigin()

Return the value of the Origin header.

setPragma

public void setPragma(java.lang.String pragma)

Set the (new) value of the Pragma header.

getPragma

public java.lang.String getPragma()

Return the value of the Pragma header.

setUserAgent

public void setUserAgent(java.lang.String userAgent)

Set the (new) value of the User-Agent header.

getUserAgent

public java.lang.String getUserAgent()

Returns the value of the User-Agent header.

setUpgrade

public void setUpgrade(java.lang.String upgrade)

Set the (new) value of the Upgrade header.

getUpgrade

public java.lang.String getUpgrade()

Returns the value of the Upgrade header.

getFirstDate

public long getFirstDate(java.lang.String headerName)

Parse the first header value for the given header name as a date, return -1 if there is no value, or raise IllegalArgumentException if the value cannot be parsed as a date.

setDate

public void setDate(java.lang.String headerName,
                    long date)

Set the given date under the given header name after formatting it as a string using the pattern "EEE, dd MMM yyyy HH:mm:ss zzz". The equivalent of set(String, String) but for date headers.

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>

Parameters:

headerName - the header name

Returns:

the first header value, or null if none

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>

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>

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>

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>

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

isEmpty

public boolean isEmpty()

Specified by:

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

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

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

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

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

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

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

clear

public void clear()

Specified by:

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

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

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

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

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 java.lang.Object

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 java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

readOnlyHttpHeaders

public static HttpHeaders readOnlyHttpHeaders(HttpHeaders headers)

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