org.wso2.transport.http.netty.contractimpl.common.states

Class Http2StateUtil

java.lang.Object

org.wso2.transport.http.netty.contractimpl.common.states.Http2StateUtil

public class Http2StateUtil
extends Object

HTTP/2 utility functions for states.

Since:

6.0.241

Constructor Summary

Constructors

Constructor and Description
Http2StateUtil()

Method Summary

Modifier and Type	Method and Description
static void	beginResponseWrite(Http2MessageStateContext http2MessageStateContext, Http2OutboundRespListener http2OutboundRespListener, HttpCarbonMessage outboundResponseMsg, io.netty.handler.codec.http.HttpContent httpContent, int streamId)
static void	initHttp2MessageContext(HttpCarbonMessage outboundRequest, Http2TargetHandler http2TargetHandler)
static int	initiateStream(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http2.Http2Connection connection, Http2ClientChannel http2ClientChannel, OutboundMsgHolder outboundMsgHolder) Initiates a HTTP2 stream.
static boolean	isValidStreamId(int streamId, io.netty.handler.codec.http2.Http2Connection conn) Checks for the validity of stream id.
static void	notifyRequestListener(Http2SourceHandler http2SourceHandler, InboundMessageHolder inboundMessageHolder, int streamId) Notifies the registered listeners which listen for the incoming carbon messages.
static void	onPushPromiseRead(io.netty.channel.ChannelHandlerContext ctx, Http2PushPromise http2PushPromise, Http2ClientChannel http2ClientChannel, OutboundMsgHolder outboundMsgHolder) Adds a push promise message.
static void	releaseContent(io.netty.handler.codec.http.HttpContent httpContent) Releases the ByteBuf content.
static void	releaseDataFrame(Http2SourceHandler http2SourceHandler, Http2DataFrame dataFrame) Releases the ByteBuf content.
static void	sendRequestTimeoutResponse(io.netty.channel.ChannelHandlerContext ctx, Http2OutboundRespListener http2OutboundRespListener, int streamId, io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus, io.netty.buffer.ByteBuf content, boolean handleIncompleteRequest, boolean whileReceivingHeader)
static void	sendRstFrame(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http2.Http2ConnectionEncoder encoder, int streamId) Sends Http2Reset frame with `NO_ERROR` error code.
static HttpCarbonRequest	setupCarbonRequest(io.netty.handler.codec.http.HttpRequest httpRequest, Http2SourceHandler http2SourceHandler, int streamId) Creates a HttpCarbonRequest from HttpRequest.
static void	validatePromisedStreamState(int originalStreamId, int streamId, io.netty.handler.codec.http2.Http2Connection conn, HttpCarbonMessage inboundRequestMsg) Validates the state of promised stream with the original stream id and given stream id.
static void	writeHttp2Headers(io.netty.channel.ChannelHandlerContext ctx, OutboundMsgHolder outboundMsgHolder, Http2ClientChannel http2ClientChannel, io.netty.handler.codec.http2.Http2ConnectionEncoder encoder, int streamId, io.netty.handler.codec.http.HttpHeaders headers, io.netty.handler.codec.http2.Http2Headers http2Headers, boolean endStream) Writes HTTP2 headers.
static void	writeHttp2Promise(Http2PushPromise pushPromise, io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http2.Http2Connection conn, io.netty.handler.codec.http2.Http2ConnectionEncoder encoder, HttpCarbonMessage inboundRequestMsg, HttpResponseFuture outboundRespStatusFuture, int originalStreamId) Writes an HTTP2 promise.
static void	writeHttp2ResponseHeaders(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http2.Http2ConnectionEncoder encoder, HttpResponseFuture outboundRespStatusFuture, int streamId, io.netty.handler.codec.http2.Http2Headers http2Headers, boolean endStream, Http2OutboundRespListener respListener) Writes HTTP2 headers to outbound response.

Methods inherited from class java.lang.Object

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

Constructor Detail

Http2StateUtil

public Http2StateUtil()

Method Detail

notifyRequestListener

public static void notifyRequestListener(Http2SourceHandler http2SourceHandler,
                                         InboundMessageHolder inboundMessageHolder,
                                         int streamId)

Notifies the registered listeners which listen for the incoming carbon messages.

Parameters:

http2SourceHandler - the HTTP2 source handler

inboundMessageHolder - the inbound http request holder

streamId - the id of the stream

setupCarbonRequest

public static HttpCarbonRequest setupCarbonRequest(io.netty.handler.codec.http.HttpRequest httpRequest,
                                                   Http2SourceHandler http2SourceHandler,
                                                   int streamId)

Creates a HttpCarbonRequest from HttpRequest.

Parameters:

httpRequest - the HTTPRequest message

http2SourceHandler - the HTTP/2 source handler

streamId - the stream id

Returns:

the CarbonRequest Message created from given HttpRequest

writeHttp2ResponseHeaders

public static void writeHttp2ResponseHeaders(io.netty.channel.ChannelHandlerContext ctx,
                                             io.netty.handler.codec.http2.Http2ConnectionEncoder encoder,
                                             HttpResponseFuture outboundRespStatusFuture,
                                             int streamId,
                                             io.netty.handler.codec.http2.Http2Headers http2Headers,
                                             boolean endStream,
                                             Http2OutboundRespListener respListener)
                                      throws io.netty.handler.codec.http2.Http2Exception

Writes HTTP2 headers to outbound response.

Parameters:

ctx - the channel handler context

encoder - the HTTP2 connection encoder

outboundRespStatusFuture - the future of outbound response write operation

streamId - the id of the stream

http2Headers - the Http2Headers received over a HTTP/2 stream

endStream - is this the end of stream

respListener - http/2 outbound response listener

Throws:

io.netty.handler.codec.http2.Http2Exception - throws if a protocol-related error occurred

writeHttp2Promise

public static void writeHttp2Promise(Http2PushPromise pushPromise,
                                     io.netty.channel.ChannelHandlerContext ctx,
                                     io.netty.handler.codec.http2.Http2Connection conn,
                                     io.netty.handler.codec.http2.Http2ConnectionEncoder encoder,
                                     HttpCarbonMessage inboundRequestMsg,
                                     HttpResponseFuture outboundRespStatusFuture,
                                     int originalStreamId)
                              throws io.netty.handler.codec.http2.Http2Exception

Writes an HTTP2 promise.

Parameters:

pushPromise - HTTP/2 promise message

ctx - the channel handler context

conn - HTTP2 connection

encoder - the HTTP2 connection encoder

inboundRequestMsg - request message received from the client

outboundRespStatusFuture - the future of outbound response write operation

originalStreamId - the original id of the stream

Throws:

io.netty.handler.codec.http2.Http2Exception - throws if a protocol-related error occurred

validatePromisedStreamState

public static void validatePromisedStreamState(int originalStreamId,
                                               int streamId,
                                               io.netty.handler.codec.http2.Http2Connection conn,
                                               HttpCarbonMessage inboundRequestMsg)
                                        throws io.netty.handler.codec.http2.Http2Exception

Validates the state of promised stream with the original stream id and given stream id.

Parameters:

originalStreamId - the original id of the stream

streamId - the id of the stream to be validated

conn - HTTP2 connection

inboundRequestMsg - request message received from the client

Throws:

io.netty.handler.codec.http2.Http2Exception - throws if stream id is not valid for given connection

isValidStreamId

public static boolean isValidStreamId(int streamId,
                                      io.netty.handler.codec.http2.Http2Connection conn)

Checks for the validity of stream id.

Parameters:

streamId - the id of the stream

conn - HTTP2 connection

Returns:

whether the stream id is valid or not

releaseDataFrame

public static void releaseDataFrame(Http2SourceHandler http2SourceHandler,
                                    Http2DataFrame dataFrame)

Releases the ByteBuf content.

Parameters:

http2SourceHandler - the HTTP2 source handler

dataFrame - the HTTP2 data frame to be released

sendRstFrame

public static void sendRstFrame(io.netty.channel.ChannelHandlerContext ctx,
                                io.netty.handler.codec.http2.Http2ConnectionEncoder encoder,
                                int streamId)
                         throws io.netty.handler.codec.http2.Http2Exception

Sends Http2Reset frame with `NO_ERROR` error code.

Parameters:

ctx - the channel handler context

encoder - the HTTP2 connection encoder

streamId - id of the stream need to be send RST_FRAME

Throws:

io.netty.handler.codec.http2.Http2Exception - if a protocol-related error occurred

writeHttp2Headers

public static void writeHttp2Headers(io.netty.channel.ChannelHandlerContext ctx,
                                     OutboundMsgHolder outboundMsgHolder,
                                     Http2ClientChannel http2ClientChannel,
                                     io.netty.handler.codec.http2.Http2ConnectionEncoder encoder,
                                     int streamId,
                                     io.netty.handler.codec.http.HttpHeaders headers,
                                     io.netty.handler.codec.http2.Http2Headers http2Headers,
                                     boolean endStream)
                              throws io.netty.handler.codec.http2.Http2Exception

Writes HTTP2 headers.

Parameters:

ctx - the channel handler context

outboundMsgHolder - the outbound message holder

http2ClientChannel - the client channel related to the handler

encoder - the HTTP2 connection encoder

streamId - the id of the stream

headers - the HTTP headers

http2Headers - the HTTP2 headers

endStream - is this the end of stream

Throws:

io.netty.handler.codec.http2.Http2Exception - if a protocol-related error occurred

initiateStream

public static int initiateStream(io.netty.channel.ChannelHandlerContext ctx,
                                 io.netty.handler.codec.http2.Http2Connection connection,
                                 Http2ClientChannel http2ClientChannel,
                                 OutboundMsgHolder outboundMsgHolder)
                          throws io.netty.handler.codec.http2.Http2Exception

Initiates a HTTP2 stream.

Parameters:

ctx - the channel handler context

connection - the HTTP2 connection

http2ClientChannel - the client channel related to the handler

outboundMsgHolder - the outbound message holder

Returns:

stream id of next stream

Throws:

io.netty.handler.codec.http2.Http2Exception - if a protocol-related error occurred

onPushPromiseRead

public static void onPushPromiseRead(io.netty.channel.ChannelHandlerContext ctx,
                                     Http2PushPromise http2PushPromise,
                                     Http2ClientChannel http2ClientChannel,
                                     OutboundMsgHolder outboundMsgHolder)

Adds a push promise message.

Parameters:

ctx - the channel handler context

http2PushPromise - the HTTP2 push promise

http2ClientChannel - the client channel related to the handler

outboundMsgHolder - the outbound message holder

releaseContent

public static void releaseContent(io.netty.handler.codec.http.HttpContent httpContent)

Releases the ByteBuf content.

Parameters:

httpContent - the HTTP2 content

sendRequestTimeoutResponse

public static void sendRequestTimeoutResponse(io.netty.channel.ChannelHandlerContext ctx,
                                              Http2OutboundRespListener http2OutboundRespListener,
                                              int streamId,
                                              io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus,
                                              io.netty.buffer.ByteBuf content,
                                              boolean handleIncompleteRequest,
                                              boolean whileReceivingHeader)

initHttp2MessageContext

public static void initHttp2MessageContext(HttpCarbonMessage outboundRequest,
                                           Http2TargetHandler http2TargetHandler)

beginResponseWrite

public static void beginResponseWrite(Http2MessageStateContext http2MessageStateContext,
                                      Http2OutboundRespListener http2OutboundRespListener,
                                      HttpCarbonMessage outboundResponseMsg,
                                      io.netty.handler.codec.http.HttpContent httpContent,
                                      int streamId)
                               throws io.netty.handler.codec.http2.Http2Exception

Throws:

io.netty.handler.codec.http2.Http2Exception