io.netty.handler.codec.http

Class HttpHeaders

java.lang.Object

io.netty.handler.codec.http.HttpHeaders

All Implemented Interfaces:

java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>>

Direct Known Subclasses:

DefaultHttpHeaders

public abstract class HttpHeaders
extends java.lang.Object
implements java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>>

Provides the constants for the standard HTTP header names and values and commonly used utility methods that accesses an HttpMessage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpHeaders.Names Standard HTTP header names.
static class	HttpHeaders.Values Standard HTTP header values.

Field Summary

Fields

Modifier and Type	Field and Description
static HttpHeaders	EMPTY_HEADERS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpHeaders()

Method Summary

Modifier and Type	Method and Description
HttpHeaders	add(java.lang.CharSequence name, java.lang.Iterable<?> values) Adds a new header with the specified name and values.
HttpHeaders	add(java.lang.CharSequence name, java.lang.Object value) Adds a new header with the specified name and value.
HttpHeaders	add(HttpHeaders headers) Adds all header entries of the specified headers.
abstract HttpHeaders	add(java.lang.String name, java.lang.Iterable<?> values)
abstract HttpHeaders	add(java.lang.String name, java.lang.Object value)
static void	addDateHeader(HttpMessage message, java.lang.CharSequence name, java.util.Date value) Adds a new date header with the specified name and value.
static void	addDateHeader(HttpMessage message, java.lang.String name, java.util.Date value)
static void	addHeader(HttpMessage message, java.lang.CharSequence name, java.lang.Object value) Adds a new header with the specified name and value.
static void	addHeader(HttpMessage message, java.lang.String name, java.lang.Object value)
static void	addIntHeader(HttpMessage message, java.lang.CharSequence name, int value) Adds a new integer header with the specified name and value.
static void	addIntHeader(HttpMessage message, java.lang.String name, int value)
abstract HttpHeaders	clear() Removes all headers from this HttpMessage.
static void	clearHeaders(HttpMessage message) Removes all headers from the specified message.
boolean	contains(java.lang.CharSequence name) Checks to see if there is a header with the specified name
boolean	contains(java.lang.CharSequence name, java.lang.CharSequence value, boolean ignoreCaseValue) Returns true if a header with the name and value exists.
abstract boolean	contains(java.lang.String name)
boolean	contains(java.lang.String name, java.lang.String value, boolean ignoreCaseValue)
boolean	containsValue(java.lang.CharSequence name, java.lang.CharSequence value, boolean ignoreCase) Returns true if a header with the name and value exists, false otherwise.
static boolean	encodeAscii(java.lang.CharSequence seq, ByteBuf buf)
abstract java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>>	entries() Returns a new List that contains all headers in this object.
static boolean	equalsIgnoreCase(java.lang.CharSequence name1, java.lang.CharSequence name2) Returns true if both CharSequence's are equals when ignore the case.
java.lang.String	get(java.lang.CharSequence name) Returns the value of a header with the specified name.
abstract java.lang.String	get(java.lang.String name)
java.util.List<java.lang.String>	getAll(java.lang.CharSequence name) Returns the values of headers with the specified name
abstract java.util.List<java.lang.String>	getAll(java.lang.String name)
static long	getContentLength(HttpMessage message) Returns the length of the content.
static long	getContentLength(HttpMessage message, long defaultValue) Returns the length of the content.
static java.util.Date	getDate(HttpMessage message) Returns the value of the "Date" header.
static java.util.Date	getDate(HttpMessage message, java.util.Date defaultValue) Returns the value of the "Date" header.
static java.util.Date	getDateHeader(HttpMessage message, java.lang.CharSequence name) Returns the date header value with the specified header name.
static java.util.Date	getDateHeader(HttpMessage message, java.lang.CharSequence name, java.util.Date defaultValue) Returns the date header value with the specified header name.
static java.util.Date	getDateHeader(HttpMessage message, java.lang.String name)
static java.util.Date	getDateHeader(HttpMessage message, java.lang.String name, java.util.Date defaultValue)
static java.lang.String	getHeader(HttpMessage message, java.lang.CharSequence name) Returns the header value with the specified header name.
static java.lang.String	getHeader(HttpMessage message, java.lang.CharSequence name, java.lang.String defaultValue) Returns the header value with the specified header name.
static java.lang.String	getHeader(HttpMessage message, java.lang.String name)
static java.lang.String	getHeader(HttpMessage message, java.lang.String name, java.lang.String defaultValue)
static java.lang.String	getHost(HttpMessage message) Returns the value of the "Host" header.
static java.lang.String	getHost(HttpMessage message, java.lang.String defaultValue) Returns the value of the "Host" header.
static int	getIntHeader(HttpMessage message, java.lang.CharSequence name) Returns the integer header value with the specified header name.
static int	getIntHeader(HttpMessage message, java.lang.CharSequence name, int defaultValue) Returns the integer header value with the specified header name.
static int	getIntHeader(HttpMessage message, java.lang.String name)
static int	getIntHeader(HttpMessage message, java.lang.String name, int defaultValue)
static boolean	is100ContinueExpected(HttpMessage message) Returns true if and only if the specified message contains the "Expect: 100-continue" header.
static boolean	isContentLengthSet(HttpMessage m)
abstract boolean	isEmpty() Checks if no header exists.
static boolean	isKeepAlive(HttpMessage message) Returns true if and only if the connection can remain open and thus 'kept alive'.
static boolean	isTransferEncodingChunked(HttpMessage message) Checks to see if the transfer encoding in a specified HttpMessage is chunked
abstract java.util.Set<java.lang.String>	names() Returns a new Set that contains the names of all headers in this object.
static java.lang.CharSequence	newEntity(java.lang.String name) Create a new CharSequence which is optimized for reuse as HttpHeaders name or value.
static java.lang.CharSequence	newNameEntity(java.lang.String name) Create a new CharSequence which is optimized for reuse as HttpHeaders name.
static java.lang.CharSequence	newValueEntity(java.lang.String name) Create a new CharSequence which is optimized for reuse as HttpHeaders value.
HttpHeaders	remove(java.lang.CharSequence name) Removes the header with the specified name.
abstract HttpHeaders	remove(java.lang.String name)
static void	removeHeader(HttpMessage message, java.lang.CharSequence name) Removes the header with the specified name.
static void	removeHeader(HttpMessage message, java.lang.String name)
static void	removeTransferEncodingChunked(HttpMessage m)
HttpHeaders	set(java.lang.CharSequence name, java.lang.Iterable<?> values) Sets a header with the specified name and values.
HttpHeaders	set(java.lang.CharSequence name, java.lang.Object value) Sets a header with the specified name and value.
HttpHeaders	set(HttpHeaders headers) Cleans the current header entries and copies all header entries of the specified headers.
abstract HttpHeaders	set(java.lang.String name, java.lang.Iterable<?> values)
abstract HttpHeaders	set(java.lang.String name, java.lang.Object value)
static void	set100ContinueExpected(HttpMessage message) Sets the "Expect: 100-continue" header to the specified message.
static void	set100ContinueExpected(HttpMessage message, boolean set) Sets or removes the "Expect: 100-continue" header to / from the specified message.
static void	setContentLength(HttpMessage message, long length) Sets the "Content-Length" header.
static void	setDate(HttpMessage message, java.util.Date value) Sets the "Date" header.
static void	setDateHeader(HttpMessage message, java.lang.CharSequence name, java.util.Date value) Sets a new date header with the specified name and value.
static void	setDateHeader(HttpMessage message, java.lang.CharSequence name, java.lang.Iterable<java.util.Date> values) Sets a new date header with the specified name and values.
static void	setDateHeader(HttpMessage message, java.lang.String name, java.util.Date value)
static void	setDateHeader(HttpMessage message, java.lang.String name, java.lang.Iterable<java.util.Date> values)
static void	setHeader(HttpMessage message, java.lang.CharSequence name, java.lang.Iterable<?> values) Sets a new header with the specified name and values.
static void	setHeader(HttpMessage message, java.lang.CharSequence name, java.lang.Object value) Sets a new header with the specified name and value.
static void	setHeader(HttpMessage message, java.lang.String name, java.lang.Iterable<?> values)
static void	setHeader(HttpMessage message, java.lang.String name, java.lang.Object value)
static void	setHost(HttpMessage message, java.lang.CharSequence value) Sets the "Host" header.
static void	setHost(HttpMessage message, java.lang.String value)
static void	setIntHeader(HttpMessage message, java.lang.CharSequence name, int value) Sets a new integer header with the specified name and value.
static void	setIntHeader(HttpMessage message, java.lang.CharSequence name, java.lang.Iterable<java.lang.Integer> values) Sets a new integer header with the specified name and values.
static void	setIntHeader(HttpMessage message, java.lang.String name, int value)
static void	setIntHeader(HttpMessage message, java.lang.String name, java.lang.Iterable<java.lang.Integer> values)
static void	setKeepAlive(HttpMessage message, boolean keepAlive) Sets the value of the "Connection" header depending on the protocol version of the specified message.
static void	setTransferEncodingChunked(HttpMessage m)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

EMPTY_HEADERS

public static final HttpHeaders EMPTY_HEADERS

Constructor Detail

HttpHeaders

protected HttpHeaders()

Method Detail

isKeepAlive

public static boolean isKeepAlive(HttpMessage message)

Returns true if and only if the connection can remain open and thus 'kept alive'. This methods respects the value of the "Connection" header first and then the return value of HttpVersion.isKeepAliveDefault().

setKeepAlive

public static void setKeepAlive(HttpMessage message,
                                boolean keepAlive)

Sets the value of the "Connection" header depending on the protocol version of the specified message. This getMethod sets or removes the "Connection" header depending on what the default keep alive mode of the message's protocol version is, as specified by HttpVersion.isKeepAliveDefault().

• If the connection is kept alive by default:
  • set to "close" if keepAlive is false.
  • remove otherwise.
• If the connection is closed by default:
  • set to "keep-alive" if keepAlive is true.
  • remove otherwise.

getHeader

public static java.lang.String getHeader(HttpMessage message,
                                         java.lang.String name)

See Also:

#getHeader(HttpMessage, CharSequence)}

getHeader

public static java.lang.String getHeader(HttpMessage message,
                                         java.lang.CharSequence name)

Returns the header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned.

Returns:

the header value or null if there is no such header

getHeader

public static java.lang.String getHeader(HttpMessage message,
                                         java.lang.String name,
                                         java.lang.String defaultValue)

See Also:

getHeader(HttpMessage, CharSequence, String)

getHeader

public static java.lang.String getHeader(HttpMessage message,
                                         java.lang.CharSequence name,
                                         java.lang.String defaultValue)

Returns the header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned.

Returns:

the header value or the defaultValue if there is no such header

setHeader

public static void setHeader(HttpMessage message,
                             java.lang.String name,
                             java.lang.Object value)

See Also:

setHeader(HttpMessage, CharSequence, Object)

setHeader

public static void setHeader(HttpMessage message,
                             java.lang.CharSequence name,
                             java.lang.Object value)

Sets a new header with the specified name and value. If there is an existing header with the same name, the existing header is removed. If the specified value is not a String, it is converted into a String by Object.toString(), except for Date and Calendar which are formatted to the date format defined in RFC2616.

setHeader

public static void setHeader(HttpMessage message,
                             java.lang.String name,
                             java.lang.Iterable<?> values)

See Also:

setHeader(HttpMessage, CharSequence, Iterable)

setHeader

public static void setHeader(HttpMessage message,
                             java.lang.CharSequence name,
                             java.lang.Iterable<?> values)

Sets a new header with the specified name and values. If there is an existing header with the same name, the existing header is removed. This getMethod can be represented approximately as the following code:

 removeHeader(message, name);
 for (Object v: values) {
     if (v == null) {
         break;
     }
     addHeader(message, name, v);
 }
 

addHeader

public static void addHeader(HttpMessage message,
                             java.lang.String name,
                             java.lang.Object value)

See Also:

addHeader(HttpMessage, CharSequence, Object)

addHeader

public static void addHeader(HttpMessage message,
                             java.lang.CharSequence name,
                             java.lang.Object value)

Adds a new header with the specified name and value. If the specified value is not a String, it is converted into a String by Object.toString(), except for Date and Calendar which are formatted to the date format defined in RFC2616.

removeHeader

public static void removeHeader(HttpMessage message,
                                java.lang.String name)

See Also:

removeHeader(HttpMessage, CharSequence)

removeHeader

public static void removeHeader(HttpMessage message,
                                java.lang.CharSequence name)

Removes the header with the specified name.

clearHeaders

public static void clearHeaders(HttpMessage message)

Removes all headers from the specified message.

getIntHeader

public static int getIntHeader(HttpMessage message,
                               java.lang.String name)

See Also:

getIntHeader(HttpMessage, CharSequence)

getIntHeader

public static int getIntHeader(HttpMessage message,
                               java.lang.CharSequence name)

Returns the integer header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned.

Returns:

the header value

Throws:

java.lang.NumberFormatException - if there is no such header or the header value is not a number

getIntHeader

public static int getIntHeader(HttpMessage message,
                               java.lang.String name,
                               int defaultValue)

See Also:

getIntHeader(HttpMessage, CharSequence, int)

getIntHeader

public static int getIntHeader(HttpMessage message,
                               java.lang.CharSequence name,
                               int defaultValue)

Returns the integer header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned.

Returns:

the header value or the defaultValue if there is no such header or the header value is not a number

setIntHeader

public static void setIntHeader(HttpMessage message,
                                java.lang.String name,
                                int value)

See Also:

setIntHeader(HttpMessage, CharSequence, int)

setIntHeader

public static void setIntHeader(HttpMessage message,
                                java.lang.CharSequence name,
                                int value)

Sets a new integer header with the specified name and value. If there is an existing header with the same name, the existing header is removed.

setIntHeader

public static void setIntHeader(HttpMessage message,
                                java.lang.String name,
                                java.lang.Iterable<java.lang.Integer> values)

See Also:

setIntHeader(HttpMessage, CharSequence, Iterable)

setIntHeader

public static void setIntHeader(HttpMessage message,
                                java.lang.CharSequence name,
                                java.lang.Iterable<java.lang.Integer> values)

Sets a new integer header with the specified name and values. If there is an existing header with the same name, the existing header is removed.

addIntHeader

public static void addIntHeader(HttpMessage message,
                                java.lang.String name,
                                int value)

See Also:

addIntHeader(HttpMessage, CharSequence, int)

addIntHeader

public static void addIntHeader(HttpMessage message,
                                java.lang.CharSequence name,
                                int value)

Adds a new integer header with the specified name and value.

getDateHeader

public static java.util.Date getDateHeader(HttpMessage message,
                                           java.lang.String name)
                                    throws java.text.ParseException

Throws:

java.text.ParseException

See Also:

getDateHeader(HttpMessage, CharSequence)

getDateHeader

public static java.util.Date getDateHeader(HttpMessage message,
                                           java.lang.CharSequence name)
                                    throws java.text.ParseException

Returns the date header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned.

Returns:

the header value

Throws:

java.text.ParseException - if there is no such header or the header value is not a formatted date

getDateHeader

public static java.util.Date getDateHeader(HttpMessage message,
                                           java.lang.String name,
                                           java.util.Date defaultValue)

See Also:

getDateHeader(HttpMessage, CharSequence, Date)

getDateHeader

public static java.util.Date getDateHeader(HttpMessage message,
                                           java.lang.CharSequence name,
                                           java.util.Date defaultValue)

Returns the date header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned.

Returns:

the header value or the defaultValue if there is no such header or the header value is not a formatted date

setDateHeader

public static void setDateHeader(HttpMessage message,
                                 java.lang.String name,
                                 java.util.Date value)

See Also:

setDateHeader(HttpMessage, CharSequence, Date)

setDateHeader

public static void setDateHeader(HttpMessage message,
                                 java.lang.CharSequence name,
                                 java.util.Date value)

Sets a new date header with the specified name and value. If there is an existing header with the same name, the existing header is removed. The specified value is formatted as defined in RFC2616

setDateHeader

public static void setDateHeader(HttpMessage message,
                                 java.lang.String name,
                                 java.lang.Iterable<java.util.Date> values)

See Also:

setDateHeader(HttpMessage, CharSequence, Iterable)

setDateHeader

public static void setDateHeader(HttpMessage message,
                                 java.lang.CharSequence name,
                                 java.lang.Iterable<java.util.Date> values)

Sets a new date header with the specified name and values. If there is an existing header with the same name, the existing header is removed. The specified values are formatted as defined in RFC2616

addDateHeader

public static void addDateHeader(HttpMessage message,
                                 java.lang.String name,
                                 java.util.Date value)

See Also:

addDateHeader(HttpMessage, CharSequence, Date)

addDateHeader

public static void addDateHeader(HttpMessage message,
                                 java.lang.CharSequence name,
                                 java.util.Date value)

Adds a new date header with the specified name and value. The specified value is formatted as defined in RFC2616

getContentLength

public static long getContentLength(HttpMessage message)

Returns the length of the content. Please note that this value is not retrieved from ByteBufHolder.content() but from the "Content-Length" header, and thus they are independent from each other.

Returns:

the content length

Throws:

java.lang.NumberFormatException - if the message does not have the "Content-Length" header or its value is not a number

getContentLength

public static long getContentLength(HttpMessage message,
                                    long defaultValue)

Returns the length of the content. Please note that this value is not retrieved from ByteBufHolder.content() but from the "Content-Length" header, and thus they are independent from each other.

Returns:

the content length or defaultValue if this message does not have the "Content-Length" header or its value is not a number

setContentLength

public static void setContentLength(HttpMessage message,
                                    long length)

Sets the "Content-Length" header.

getHost

public static java.lang.String getHost(HttpMessage message)

Returns the value of the "Host" header.

getHost

public static java.lang.String getHost(HttpMessage message,
                                       java.lang.String defaultValue)

Returns the value of the "Host" header. If there is no such header, the defaultValue is returned.

setHost

public static void setHost(HttpMessage message,
                           java.lang.String value)

See Also:

setHost(HttpMessage, CharSequence)

setHost

public static void setHost(HttpMessage message,
                           java.lang.CharSequence value)

Sets the "Host" header.

getDate

public static java.util.Date getDate(HttpMessage message)
                              throws java.text.ParseException

Returns the value of the "Date" header.

Throws:

java.text.ParseException - if there is no such header or the header value is not a formatted date

getDate

public static java.util.Date getDate(HttpMessage message,
                                     java.util.Date defaultValue)

Returns the value of the "Date" header. If there is no such header or the header is not a formatted date, the defaultValue is returned.

setDate

public static void setDate(HttpMessage message,
                           java.util.Date value)

Sets the "Date" header.

is100ContinueExpected

public static boolean is100ContinueExpected(HttpMessage message)

Returns true if and only if the specified message contains the "Expect: 100-continue" header.

set100ContinueExpected

public static void set100ContinueExpected(HttpMessage message)

Sets the "Expect: 100-continue" header to the specified message. If there is any existing "Expect" header, they are replaced with the new one.

set100ContinueExpected

public static void set100ContinueExpected(HttpMessage message,
                                          boolean set)

Sets or removes the "Expect: 100-continue" header to / from the specified message. If set is true, the "Expect: 100-continue" header is set and all other previous "Expect" headers are removed. Otherwise, all "Expect" headers are removed completely.

isTransferEncodingChunked

public static boolean isTransferEncodingChunked(HttpMessage message)

Checks to see if the transfer encoding in a specified HttpMessage is chunked

Parameters:

message - The message to check

Returns:

True if transfer encoding is chunked, otherwise false

removeTransferEncodingChunked

public static void removeTransferEncodingChunked(HttpMessage m)

setTransferEncodingChunked

public static void setTransferEncodingChunked(HttpMessage m)

isContentLengthSet

public static boolean isContentLengthSet(HttpMessage m)

equalsIgnoreCase

public static boolean equalsIgnoreCase(java.lang.CharSequence name1,
                                       java.lang.CharSequence name2)

Returns true if both CharSequence's are equals when ignore the case. This only supports US_ASCII.

encodeAscii

public static boolean encodeAscii(java.lang.CharSequence seq,
                                  ByteBuf buf)

newEntity

public static java.lang.CharSequence newEntity(java.lang.String name)

Create a new CharSequence which is optimized for reuse as HttpHeaders name or value. So if you have a Header name or value that you want to reuse you should make use of this.

newNameEntity

public static java.lang.CharSequence newNameEntity(java.lang.String name)

Create a new CharSequence which is optimized for reuse as HttpHeaders name. So if you have a Header name that you want to reuse you should make use of this.

newValueEntity

public static java.lang.CharSequence newValueEntity(java.lang.String name)

Create a new CharSequence which is optimized for reuse as HttpHeaders value. So if you have a Header value that you want to reuse you should make use of this.

get

public abstract java.lang.String get(java.lang.String name)

See Also:

#get(CharSequence)}

get

public java.lang.String get(java.lang.CharSequence name)

Returns the value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

Parameters:

name - The name of the header to search

Returns:

The first header value or null if there is no such header

getAll

public abstract java.util.List<java.lang.String> getAll(java.lang.String name)

See Also:

#getAll(CharSequence)}

getAll

public java.util.List<java.lang.String> getAll(java.lang.CharSequence name)

Returns the values of headers with the specified name

Parameters:

name - The name of the headers to search

Returns:

A List of header values which will be empty if no values are found

entries

public abstract java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> entries()

Returns a new List that contains all headers in this object. Note that modifying the returned List will not affect the state of this object. If you intend to enumerate over the header entries only, use Iterable.iterator() instead, which has much less overhead.

contains

public abstract boolean contains(java.lang.String name)

See Also:

contains(CharSequence)

contains

public boolean contains(java.lang.CharSequence name)

Checks to see if there is a header with the specified name

Parameters:

name - The name of the header to search for

Returns:

True if at least one header is found

isEmpty

public abstract boolean isEmpty()

Checks if no header exists.

names

public abstract java.util.Set<java.lang.String> names()

Returns a new Set that contains the names of all headers in this object. Note that modifying the returned Set will not affect the state of this object. If you intend to enumerate over the header entries only, use Iterable.iterator() instead, which has much less overhead.

add

public abstract HttpHeaders add(java.lang.String name,
                                java.lang.Object value)

See Also:

#add(CharSequence, Object)}

add

public HttpHeaders add(java.lang.CharSequence name,
                       java.lang.Object value)

Adds a new header with the specified name and value. If the specified value is not a String, it is converted into a String by Object.toString(), except in the cases of Date and Calendar, which are formatted to the date format defined in RFC2616.

Parameters:

name - The name of the header being added

value - The value of the header being added

Returns:

this

add

public abstract HttpHeaders add(java.lang.String name,
                                java.lang.Iterable<?> values)

See Also:

#add(CharSequence, Iterable)}

add

public HttpHeaders add(java.lang.CharSequence name,
                       java.lang.Iterable<?> values)

Adds a new header with the specified name and values. This getMethod can be represented approximately as the following code:

 for (Object v: values) {
     if (v == null) {
         break;
     }
     headers.add(name, v);
 }
 

Parameters:

name - The name of the headers being set

values - The values of the headers being set

Returns:

this

add

public HttpHeaders add(HttpHeaders headers)

Adds all header entries of the specified headers.

Returns:

this

set

public abstract HttpHeaders set(java.lang.String name,
                                java.lang.Object value)

See Also:

#set(CharSequence, Object)}

set

public HttpHeaders set(java.lang.CharSequence name,
                       java.lang.Object value)

Sets a header with the specified name and value. If there is an existing header with the same name, it is removed. If the specified value is not a String, it is converted into a String by Object.toString(), except for Date and Calendar, which are formatted to the date format defined in RFC2616.

Parameters:

name - The name of the header being set

value - The value of the header being set

Returns:

this

set

public abstract HttpHeaders set(java.lang.String name,
                                java.lang.Iterable<?> values)

See Also:

#set(CharSequence, Iterable)}

set

public HttpHeaders set(java.lang.CharSequence name,
                       java.lang.Iterable<?> values)

Sets a header with the specified name and values. If there is an existing header with the same name, it is removed. This getMethod can be represented approximately as the following code:

 headers.remove(name);
 for (Object v: values) {
     if (v == null) {
         break;
     }
     headers.add(name, v);
 }
 

Parameters:

name - The name of the headers being set

values - The values of the headers being set

Returns:

this

set

public HttpHeaders set(HttpHeaders headers)

Cleans the current header entries and copies all header entries of the specified headers.

Returns:

this

remove

public abstract HttpHeaders remove(java.lang.String name)

See Also:

#remove(CharSequence)}

remove

public HttpHeaders remove(java.lang.CharSequence name)

Removes the header with the specified name.

Parameters:

name - The name of the header to remove

Returns:

this

clear

public abstract HttpHeaders clear()

Removes all headers from this HttpMessage.

Returns:

this

contains

public boolean contains(java.lang.String name,
                        java.lang.String value,
                        boolean ignoreCaseValue)

See Also:

#contains(CharSequence, CharSequence, boolean)}

containsValue

public boolean containsValue(java.lang.CharSequence name,
                             java.lang.CharSequence value,
                             boolean ignoreCase)

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

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

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.

contains

public boolean contains(java.lang.CharSequence name,
                        java.lang.CharSequence value,
                        boolean ignoreCaseValue)

Returns true if a header with the name and value exists.

Parameters:

name - the headername

value - the value

ignoreCaseValue - true if case should be ignored

Returns:

contains true if it contains it false otherwise