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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	acceptInboundMessage(java.lang.Object msg)	Returns true if and only if the specified message can be decoded by this codec.
protected void	decode(ChannelHandlerContext ctx, Http2StreamFrame frame, java.util.List<java.lang.Object> out)
protected void	encode(ChannelHandlerContext ctx, HttpObject obj, java.util.List<java.lang.Object> out)	Encode from an HttpObject to an Http2StreamFrame.
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
protected boolean	isSsl(ChannelHandlerContext ctx)

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

Constructor Detail

Http2StreamFrameToHttpObjectCodec

public Http2StreamFrameToHttpObjectCodec(boolean isServer,
                                         boolean validateHeaders)

Http2StreamFrameToHttpObjectCodec

public Http2StreamFrameToHttpObjectCodec(boolean isServer)

Method Detail

acceptInboundMessage

public boolean acceptInboundMessage(java.lang.Object msg)
                             throws java.lang.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:

java.lang.Exception

decode

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

Specified by:

decode in class MessageToMessageCodec<Http2StreamFrame,HttpObject>

Throws:

java.lang.Exception

See Also:

MessageToMessageDecoder.decode(ChannelHandlerContext, Object, List)

encode

protected void encode(ChannelHandlerContext ctx,
                      HttpObject obj,
                      java.util.List<java.lang.Object> out)
               throws java.lang.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:

java.lang.Exception - is thrown if an error occurs

See Also:

MessageToMessageEncoder.encode(ChannelHandlerContext, Object, List)

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws java.lang.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:

java.lang.Exception

isSsl

protected boolean isSsl(ChannelHandlerContext ctx)