io.netty.handler.codec.http

Interface HttpMessage

All Known Subinterfaces:

HttpRequest, HttpResponse

All Known Implementing Classes:

DefaultHttpMessage, DefaultHttpRequest, DefaultHttpResponse

public interface HttpMessage

An interface that defines a HTTP message, providing common properties for HttpRequest and HttpResponse.

See Also:

HttpResponse, HttpRequest, HttpHeaders

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(String name, Object value) Adds a new header with the specified name and value.
void	clearHeaders() Removes all headers from this HttpMessage.
boolean	containsHeader(String name) Checks to see if there is a header with the specified name
io.netty.buffer.ByteBuf	getContent() Returns the content of this HttpMessage.
String	getHeader(String name) Returns the value of a header with the specified name.
Set<String>	getHeaderNames() Gets a Set of all header names that this message contains
List<Map.Entry<String,String>>	getHeaders() Returns the all headers that this message contains.
List<String>	getHeaders(String name) Returns the values of headers with the specified name
HttpVersion	getProtocolVersion() Returns the protocol version of this HttpMessage
HttpTransferEncoding	getTransferEncoding() Returns the transfer encoding of this HttpMessage.
void	removeHeader(String name) Removes the header with the specified name.
void	setContent(io.netty.buffer.ByteBuf content) Sets the content of this HttpMessage.
void	setHeader(String name, Iterable<?> values) Sets a header with the specified name and values.
void	setHeader(String name, Object value) Sets a header with the specified name and value.
void	setProtocolVersion(HttpVersion version) Sets the protocol version of this HttpMessage
void	setTransferEncoding(HttpTransferEncoding te) Sets the transfer encoding of this HttpMessage.

Method Detail

getHeader

String getHeader(String 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

getHeaders

List<String> getHeaders(String 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

getHeaders

List<Map.Entry<String,String>> getHeaders()

Returns the all headers that this message contains.

Returns:

A List of the header name-value entries, which will be empty if no pairs are found

containsHeader

boolean containsHeader(String 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

getHeaderNames

Set<String> getHeaderNames()

Gets a Set of all header names that this message contains

Returns:

A Set of all header names

getProtocolVersion

HttpVersion getProtocolVersion()

Returns the protocol version of this HttpMessage

setProtocolVersion

void setProtocolVersion(HttpVersion version)

Sets the protocol version of this HttpMessage

Parameters:

version - The version to set

getContent

io.netty.buffer.ByteBuf getContent()

Returns the content of this HttpMessage. If there is no content or getTransferEncoding() returns HttpTransferEncoding.STREAMED or HttpTransferEncoding.CHUNKED, an Unpooled.EMPTY_BUFFER is returned.

Returns:

A ByteBuf containing this HttpMessage's content

setContent

void setContent(io.netty.buffer.ByteBuf content)

Sets the content of this HttpMessage. If null is specified, the content of this message will be set to Unpooled.EMPTY_BUFFER

Parameters:

content - The ByteBuf containing the content to use

addHeader

void addHeader(String name,
             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

setHeader

void setHeader(String name,
             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

setHeader

void setHeader(String name,
             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 method can be represented approximately as the following code:

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

Parameters:

name - The name of the headers being set

values - The values of the headers being set

removeHeader

void removeHeader(String name)

Removes the header with the specified name.

Parameters:

name - The name of the header to remove

clearHeaders

void clearHeaders()

Removes all headers from this HttpMessage.

getTransferEncoding

HttpTransferEncoding getTransferEncoding()

Returns the transfer encoding of this HttpMessage.

• HttpTransferEncoding.CHUNKED - an HTTP message whose "Transfer-Encoding" is "chunked".
• HttpTransferEncoding.STREAMED - an HTTP message which is not chunked, but is followed by HttpChunks that represent its content. getContent() returns an empty buffer.
• HttpTransferEncoding.SINGLE - a self-contained HTTP message which is not chunked and getContent() returns the full content.

setTransferEncoding

void setTransferEncoding(HttpTransferEncoding te)

Sets the transfer encoding of this HttpMessage.

• If set to HttpTransferEncoding.CHUNKED, the "Transfer-Encoding: chunked" header is set and the "Content-Length" header and the content of this message are removed automatically.
• If set to HttpTransferEncoding.STREAMED, the "Transfer-Encoding: chunked" header and the content of this message are removed automatically.
• If set to HttpTransferEncoding.SINGLE, the "Transfer-Encoding: chunked" header is removed automatically.

For more information about what HttpTransferEncoding means, see getTransferEncoding().