Package io.netty.handler.codec.http2

Class Http2StreamFrameToHttpObjectCodec

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.codec.MessageToMessageCodec<Http2StreamFrame,HttpObject>

io.netty.handler.codec.http2.Http2StreamFrameToHttpObjectCodec

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

@Sharable
public class Http2StreamFrameToHttpObjectCodec
extends MessageToMessageCodec<Http2StreamFrame,HttpObject>

This handler converts from Http2StreamFrame to HttpObject, and back. It can be used as an adapter in conjunction with Http2MultiplexCodec to make http/2 connections backward-compatible with ChannelHandlers expecting HttpObject For simplicity, it converts to chunked encoding unless the entire stream is a single header.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	isServer
private static final AttributeKey<HttpScheme>	SCHEME_ATTR_KEY
private final boolean	validateHeaders

Constructor Summary

Constructors

Constructor	Description
Http2StreamFrameToHttpObjectCodec(boolean isServer)
Http2StreamFrameToHttpObjectCodec(boolean isServer, boolean validateHeaders)

Method Summary

Modifier and Type	Method	Description
boolean	acceptInboundMessage(Object msg)	Returns true if and only if the specified message can be decoded by this codec.
private static Channel	connectionChannel(ChannelHandlerContext ctx)
private static HttpScheme	connectionScheme(ChannelHandlerContext ctx)
private static Attribute<HttpScheme>	connectionSchemeAttribute(ChannelHandlerContext ctx)
protected void	decode(ChannelHandlerContext ctx, Http2StreamFrame frame, List<Object> out)
protected void	encode(ChannelHandlerContext ctx, HttpObject obj, List<Object> out)	Encode from an HttpObject to an Http2StreamFrame.
private void	encodeLastContent(LastHttpContent last, List<Object> out)
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
private static boolean	isContentAlwaysEmpty(CharSequence status)
private static boolean	isInformationalResponseHeaderFrame(CharSequence status)	An informational response using a 1xx status code other than 101 is transmitted as a HEADERS frame
protected boolean	isSsl(ChannelHandlerContext ctx)
private FullHttpMessage	newFullMessage(int id, Http2Headers headers, ByteBufAllocator alloc)
private HttpMessage	newMessage(int id, Http2Headers headers)
private Http2Headers	toHttp2Headers(ChannelHandlerContext ctx, HttpMessage msg)

Methods inherited from class io.netty.handler.codec.MessageToMessageCodec

acceptOutboundMessage, channelRead, channelReadComplete, write

Methods inherited from class io.netty.channel.ChannelDuplexHandler

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerRemoved

Field Details

SCHEME_ATTR_KEY

private static final AttributeKey<HttpScheme> SCHEME_ATTR_KEY

isServer

private final boolean isServer

validateHeaders

private final boolean validateHeaders

Constructor Details

Http2StreamFrameToHttpObjectCodec

public Http2StreamFrameToHttpObjectCodec(boolean isServer,
 boolean validateHeaders)

Http2StreamFrameToHttpObjectCodec

public Http2StreamFrameToHttpObjectCodec(boolean isServer)

Method Details

acceptInboundMessage

public boolean acceptInboundMessage(Object msg)
                             throws Exception

Description copied from class: MessageToMessageCodec

Returns true if and only if the specified message can be decoded by this codec.

Overrides:

acceptInboundMessage in class MessageToMessageCodec<Http2StreamFrame,HttpObject>

Parameters:

msg - the message

Throws:

Exception

decode

protected void decode(ChannelHandlerContext ctx,
 Http2StreamFrame frame,
 List<Object> out)
               throws Exception

Specified by:

decode in class MessageToMessageCodec<Http2StreamFrame,HttpObject>

Throws:

Exception

See Also:

• MessageToMessageDecoder.decode(ChannelHandlerContext, Object, List)

encodeLastContent

private void encodeLastContent(LastHttpContent last,
 List<Object> out)

encode

protected void encode(ChannelHandlerContext ctx,
 HttpObject obj,
 List<Object> out)
               throws Exception

Encode from an HttpObject to an Http2StreamFrame. This method will be called for each written message that can be handled by this encoder. NOTE: 100-Continue responses that are NOT FullHttpResponse will be rejected.

Specified by:

encode in class MessageToMessageCodec<Http2StreamFrame,HttpObject>

Parameters:

ctx - the ChannelHandlerContext which this handler belongs to

obj - the HttpObject message to encode

out - the List into which the encoded msg should be added needs to do some kind of aggregation

Throws:

Exception - is thrown if an error occurs

See Also:

• MessageToMessageEncoder.encode(ChannelHandlerContext, Object, List)

toHttp2Headers

private Http2Headers toHttp2Headers(ChannelHandlerContext ctx,
 HttpMessage msg)

newMessage

private HttpMessage newMessage(int id,
 Http2Headers headers)
                        throws Http2Exception

Throws:

Http2Exception

newFullMessage

private FullHttpMessage newFullMessage(int id,
 Http2Headers headers,
 ByteBufAllocator alloc)
                                throws Http2Exception

Throws:

Http2Exception

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws Exception

Description copied from class: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

Specified by:

handlerAdded in interface ChannelHandler

Overrides:

handlerAdded in class ChannelHandlerAdapter

Throws:

Exception

isSsl

protected boolean isSsl(ChannelHandlerContext ctx)

connectionScheme

private static HttpScheme connectionScheme(ChannelHandlerContext ctx)

connectionSchemeAttribute

private static Attribute<HttpScheme> connectionSchemeAttribute(ChannelHandlerContext ctx)

connectionChannel

private static Channel connectionChannel(ChannelHandlerContext ctx)

isInformationalResponseHeaderFrame

private static boolean isInformationalResponseHeaderFrame(CharSequence status)

An informational response using a 1xx status code other than 101 is transmitted as a HEADERS frame

isContentAlwaysEmpty

private static boolean isContentAlwaysEmpty(CharSequence status)