A combination of HttpRequestDecoder and HttpResponseEncoder which enables easier server side HTTP implementation.

Header Validation

It is recommended to always enable header validation.

Without header validation, your system can become vulnerable to CWE-113: Improper Neutralization of CRLF Sequences in HTTP Headers ('HTTP Response Splitting') .

This recommendation stands even when both peers in the HTTP exchange are trusted, as it helps with defence-in-depth.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	HttpServerCodec.HttpServerRequestDecoder
private class	HttpServerCodec.HttpServerResponseEncoder

Field Summary

Modifier and Type	Field and Description
private final Queue<HttpMethod>	queue A queue that is used for correlating a request and a response.

Constructor Summary

Access	Constructor and Description
public	HttpServerCodec() Creates a new instance with the default decoder options (`maxInitialLineLength (4096)`, `maxHeaderSize (8192)`, and `maxChunkSize (8192)`).
public	HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize) Creates a new instance with the specified decoder options.
public	HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders) Deprecated Prefer the `HttpServerCodec(HttpDecoderConfig)` constructor, to always enable header validation. Creates a new instance with the specified decoder options.
public	HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize) Deprecated Prefer the `HttpServerCodec(HttpDecoderConfig)` constructor, to always enable header validation. Creates a new instance with the specified decoder options.
public	HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths) Deprecated Prefer the `HttpServerCodec(HttpDecoderConfig)` constructor, to always enable header validation. Creates a new instance with the specified decoder options.
public	HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths, boolean allowPartialChunks) Deprecated Prefer the `HttpServerCodec(HttpDecoderConfig)` constructor, to always enable header validation. Creates a new instance with the specified decoder options.
public	HttpServerCodec(HttpDecoderConfig config) Creates a new instance with the specified decoder configuration.

Modifier and Type	Method and Description
public void	upgradeFrom(ChannelHandlerContext ctx) Implements io.netty.handler.codec.http.HttpServerUpgradeHandler.SourceCodec.upgradeFrom. Upgrades to another protocol from HTTP.

Field Detail

queue	back to summary
private final Queue<HttpMethod> queue A queue that is used for correlating a request and a response.

Constructor Detail

HttpServerCodec	back to summary
public HttpServerCodec() Creates a new instance with the default decoder options (`maxInitialLineLength (4096)`, `maxHeaderSize (8192)`, and `maxChunkSize (8192)`).

HttpServerCodec	back to summary
public HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize) Creates a new instance with the specified decoder options.

HttpServerCodec back to summary

HttpServerCodec	back to summary
public HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders) Deprecated Prefer the `HttpServerCodec(HttpDecoderConfig)` constructor, to always enable header validation. Creates a new instance with the specified decoder options. Annotations @Deprecated

public HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders)

Deprecated

Prefer the HttpServerCodec(HttpDecoderConfig) constructor, to always enable header validation.

Creates a new instance with the specified decoder options.

Annotations

@Deprecated

HttpServerCodec back to summary

HttpServerCodec	back to summary
public HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize) Deprecated Prefer the `HttpServerCodec(HttpDecoderConfig)` constructor, to always enable header validation. Creates a new instance with the specified decoder options. Annotations @Deprecated

public HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize)

Deprecated

Prefer the HttpServerCodec(HttpDecoderConfig) constructor, to always enable header validation.

Creates a new instance with the specified decoder options.

Annotations

@Deprecated

HttpServerCodec back to summary

HttpServerCodec	back to summary
public HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths) Deprecated Prefer the `HttpServerCodec(HttpDecoderConfig)` constructor, to always enable header validation. Creates a new instance with the specified decoder options. Annotations @Deprecated

public HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths)

Deprecated

Prefer the HttpServerCodec(HttpDecoderConfig) constructor, to always enable header validation.

Creates a new instance with the specified decoder options.

Annotations

@Deprecated

HttpServerCodec back to summary

HttpServerCodec	back to summary
public HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths, boolean allowPartialChunks) Deprecated Prefer the `HttpServerCodec(HttpDecoderConfig)` constructor, to always enable header validation. Creates a new instance with the specified decoder options. Annotations @Deprecated

public HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths, boolean allowPartialChunks)

Deprecated

Prefer the HttpServerCodec(HttpDecoderConfig) constructor, to always enable header validation.

Creates a new instance with the specified decoder options.

Annotations

@Deprecated

HttpServerCodec	back to summary
public HttpServerCodec(HttpDecoderConfig config) Creates a new instance with the specified decoder configuration.

upgradeFrom	back to summary
public void upgradeFrom(ChannelHandlerContext ctx) Implements io.netty.handler.codec.http.HttpServerUpgradeHandler.SourceCodec.upgradeFrom. Upgrades to another protocol from HTTP. Removes the `HttpRequestDecoder` and `HttpResponseEncoder` from the pipeline. Annotations @Override

io.netty.handler.codec.http back to summary

private final Class HttpServerCodec.HttpServerRequestDecoder

Class Inheritance

extends HttpRequestDecoder

java.lang.Object
io.netty.channel.ChannelHandlerAdapter
io.netty.channel.ChannelInboundHandlerAdapter
io.netty.handler.codec.ByteToMessageDecoder
io.netty.handler.codec.http.HttpObjectDecoder
io.netty.handler.codec.http.HttpRequestDecoder
io.netty.handler.codec.http.HttpServerCodec.HttpServerRequestDecoder

Constructor Summary

Access	Constructor and Description
pack-priv	HttpServerRequestDecoder(HttpDecoderConfig config)

Method Summary

Modifier and Type	Method and Description
protected void	decode(ChannelHandlerContext the `ChannelHandlerContext` which this `ByteToMessageDecoder` belongs to ctx, ByteBuf the `ByteBuf` from which to read data buffer, List<Object> the `List` to which decoded messages should be added out) Overrides io.netty.handler.codec.http.HttpObjectDecoder.decode. Decode the from one `ByteBuf` to an other.

Inherited from io.netty.handler.codec.http.HttpRequestDecoder:: createInvalidMessage createMessage isContentAlwaysEmpty isDecodingRequest splitFirstWordInitialLine splitHeaderName splitThirdWordInitialLine

Constructor Detail

HttpServerRequestDecoder	back to summary
pack-priv HttpServerRequestDecoder(HttpDecoderConfig config)

Method Detail

decode back to summary

decode	back to summary
protected void decode(ChannelHandlerContext ctx, ByteBuf buffer, List<Object> out) throws Exception Overrides io.netty.handler.codec.http.HttpObjectDecoder.decode. Doc from io.netty.handler.codec.ByteToMessageDecoder.decode. Decode the from one `ByteBuf` to an other. This method will be called till either the input `ByteBuf` has nothing to read when return from this method or till nothing was read from the input `ByteBuf`. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `ByteToMessageDecoder` belongs to buffer:ByteBuf the `ByteBuf` from which to read data out:List<Object> the `List` to which decoded messages should be added Annotations @Override Exceptions Exception: is thrown if an error occurs

protected void decode(ChannelHandlerContext ctx, ByteBuf buffer, List<Object> out) throws Exception

Overrides io.netty.handler.codec.http.HttpObjectDecoder.decode.

Doc from io.netty.handler.codec.ByteToMessageDecoder.decode.

Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read when return from this method or till nothing was read from the input ByteBuf.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this ByteToMessageDecoder belongs to
buffer:ByteBuf: the ByteBuf from which to read data
out:List<Object>: the List to which decoded messages should be added

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs

io.netty.handler.codec.http back to summary

private final Class HttpServerCodec.HttpServerResponseEncoder

Class Inheritance

extends HttpResponseEncoder

java.lang.Object
io.netty.channel.ChannelHandlerAdapter
io.netty.channel.ChannelOutboundHandlerAdapter
io.netty.handler.codec.MessageToMessageEncoder
io.netty.handler.codec.http.HttpObjectEncoder
io.netty.handler.codec.http.HttpResponseEncoder
io.netty.handler.codec.http.HttpServerCodec.HttpServerResponseEncoder

Field Summary

Modifier and Type	Field and Description
private HttpMethod	method

Constructor Summary

Access	Constructor and Description
private	HttpServerResponseEncoder()

Method Summary

Modifier and Type	Method and Description
protected boolean	isContentAlwaysEmpty(HttpResponse the message to test msg) Overrides io.netty.handler.codec.http.HttpResponseEncoder.isContentAlwaysEmpty. Determine whether a message has a content or not.
protected void	sanitizeHeadersBeforeEncode(HttpResponse msg, boolean isAlwaysEmpty) Overrides io.netty.handler.codec.http.HttpResponseEncoder.sanitizeHeadersBeforeEncode. Allows to sanitize headers of the message before encoding these.

Inherited from io.netty.handler.codec.http.HttpResponseEncoder:: acceptOutboundMessage encodeInitialLine

Field Detail

method	back to summary
private HttpMethod method

Constructor Detail

HttpServerResponseEncoder	back to summary
private HttpServerResponseEncoder()

Method Detail

isContentAlwaysEmpty back to summary

isContentAlwaysEmpty	back to summary
protected boolean isContentAlwaysEmpty(HttpResponse msg) Overrides io.netty.handler.codec.http.HttpResponseEncoder.isContentAlwaysEmpty. Doc from io.netty.handler.codec.http.HttpObjectEncoder.isContentAlwaysEmpty. Determine whether a message has a content or not. Some message may have headers indicating a content without having an actual content, e.g the response to an HEAD or CONNECT request. Parameters msg:HttpResponse the message to test Returns:boolean `true` to signal the message has no content Annotations @Override

protected boolean isContentAlwaysEmpty(HttpResponse msg)

Overrides io.netty.handler.codec.http.HttpResponseEncoder.isContentAlwaysEmpty.

Doc from io.netty.handler.codec.http.HttpObjectEncoder.isContentAlwaysEmpty.

Determine whether a message has a content or not. Some message may have headers indicating a content without having an actual content, e.g the response to an HEAD or CONNECT request.

Parameters

msg:HttpResponse: the message to test

Returns:boolean

true to signal the message has no content

Annotations

@Override

sanitizeHeadersBeforeEncode	back to summary
protected void sanitizeHeadersBeforeEncode(HttpResponse msg, boolean isAlwaysEmpty) Overrides io.netty.handler.codec.http.HttpResponseEncoder.sanitizeHeadersBeforeEncode. Doc from io.netty.handler.codec.http.HttpObjectEncoder.sanitizeHeadersBeforeEncode. Allows to sanitize headers of the message before encoding these. Annotations @Override

sanitizeHeadersBeforeEncode

back to summary

protected void sanitizeHeadersBeforeEncode(HttpResponse msg, boolean isAlwaysEmpty)

Overrides io.netty.handler.codec.http.HttpResponseEncoder.sanitizeHeadersBeforeEncode.

Doc from io.netty.handler.codec.http.HttpObjectEncoder.sanitizeHeadersBeforeEncode.

Allows to sanitize headers of the message before encoding these.

Annotations

@Override

public final Class HttpServerCodec

Header Validation

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class HttpServerCodec.HttpServerRequestDecoder

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class HttpServerCodec.HttpServerResponseEncoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail