Class HttpHeaders

java.lang.Object

org.springframework.data.elasticsearch.support.HttpHeaders

All Implemented Interfaces:

Map<String, List<String>>, MultiValueMap<String, @Nullable String>

public class HttpHeaders
extends Object
implements MultiValueMap<String, @Nullable String>

A simple class implementing HTTP headers as a MultiValueMap. This own implementation is necessary to remove the dependency to the class with the same name from org.springframework:spring-web. Under the hood is uses a LinkedCaseInsensitiveMap.

Since:

5.0

Author:

Peter-Josef Meisch

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHORIZATION

Constructor Summary

Constructors

Constructor	Description
HttpHeaders()

Method Summary

Modifier and Type	Method	Description
void	add(String key, @Nullable String value)
void	addAll(String key, List<? extends @Nullable String> values)
void	addAll(MultiValueMap<String, @Nullable String> values)
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
static String	encodeBasicAuth(String username, String password)	Encode a username and password to be used in basic authorization.
static String	encodeBasicAuth(String username, String password, @Nullable Charset charset)	Encode a username and password to be used in basic authorization.
Set<Map.Entry<String, List<String>>>	entrySet()
boolean	equals(Object o)
@Nullable List<@Nullable String>	get(Object key)
@Nullable String	getFirst(String key)
int	hashCode()
boolean	isEmpty()
Set<String>	keySet()
@Nullable List<@Nullable String>	put(String key, List<@Nullable String> value)
void	putAll(Map<? extends String, ? extends List<String>> m)
List<@Nullable String>	remove(Object key)
void	set(String key, @Nullable String value)
void	setAll(Map<String, @Nullable String> values)
void	setBasicAuth(String username, String password)
int	size()
Map<String, @Nullable String>	toSingleValueMap()
Collection<List<String>>	values()

Methods inherited from class Object

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

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface MultiValueMap

addIfAbsent, asSingleValueMap

Field Details

AUTHORIZATION

public static final String AUTHORIZATION

See Also:

• Constant Field Values

Constructor Details

HttpHeaders

public HttpHeaders()

Method Details

getFirst

public @Nullable String getFirst(String key)

Specified by:

getFirst in interface MultiValueMap<String, @Nullable String>

add

public void add(String key,
 @Nullable String value)

Specified by:

add in interface MultiValueMap<String, @Nullable String>

addAll

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

Specified by:

addAll in interface MultiValueMap<String, @Nullable String>

addAll

public void addAll(MultiValueMap<String, @Nullable String> values)

Specified by:

addAll in interface MultiValueMap<String, @Nullable String>

set

public void set(String key,
 @Nullable String value)

Specified by:

set in interface MultiValueMap<String, @Nullable String>

setAll

public void setAll(Map<String, @Nullable String> values)

Specified by:

setAll in interface MultiValueMap<String, @Nullable String>

toSingleValueMap

public Map<String, @Nullable String> toSingleValueMap()

Specified by:

toSingleValueMap in interface MultiValueMap<String, @Nullable 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

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

Specified by:

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

put

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

Specified by:

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

remove

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

Specified by:

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

putAll

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

Specified by:

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

clear

public void clear()

Specified by:

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

keySet

public Set<String> keySet()

Specified by:

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

values

public Collection<List<String>> values()

Specified by:

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

entrySet

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

Specified by:

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

equals

public boolean equals(Object o)

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

setBasicAuth

public void setBasicAuth(String username,
 String password)

encodeBasicAuth

public static String encodeBasicAuth(String username,
 String password)

Encode a username and password to be used in basic authorization. Code copied from the spring-web HttpHeaders class.

Parameters:

username - the username, must not contain a colon

password - the password

Returns:

the encoded value

encodeBasicAuth

public static String encodeBasicAuth(String username,
 String password,
 @Nullable Charset charset)

Encode a username and password to be used in basic authorization. Code copied from the spring-web HttpHeaders class.

Parameters:

username - the username, must not contain a colon

password - the password

charset - charset for the encoding, if null StandardCharsets.ISO_8859_1 is used

Returns:

the encoded value