io.netty.handler.codec.http

Class DefaultHttpMessage

java.lang.Object

io.netty.handler.codec.http.DefaultHttpMessage

All Implemented Interfaces:

HttpMessage

Direct Known Subclasses:

DefaultHttpRequest, DefaultHttpResponse

public class DefaultHttpMessage
extends Object
implements HttpMessage

The default HttpMessage implementation.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultHttpMessage(HttpVersion version) Creates a new instance.

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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHttpMessage

protected DefaultHttpMessage(HttpVersion version)

Creates a new instance.

Method Detail

addHeader

public void addHeader(String name,
             Object value)

Description copied from interface: HttpMessage

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.

Specified by:

addHeader in interface HttpMessage

Parameters:

name - The name of the header being added

value - The value of the header being added

setHeader

public void setHeader(String name,
             Object value)

Description copied from interface: HttpMessage

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.

Specified by:

setHeader in interface HttpMessage

Parameters:

name - The name of the header being set

value - The value of the header being set

setHeader

public void setHeader(String name,
             Iterable<?> values)

Description copied from interface: HttpMessage

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);
 }
 

Specified by:

setHeader in interface HttpMessage

Parameters:

name - The name of the headers being set

values - The values of the headers being set

removeHeader

public void removeHeader(String name)

Description copied from interface: HttpMessage

Removes the header with the specified name.

Specified by:

removeHeader in interface HttpMessage

Parameters:

name - The name of the header to remove

getTransferEncoding

public HttpTransferEncoding getTransferEncoding()

Description copied from interface: HttpMessage

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. HttpMessage.getContent() returns an empty buffer.
• HttpTransferEncoding.SINGLE - a self-contained HTTP message which is not chunked and HttpMessage.getContent() returns the full content.

Specified by:

getTransferEncoding in interface HttpMessage

setTransferEncoding

public void setTransferEncoding(HttpTransferEncoding te)

Description copied from interface: HttpMessage

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 HttpMessage.getTransferEncoding().

Specified by:

setTransferEncoding in interface HttpMessage

clearHeaders

public void clearHeaders()

Description copied from interface: HttpMessage

Removes all headers from this HttpMessage.

Specified by:

clearHeaders in interface HttpMessage

setContent

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

Description copied from interface: HttpMessage

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

Specified by:

setContent in interface HttpMessage

Parameters:

content - The ByteBuf containing the content to use

getHeader

public String getHeader(String name)

Description copied from interface: HttpMessage

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.

Specified by:

getHeader in interface HttpMessage

Parameters:

name - The name of the header to search

Returns:

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

getHeaders

public List<String> getHeaders(String name)

Description copied from interface: HttpMessage

Returns the values of headers with the specified name

Specified by:

getHeaders in interface HttpMessage

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

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

Description copied from interface: HttpMessage

Returns the all headers that this message contains.

Specified by:

getHeaders in interface HttpMessage

Returns:

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

containsHeader

public boolean containsHeader(String name)

Description copied from interface: HttpMessage

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

Specified by:

containsHeader in interface HttpMessage

Parameters:

name - The name of the header to search for

Returns:

True if at least one header is found

getHeaderNames

public Set<String> getHeaderNames()

Description copied from interface: HttpMessage

Gets a Set of all header names that this message contains

Specified by:

getHeaderNames in interface HttpMessage

Returns:

A Set of all header names

getProtocolVersion

public HttpVersion getProtocolVersion()

Description copied from interface: HttpMessage

Returns the protocol version of this HttpMessage

Specified by:

getProtocolVersion in interface HttpMessage

setProtocolVersion

public void setProtocolVersion(HttpVersion version)

Description copied from interface: HttpMessage

Sets the protocol version of this HttpMessage

Specified by:

setProtocolVersion in interface HttpMessage

Parameters:

version - The version to set

getContent

public io.netty.buffer.ByteBuf getContent()

Description copied from interface: HttpMessage

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

Specified by:

getContent in interface HttpMessage

Returns:

A ByteBuf containing this HttpMessage's content

toString

public String toString()

Overrides:

toString in class Object