io.netty.handler.codec.http2

Class HttpUtil

java.lang.Object

io.netty.handler.codec.http2.HttpUtil

public final class HttpUtil
extends Object

Provides utility methods and constants for the HTTP/2 to HTTP conversion

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpUtil.ExtensionHeaderNames Provides the HTTP header extensions used to carry HTTP/2 information in HTTP objects

Field Summary

Fields

Modifier and Type	Field and Description
static io.netty.handler.codec.http.HttpMethod	OUT_OF_MESSAGE_SEQUENCE_METHOD This will be the method used for HttpRequest objects generated out of the HTTP message flow defined in
static String	OUT_OF_MESSAGE_SEQUENCE_PATH This will be the path used for HttpRequest objects generated out of the HTTP message flow defined in
static io.netty.handler.codec.http.HttpResponseStatus	OUT_OF_MESSAGE_SEQUENCE_RETURN_CODE This will be the status code used for HttpResponse objects generated out of the HTTP message flow defined in

Method Summary

Methods

Modifier and Type	Method and Description
static void	addHttp2ToHttpHeaders(int streamId, Http2Headers sourceHeaders, io.netty.handler.codec.http.FullHttpMessage destinationMessage, boolean addToTrailer) Translate and add HTTP/2 headers to HTTP/1.x headers
static io.netty.handler.codec.http.HttpResponseStatus	parseStatus(io.netty.handler.codec.AsciiString status) Apply HTTP/2 rules while translating status code to HttpResponseStatus
static Http2Headers	toHttp2Headers(io.netty.handler.codec.http.FullHttpMessage in) Converts the given HTTP/1.x headers into HTTP/2 headers.
static io.netty.handler.codec.http.FullHttpRequest	toHttpRequest(int streamId, Http2Headers http2Headers, boolean validateHttpHeaders) Create a new object to contain the request data
static io.netty.handler.codec.http.FullHttpResponse	toHttpResponse(int streamId, Http2Headers http2Headers, boolean validateHttpHeaders) Create a new object to contain the response data

Methods inherited from class java.lang.Object

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

Field Detail

OUT_OF_MESSAGE_SEQUENCE_METHOD

public static final io.netty.handler.codec.http.HttpMethod OUT_OF_MESSAGE_SEQUENCE_METHOD

This will be the method used for HttpRequest objects generated out of the HTTP message flow defined in HTTP/2 Spec Message Flow

OUT_OF_MESSAGE_SEQUENCE_PATH

public static final String OUT_OF_MESSAGE_SEQUENCE_PATH

This will be the path used for HttpRequest objects generated out of the HTTP message flow defined in HTTP/2 Spec Message Flow

See Also:

Constant Field Values

OUT_OF_MESSAGE_SEQUENCE_RETURN_CODE

public static final io.netty.handler.codec.http.HttpResponseStatus OUT_OF_MESSAGE_SEQUENCE_RETURN_CODE

This will be the status code used for HttpResponse objects generated out of the HTTP message flow defined in HTTP/2 Spec Message Flow

Method Detail

parseStatus

public static io.netty.handler.codec.http.HttpResponseStatus parseStatus(io.netty.handler.codec.AsciiString status)
                                                                  throws Http2Exception

Apply HTTP/2 rules while translating status code to HttpResponseStatus

Parameters:

status - The status from an HTTP/2 frame

Returns:

The HTTP/1.x status

Throws:

Http2Exception - If there is a problem translating from HTTP/2 to HTTP/1.x

toHttpResponse

public static io.netty.handler.codec.http.FullHttpResponse toHttpResponse(int streamId,
                                                          Http2Headers http2Headers,
                                                          boolean validateHttpHeaders)
                                                                   throws Http2Exception

Create a new object to contain the response data

Parameters:

streamId - The stream associated with the response

http2Headers - The initial set of HTTP/2 headers to create the response with

validateHttpHeaders -

• true to validate HTTP headers in the http-codec
• false not to validate HTTP headers in the http-codec

Returns:

A new response object which represents headers/data

Throws:

Http2Exception - see addHttp2ToHttpHeaders(int, Http2Headers, FullHttpMessage, boolean)

toHttpRequest

public static io.netty.handler.codec.http.FullHttpRequest toHttpRequest(int streamId,
                                                        Http2Headers http2Headers,
                                                        boolean validateHttpHeaders)
                                                                 throws Http2Exception

Create a new object to contain the request data

Parameters:

streamId - The stream associated with the request

http2Headers - The initial set of HTTP/2 headers to create the request with

validateHttpHeaders -

• true to validate HTTP headers in the http-codec
• false not to validate HTTP headers in the http-codec

Returns:

A new request object which represents headers/data

Throws:

Http2Exception - see addHttp2ToHttpHeaders(int, Http2Headers, FullHttpMessage, boolean)

addHttp2ToHttpHeaders

public static void addHttp2ToHttpHeaders(int streamId,
                         Http2Headers sourceHeaders,
                         io.netty.handler.codec.http.FullHttpMessage destinationMessage,
                         boolean addToTrailer)
                                  throws Http2Exception

Translate and add HTTP/2 headers to HTTP/1.x headers

Parameters:

streamId - The stream associated with sourceHeaders

sourceHeaders - The HTTP/2 headers to convert

destinationMessage - The object which will contain the resulting HTTP/1.x headers

addToTrailer - true to add to trailing headers. false to add to initial headers.

Throws:

Http2Exception - If not all HTTP/2 headers can be translated to HTTP/1.x

toHttp2Headers

public static Http2Headers toHttp2Headers(io.netty.handler.codec.http.FullHttpMessage in)
                                   throws Exception

Converts the given HTTP/1.x headers into HTTP/2 headers.

Throws:

Exception