Package io.netty.handler.codec.http

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

Modifier and Type	Class	Description
private static final class	CombinedHttpHeaders.CombinedHttpHeadersImpl

Nested classes/interfaces inherited from class io.netty.handler.codec.http.HttpHeaders

HttpHeaders.Names, HttpHeaders.Values

Field Summary

Fields inherited from class io.netty.handler.codec.http.HttpHeaders

EMPTY_HEADERS

Constructor Summary

Constructors

Constructor	Description
CombinedHttpHeaders(boolean validate)	Deprecated. Prefer instead to configuring a HttpHeadersFactory by calling withCombiningHeaders(true) on DefaultHttpHeadersFactory.headersFactory().
CombinedHttpHeaders(DefaultHeaders.NameValidator<CharSequence> nameValidator, DefaultHeaders.ValueValidator<CharSequence> valueValidator)
CombinedHttpHeaders(DefaultHeaders.NameValidator<CharSequence> nameValidator, DefaultHeaders.ValueValidator<CharSequence> valueValidator, int sizeHint)

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 io.netty.handler.codec.http.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, nameValidator, remove, remove, set, set, set, set, set, setInt, setShort, size, unwrap, valueCharSequenceIterator, valueConverter, valueStringIterator, valueValidator

Methods inherited from class io.netty.handler.codec.http.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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.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.

CombinedHttpHeaders

CombinedHttpHeaders(DefaultHeaders.NameValidator<CharSequence> nameValidator,
 DefaultHeaders.ValueValidator<CharSequence> valueValidator)

CombinedHttpHeaders

CombinedHttpHeaders(DefaultHeaders.NameValidator<CharSequence> nameValidator,
 DefaultHeaders.ValueValidator<CharSequence> valueValidator,
 int sizeHint)

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.