Class CombinedHttpHeaders

java.lang.Object

io.netty.handler.codec.http.HttpHeaders

io.netty.handler.codec.http.DefaultHttpHeaders

io.netty.handler.codec.http.CombinedHttpHeaders

All Implemented Interfaces:

Iterable<Map.Entry<String,String>>

public class CombinedHttpHeaders
extends DefaultHttpHeaders

Will add multiple values for the same header as single header with a comma separated list of values.

Please refer to section RFC 7230, 3.2.2.

Nested Class Summary

Nested classes/interfaces inherited from class HttpHeaders

HttpHeaders.Names, HttpHeaders.Values

Modifier and Type	Class	Description
static final class	HttpHeaders.Names	Deprecated. Use HttpHeaderNames instead.
static final class	HttpHeaders.Values	Deprecated. Use HttpHeaderValues instead.

Field Summary

Fields inherited from class HttpHeaders

EMPTY_HEADERS

Modifier and Type	Field	Description
static final HttpHeaders	EMPTY_HEADERS	Deprecated. Use EmptyHttpHeaders.INSTANCE.

Constructor Summary

Constructors

Constructor	Description
CombinedHttpHeaders(boolean validate)	Deprecated. Prefer instead to configuring a HttpHeadersFactory by calling withCombiningHeaders(true) on DefaultHttpHeadersFactory.headersFactory().

Method Summary

Modifier and Type	Method	Description
boolean	containsValue(CharSequence name, CharSequence value, boolean ignoreCase)	Returns true if a header with the name and value exists, false otherwise.

Methods inherited from class DefaultHttpHeaders

add, add, add, add, add, addInt, addShort, clear, contains, contains, contains, contains, copy, entries, equals, get, get, getAll, getAll, getInt, getInt, getShort, getShort, getTimeMillis, getTimeMillis, hashCode, isEmpty, iterator, iteratorCharSequence, names, remove, remove, set, set, set, set, set, setInt, setShort, size, unwrap, valueCharSequenceIterator, valueStringIterator

Modifier and Type	Method	Description
HttpHeaders	add(HttpHeaders headers)	Adds all header entries of the specified headers.
HttpHeaders	add(CharSequence name, Iterable<?> values)	Adds a new header with the specified name and values.
HttpHeaders	add(CharSequence name, Object value)	Adds a new header with the specified name and value.
HttpHeaders	add(String name, Iterable<?> values)
HttpHeaders	add(String name, Object value)
HttpHeaders	addInt(CharSequence name, int value)	Add the name to value.
HttpHeaders	addShort(CharSequence name, short value)	Add the name to value.
HttpHeaders	clear()	Removes all headers from this HttpMessage.
boolean	contains(CharSequence name)	Checks to see if there is a header with the specified name
boolean	contains(CharSequence name, CharSequence value, boolean ignoreCase)	Returns true if a header with the name and value exists, false otherwise.
boolean	contains(String name)
boolean	contains(String name, String value, boolean ignoreCase)
HttpHeaders	copy()	Returns a deep copy of the passed in HttpHeaders.
List<Map.Entry<String,String>>	entries()	Returns a new List that contains all headers in this object.
boolean	equals(Object o)
String	get(CharSequence name)	Returns the value of a header with the specified name.
String	get(String name)
List<String>	getAll(CharSequence name)	Returns the values of headers with the specified name
List<String>	getAll(String name)
Integer	getInt(CharSequence name)	Returns the integer value of a header with the specified name.
int	getInt(CharSequence name, int defaultValue)	Returns the integer value of a header with the specified name.
Short	getShort(CharSequence name)	Returns the short value of a header with the specified name.
short	getShort(CharSequence name, short defaultValue)	Returns the short value of a header with the specified name.
Long	getTimeMillis(CharSequence name)	Returns the date value of a header with the specified name.
long	getTimeMillis(CharSequence name, long defaultValue)	Returns the date value of a header with the specified name.
int	hashCode()
boolean	isEmpty()	Checks if no header exists.
Iterator<Map.Entry<String,String>>	iterator()	Deprecated.
Iterator<Map.Entry<CharSequence, CharSequence>>	iteratorCharSequence()
Set<String>	names()	Returns a new Set that contains the names of all headers in this object.
HttpHeaders	remove(CharSequence name)	Removes the header with the specified name.
HttpHeaders	remove(String name)
HttpHeaders	set(HttpHeaders headers)	Cleans the current header entries and copies all header entries of the specified headers.
HttpHeaders	set(CharSequence name, Iterable<?> values)	Sets a header with the specified name and values.
HttpHeaders	set(CharSequence name, Object value)	Sets a header with the specified name and value.
HttpHeaders	set(String name, Iterable<?> values)
HttpHeaders	set(String name, Object value)
HttpHeaders	setInt(CharSequence name, int value)	Set the name to value.
HttpHeaders	setShort(CharSequence name, short value)	Set the name to value.
int	size()	Returns the number of headers in this object.
Headers<CharSequence, CharSequence, ?>	unwrap()
Iterator<CharSequence>	valueCharSequenceIterator(CharSequence name)	Equivalent to HttpHeaders.getAll(String) but it is possible that no intermediate list is generated.
Iterator<String>	valueStringIterator(CharSequence name)	Equivalent to HttpHeaders.getAll(String) but it is possible that no intermediate list is generated.

Methods inherited from class HttpHeaders

addDateHeader, addDateHeader, addHeader, addHeader, addIntHeader, addIntHeader, clearHeaders, encodeAscii, equalsIgnoreCase, get, getAllAsString, getAsString, getContentLength, getContentLength, getDate, getDate, getDateHeader, getDateHeader, getDateHeader, getDateHeader, getHeader, getHeader, getHeader, getHeader, getHost, getHost, getIntHeader, getIntHeader, getIntHeader, getIntHeader, is100ContinueExpected, isContentLengthSet, isKeepAlive, isTransferEncodingChunked, iteratorAsString, newEntity, removeHeader, removeHeader, removeTransferEncodingChunked, set100ContinueExpected, set100ContinueExpected, setAll, setContentLength, setDate, setDateHeader, setDateHeader, setDateHeader, setDateHeader, setHeader, setHeader, setHeader, setHeader, setHost, setHost, setIntHeader, setIntHeader, setIntHeader, setIntHeader, setKeepAlive, setTransferEncodingChunked, toString

Modifier and Type	Method	Description
static void	addDateHeader(HttpMessage message, CharSequence name, Date value)	Deprecated. Use HttpHeaders.add(CharSequence, Object) instead.
static void	addDateHeader(HttpMessage message, String name, Date value)	Deprecated. Use HttpHeaders.add(CharSequence, Object) instead.
static void	addHeader(HttpMessage message, CharSequence name, Object value)	Deprecated. Use HttpHeaders.add(CharSequence, Object) instead.
static void	addHeader(HttpMessage message, String name, Object value)	Deprecated. Use HttpHeaders.add(CharSequence, Object) instead.
static void	addIntHeader(HttpMessage message, CharSequence name, int value)	Deprecated. Use HttpHeaders.addInt(CharSequence, int) instead.
static void	addIntHeader(HttpMessage message, String name, int value)	Deprecated. Use HttpHeaders.add(CharSequence, Iterable) instead.
static void	clearHeaders(HttpMessage message)	Deprecated. Use HttpHeaders.clear() instead.
static void	encodeAscii(CharSequence seq, ByteBuf buf)	Deprecated.
static boolean	equalsIgnoreCase(CharSequence name1, CharSequence name2)	Deprecated. Use AsciiString.contentEqualsIgnoreCase(CharSequence, CharSequence) instead.
String	get(CharSequence name, String defaultValue)	Returns the value of a header with the specified name.
final List<String>	getAllAsString(CharSequence name)	Headers.getAll(Object) and convert each element of List to a String.
final String	getAsString(CharSequence name)	Headers.get(Object) and convert the result to a String.
static long	getContentLength(HttpMessage message)	Deprecated. Use HttpUtil.getContentLength(HttpMessage) instead.
static long	getContentLength(HttpMessage message, long defaultValue)	Deprecated. Use HttpUtil.getContentLength(HttpMessage, long) instead.
static Date	getDate(HttpMessage message)	Deprecated. Use HttpHeaders.getTimeMillis(CharSequence) instead.
static Date	getDate(HttpMessage message, Date defaultValue)	Deprecated. Use HttpHeaders.getTimeMillis(CharSequence, long) instead.
static Date	getDateHeader(HttpMessage message, CharSequence name)	Deprecated. Use HttpHeaders.getTimeMillis(CharSequence) instead.
static Date	getDateHeader(HttpMessage message, CharSequence name, Date defaultValue)	Deprecated. Use HttpHeaders.getTimeMillis(CharSequence, long) instead.
static Date	getDateHeader(HttpMessage message, String name)	Deprecated. Use HttpHeaders.getTimeMillis(CharSequence) instead.
static Date	getDateHeader(HttpMessage message, String name, Date defaultValue)	Deprecated. Use HttpHeaders.getTimeMillis(CharSequence, long) instead.
static String	getHeader(HttpMessage message, CharSequence name)	Deprecated. Use HttpHeaders.get(CharSequence) instead.
static String	getHeader(HttpMessage message, CharSequence name, String defaultValue)	Deprecated. Use HttpHeaders.get(CharSequence, String) instead.
static String	getHeader(HttpMessage message, String name)	Deprecated. Use HttpHeaders.get(CharSequence) instead.
static String	getHeader(HttpMessage message, String name, String defaultValue)	Deprecated. Use HttpHeaders.get(CharSequence, String) instead.
static String	getHost(HttpMessage message)	Deprecated. Use HttpHeaders.get(CharSequence) instead.
static String	getHost(HttpMessage message, String defaultValue)	Deprecated. Use HttpHeaders.get(CharSequence, String) instead.
static int	getIntHeader(HttpMessage message, CharSequence name)	Deprecated. Use HttpHeaders.getInt(CharSequence) instead.
static int	getIntHeader(HttpMessage message, CharSequence name, int defaultValue)	Deprecated. Use HttpHeaders.getInt(CharSequence, int) instead.
static int	getIntHeader(HttpMessage message, String name)	Deprecated. Use HttpHeaders.getInt(CharSequence) instead.
static int	getIntHeader(HttpMessage message, String name, int defaultValue)	Deprecated. Use HttpHeaders.getInt(CharSequence, int) instead.
static boolean	is100ContinueExpected(HttpMessage message)	Deprecated. Use HttpUtil.is100ContinueExpected(HttpMessage) instead.
static boolean	isContentLengthSet(HttpMessage m)	Deprecated. Use HttpUtil.isContentLengthSet(HttpMessage) instead.
static boolean	isKeepAlive(HttpMessage message)	Deprecated. Use HttpUtil.isKeepAlive(HttpMessage) instead.
static boolean	isTransferEncodingChunked(HttpMessage message)	Deprecated. Use HttpUtil.isTransferEncodingChunked(HttpMessage) instead.
final Iterator<Map.Entry<String,String>>	iteratorAsString()	Iterator that converts each Map.Entry's key and value to a String.
static CharSequence	newEntity(String name)	Deprecated. Use AsciiString instead.
static void	removeHeader(HttpMessage message, CharSequence name)	Deprecated. Use HttpHeaders.remove(CharSequence) instead.
static void	removeHeader(HttpMessage message, String name)	Deprecated. Use HttpHeaders.remove(CharSequence) instead.
static void	removeTransferEncodingChunked(HttpMessage m)	Deprecated. Use HttpUtil.setTransferEncodingChunked(HttpMessage, boolean) instead.
static void	set100ContinueExpected(HttpMessage message)	Deprecated. Use HttpUtil.set100ContinueExpected(HttpMessage, boolean) instead.
static void	set100ContinueExpected(HttpMessage message, boolean set)	Deprecated. Use HttpUtil.set100ContinueExpected(HttpMessage, boolean) instead.
HttpHeaders	setAll(HttpHeaders headers)	Retains all current headers but calls HttpHeaders.set(String, Object) for each entry in headers
static void	setContentLength(HttpMessage message, long length)	Deprecated. Use HttpUtil.setContentLength(HttpMessage, long) instead.
static void	setDate(HttpMessage message, Date value)	Deprecated. Use HttpHeaders.set(CharSequence, Object) instead.
static void	setDateHeader(HttpMessage message, CharSequence name, Iterable<Date> values)	Deprecated. Use HttpHeaders.set(CharSequence, Iterable) instead.
static void	setDateHeader(HttpMessage message, CharSequence name, Date value)	Deprecated. Use HttpHeaders.set(CharSequence, Object) instead.
static void	setDateHeader(HttpMessage message, String name, Iterable<Date> values)	Deprecated. Use HttpHeaders.set(CharSequence, Iterable) instead.
static void	setDateHeader(HttpMessage message, String name, Date value)	Deprecated. Use HttpHeaders.set(CharSequence, Object) instead.
static void	setHeader(HttpMessage message, CharSequence name, Iterable<?> values)	Deprecated. Use HttpHeaders.set(CharSequence, Iterable) instead.
static void	setHeader(HttpMessage message, CharSequence name, Object value)	Deprecated. Use HttpHeaders.set(CharSequence, Object) instead.
static void	setHeader(HttpMessage message, String name, Iterable<?> values)	Deprecated. Use HttpHeaders.set(CharSequence, Iterable) instead.
static void	setHeader(HttpMessage message, String name, Object value)	Deprecated. Use HttpHeaders.set(CharSequence, Object) instead.
static void	setHost(HttpMessage message, CharSequence value)	Deprecated. Use HttpHeaders.set(CharSequence, Object) instead.
static void	setHost(HttpMessage message, String value)	Deprecated. Use HttpHeaders.set(CharSequence, Object) instead.
static void	setIntHeader(HttpMessage message, CharSequence name, int value)	Deprecated. Use HttpHeaders.setInt(CharSequence, int) instead.
static void	setIntHeader(HttpMessage message, CharSequence name, Iterable<Integer> values)	Deprecated. Use HttpHeaders.set(CharSequence, Iterable) instead.
static void	setIntHeader(HttpMessage message, String name, int value)	Deprecated. Use HttpHeaders.setInt(CharSequence, int) instead.
static void	setIntHeader(HttpMessage message, String name, Iterable<Integer> values)	Deprecated. Use HttpHeaders.set(CharSequence, Iterable) instead.
static void	setKeepAlive(HttpMessage message, boolean keepAlive)	Deprecated. Use HttpUtil.setKeepAlive(HttpMessage, boolean) instead.
static void	setTransferEncodingChunked(HttpMessage m)	Deprecated. Use HttpUtil.setTransferEncodingChunked(HttpMessage, boolean) instead.
String	toString()

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

CombinedHttpHeaders

@Deprecated
public CombinedHttpHeaders(boolean validate)

Deprecated.

Prefer instead to configuring a HttpHeadersFactory by calling withCombiningHeaders(true) on DefaultHttpHeadersFactory.headersFactory().

Create a combined HTTP header object, with optional validation.

Parameters:

validate - Should Netty validate header values to ensure they aren't malicious.

Method Details

containsValue

public boolean containsValue(CharSequence name,
 CharSequence value,
 boolean ignoreCase)

Description copied from class: HttpHeaders

Returns true if a header with the name and value exists, false otherwise. This also handles multiple values that are separated with a ,.

If ignoreCase is true then a case insensitive compare is done on the value.

Overrides:

containsValue in class HttpHeaders

Parameters:

name - the name of the header to find

value - the value of the header to find

ignoreCase - true then a case insensitive compare is run to compare values. otherwise a case sensitive compare is run to compare values.