Package com.atlassian.bamboo.web

Class HttpHeaders

java.lang.Object

com.atlassian.bamboo.web.HttpHeaders

All Implemented Interfaces:

Serializable, Map<String,List<String>>, org.springframework.util.MultiValueMap<String,String>

public class HttpHeaders
extends Object
implements org.springframework.util.MultiValueMap<String,String>, Serializable

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

Since:

10.0

See Also:

• Serialized Form

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor	Description
HttpHeaders()	Construct a new, empty instance of the HttpHeaders object.
HttpHeaders(org.springframework.util.MultiValueMap<String,String> headers)	Construct a new HttpHeaders instance backed by an existing map.

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	addAll(String key, List<? extends String> values)
void	addAll(org.springframework.util.MultiValueMap<String,String> values)
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
@NotNull Set<Map.Entry<String,List<String>>>	entrySet()
boolean	equals(@Nullable Object other)
static String	formatHeaders(org.springframework.util.MultiValueMap<String,String> headers)	Helps to format HTTP header values, as HTTP header values themselves can contain comma-separated values, can become confusing with regular Map formatting that also uses commas between entries.
@Nullable List<String>	get(Object key)
@Nullable String	getFirst(String headerName)	Return the first header value for the given header name, if any.
List<String>	getOrEmpty(Object headerName)	Get the list of header values for the given header name, if any.
int	hashCode()
boolean	isEmpty()
@NotNull Set<String>	keySet()
List<String>	put(String key, List<String> value)
void	putAll(Map<? extends String,? extends List<String>> map)
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)
int	size()
Map<String,String>	toSingleValueMap()
String	toString()
@NotNull Collection<List<String>>	values()

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

Methods inherited from interface org.springframework.util.MultiValueMap

addIfAbsent

Constructor Details

HttpHeaders

public HttpHeaders()

Construct a new, empty instance of the HttpHeaders object.

This is the common constructor, using a case-insensitive map structure.

HttpHeaders

public HttpHeaders(org.springframework.util.MultiValueMap<String,String> headers)

Construct a new HttpHeaders instance backed by an existing map.

This constructor is available as an optimization for adapting to existing headers map structures, primarily for internal use within the framework.

Parameters:

headers - the headers map (expected to operate with case-insensitive keys)

Method Details

getOrEmpty

public List<String> getOrEmpty(Object headerName)

Get the list of header values for the given header name, if any.

Parameters:

headerName - the header name

Returns:

the list of header values, or an empty list

getFirst

@Nullable
public @Nullable String getFirst(String headerName)

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

Specified by:

getFirst in interface org.springframework.util.MultiValueMap<String,String>

Parameters:

headerName - the header name

Returns:

the first header value, or null if none

add

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

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

Specified by:

add in interface org.springframework.util.MultiValueMap<String,String>

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)

addAll

public void addAll(String key,
 List<? extends String> values)

Specified by:

addAll in interface org.springframework.util.MultiValueMap<String,String>

addAll

public void addAll(org.springframework.util.MultiValueMap<String,String> values)

Specified by:

addAll in interface org.springframework.util.MultiValueMap<String,String>

set

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

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

Specified by:

set in interface org.springframework.util.MultiValueMap<String,String>

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)

Specified by:

setAll in interface org.springframework.util.MultiValueMap<String,String>

toSingleValueMap

public Map<String,String> toSingleValueMap()

Specified by:

toSingleValueMap in interface org.springframework.util.MultiValueMap<String,String>

size

public int size()

Specified by:

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

isEmpty

public boolean isEmpty()

Specified by:

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

containsKey

public boolean containsKey(Object key)

Specified by:

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

containsValue

public boolean containsValue(Object value)

Specified by:

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

get

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

Specified by:

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

put

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

Specified by:

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

remove

public List<String> remove(Object key)

Specified by:

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

putAll

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

Specified by:

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

clear

public void clear()

Specified by:

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

keySet

@NotNull
public @NotNull Set<String> keySet()

Specified by:

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

values

@NotNull
public @NotNull Collection<List<String>> values()

Specified by:

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

entrySet

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

Specified by:

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

equals

public boolean equals(@Nullable
 @Nullable Object other)

Specified by:

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

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

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

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

formatHeaders

public static String formatHeaders(org.springframework.util.MultiValueMap<String,String> headers)

Helps to format HTTP header values, as HTTP header values themselves can contain comma-separated values, can become confusing with regular Map formatting that also uses commas between entries.

Parameters:

headers - the headers to format

Returns:

the headers to a String