Class HttpServerCodec

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.channel.CombinedChannelDuplexHandler<HttpRequestDecoder, HttpResponseEncoder>

io.netty.handler.codec.http.HttpServerCodec

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler, HttpServerUpgradeHandler.SourceCodec

public final class HttpServerCodec
extends CombinedChannelDuplexHandler<HttpRequestDecoder, HttpResponseEncoder>
implements HttpServerUpgradeHandler.SourceCodec

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.

See Also:

• HttpClientCodec

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor	Description
HttpServerCodec()	Creates a new instance with the default decoder options (maxInitialLineLength (4096), maxHeaderSize (8192), and maxChunkSize (8192)).
HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize)	Creates a new instance with the specified decoder options.
HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders)	Deprecated. Prefer the HttpServerCodec(HttpDecoderConfig) constructor, to always enable header validation.
HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize)	Deprecated. Prefer the HttpServerCodec(HttpDecoderConfig) constructor, to always enable header validation.
HttpServerCodec(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths)	Deprecated. Prefer the HttpServerCodec(HttpDecoderConfig) constructor, to always enable header validation.
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.
HttpServerCodec(HttpDecoderConfig config)	Creates a new instance with the specified decoder configuration.

Method Summary

Modifier and Type	Method	Description
void	upgradeFrom(ChannelHandlerContext ctx)	Upgrades to another protocol from HTTP.

Methods inherited from class CombinedChannelDuplexHandler

bind, channelActive, channelInactive, channelRead, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, exceptionCaught, flush, handlerAdded, handlerRemoved, inboundHandler, init, outboundHandler, read, removeInboundHandler, removeOutboundHandler, userEventTriggered, write

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, isSharable

Methods inherited from class Object

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

Constructor Details

HttpServerCodec

public HttpServerCodec()

Creates a new instance with the default decoder options (maxInitialLineLength (4096), maxHeaderSize (8192), and maxChunkSize (8192)).

HttpServerCodec

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

Creates a new instance with the specified decoder options.

HttpServerCodec

@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.

HttpServerCodec

@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.

HttpServerCodec

@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.

HttpServerCodec

@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.

HttpServerCodec

public HttpServerCodec(HttpDecoderConfig config)

Creates a new instance with the specified decoder configuration.

Method Details

upgradeFrom

public void upgradeFrom(ChannelHandlerContext ctx)

Upgrades to another protocol from HTTP. Removes the HttpRequestDecoder and HttpResponseEncoder from the pipeline.

Specified by:

upgradeFrom in interface HttpServerUpgradeHandler.SourceCodec