java.lang.Object
- io.netty.handler.codec.http2.DefaultHttp2ConnectionDecoder

All Implemented Interfaces:

Http2ConnectionDecoder, java.io.Closeable, java.lang.AutoCloseable
```
public class DefaultHttp2ConnectionDecoder
extends java.lang.Object
implements Http2ConnectionDecoder
```
Provides the default implementation for processing inbound frame events and delegates to a Http2FrameListener
This class will read HTTP/2 frames and delegate the events to a Http2FrameListener
This interface enforces inbound flow control functionality through Http2LocalFlowController

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`private static class`	`DefaultHttp2ConnectionDecoder.ContentLength`
`private class`	`DefaultHttp2ConnectionDecoder.FrameReadListener`	Handles all inbound frames from the network.
`private class`	`DefaultHttp2ConnectionDecoder.PrefaceFrameListener`

Field Summary

Fields
Modifier and Type	Field	Description
`private boolean`	`autoAckPing`
`private Http2Connection`	`connection`
`private Http2Connection.PropertyKey`	`contentLengthKey`
`private Http2ConnectionEncoder`	`encoder`
`private Http2FrameReader`	`frameReader`
`private Http2FrameListener`	`internalFrameListener`
`private Http2LifecycleManager`	`lifecycleManager`
`private Http2FrameListener`	`listener`
`private static InternalLogger`	`logger`
`private Http2PromisedRequestVerifier`	`requestVerifier`
`private Http2SettingsReceivedConsumer`	`settingsReceivedConsumer`
`private boolean`	`validateHeaders`
`private boolean`	`validateRequiredPseudoHeaders`

Constructor Summary

Constructors
Constructor	Description
`DefaultHttp2ConnectionDecoder(Http2Connection connection, Http2ConnectionEncoder encoder, Http2FrameReader frameReader)`
`DefaultHttp2ConnectionDecoder(Http2Connection connection, Http2ConnectionEncoder encoder, Http2FrameReader frameReader, Http2PromisedRequestVerifier requestVerifier)`
`DefaultHttp2ConnectionDecoder(Http2Connection connection, Http2ConnectionEncoder encoder, Http2FrameReader frameReader, Http2PromisedRequestVerifier requestVerifier, boolean autoAckSettings)`	Create a new instance.
`DefaultHttp2ConnectionDecoder(Http2Connection connection, Http2ConnectionEncoder encoder, Http2FrameReader frameReader, Http2PromisedRequestVerifier requestVerifier, boolean autoAckSettings, boolean autoAckPing)`	Deprecated.
`DefaultHttp2ConnectionDecoder(Http2Connection connection, Http2ConnectionEncoder encoder, Http2FrameReader frameReader, Http2PromisedRequestVerifier requestVerifier, boolean autoAckSettings, boolean autoAckPing, boolean validateHeaders)`	Create a new instance.
`DefaultHttp2ConnectionDecoder(Http2Connection connection, Http2ConnectionEncoder encoder, Http2FrameReader frameReader, Http2PromisedRequestVerifier requestVerifier, boolean autoAckSettings, boolean autoAckPing, boolean validateHeaders, boolean validateRequiredPseudoHeaders)`	Create a new instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected long`	`calculateMaxHeaderListSizeGoAway(long maxHeaderListSize)`	Calculate the threshold in bytes which should trigger a `GO_AWAY` if a set of headers exceeds this amount.
`void`	`close()`
`Http2Connection`	`connection()`	Provides direct access to the underlying connection.
`void`	`decodeFrame(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)`	Called by the `Http2ConnectionHandler` to decode the next frame from the input buffer.
`Http2LocalFlowController`	`flowController()`	Provides the local flow controller for managing inbound traffic.
`Http2FrameListener`	`frameListener()`	Get the `Http2FrameListener` which will be notified when frames are decoded.
`void`	`frameListener(Http2FrameListener listener)`	Set the `Http2FrameListener` which will be notified when frames are decoded.
`void`	`lifecycleManager(Http2LifecycleManager lifecycleManager)`	Sets the lifecycle manager.
`Http2Settings`	`localSettings()`	Gets the local settings for this endpoint of the HTTP/2 connection.
`(package private) void`	`onGoAwayRead0(ChannelHandlerContext ctx, int lastStreamId, long errorCode, ByteBuf debugData)`
`boolean`	`prefaceReceived()`	Indicates whether or not the first initial `SETTINGS` frame was received from the remote endpoint.
`private int`	`unconsumedBytes(Http2Stream stream)`
`private static void`	`validatePseudoHeadersDirection(boolean isServer, int streamId, Http2Headers headers)`	Validates that pseudo-headers are defined and are used in the correct endpoint direction (RFC 9113, Sections 8.1.1 and 8.3).
`private static void`	`validateRequiredPseudoHeaders(boolean server, int streamId, Http2Headers headers)`	Validates that an initial request or response HEADERS frame, or a PUSH_PROMISE field block (which always carries a request header set, per RFC 9113, 8.4.1), carries the mandatory pseudo-header fields, as required by RFC 9113, 8.3.
`private void`	`verifyContentLength(Http2Stream stream, int data, boolean isEnd)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
private static final InternalLogger logger
```
  - internalFrameListener
```
private Http2FrameListener internalFrameListener
```
  - connection
```
private final Http2Connection connection
```
  - lifecycleManager
```
private Http2LifecycleManager lifecycleManager
```
  - encoder
```
private final Http2ConnectionEncoder encoder
```
  - frameReader
```
private final Http2FrameReader frameReader
```
  - listener
```
private Http2FrameListener listener
```
  - requestVerifier
```
private final Http2PromisedRequestVerifier requestVerifier
```
  - settingsReceivedConsumer
```
private final Http2SettingsReceivedConsumer settingsReceivedConsumer
```
  - autoAckPing
```
private final boolean autoAckPing
```
  - contentLengthKey
```
private final Http2Connection.PropertyKey contentLengthKey
```
  - validateHeaders
```
private final boolean validateHeaders
```
  - validateRequiredPseudoHeaders
```
private final boolean validateRequiredPseudoHeaders
```
- Constructor Detail
  - DefaultHttp2ConnectionDecoder
```
public DefaultHttp2ConnectionDecoder(Http2Connection connection,
                                     Http2ConnectionEncoder encoder,
                                     Http2FrameReader frameReader)
```
  - DefaultHttp2ConnectionDecoder
```
public DefaultHttp2ConnectionDecoder(Http2Connection connection,
                                     Http2ConnectionEncoder encoder,
                                     Http2FrameReader frameReader,
                                     Http2PromisedRequestVerifier requestVerifier)
```
  - DefaultHttp2ConnectionDecoder
```
public DefaultHttp2ConnectionDecoder(Http2Connection connection,
                                     Http2ConnectionEncoder encoder,
                                     Http2FrameReader frameReader,
                                     Http2PromisedRequestVerifier requestVerifier,
                                     boolean autoAckSettings)
```
    Create a new instance.
    
    Parameters:
    
    connection - The Http2Connection associated with this decoder.
    
    encoder - The Http2ConnectionEncoder associated with this decoder.
    
    frameReader - Responsible for reading/parsing the raw frames. As opposed to this object which applies h2 semantics on top of the frames.
    
    requestVerifier - Determines if push promised streams are valid.
    
    autoAckSettings - false to disable automatically applying and sending settings acknowledge frame. The Http2ConnectionEncoder is expected to be an instance of Http2SettingsReceivedConsumer and will apply the earliest received but not yet ACKed SETTINGS when writing the SETTINGS ACKs. true to enable automatically applying and sending settings acknowledge frame.
  - DefaultHttp2ConnectionDecoder
```
@Deprecated
public DefaultHttp2ConnectionDecoder(Http2Connection connection,
                                     Http2ConnectionEncoder encoder,
                                     Http2FrameReader frameReader,
                                     Http2PromisedRequestVerifier requestVerifier,
                                     boolean autoAckSettings,
                                     boolean autoAckPing)
```
    Deprecated.
  - DefaultHttp2ConnectionDecoder
```
public DefaultHttp2ConnectionDecoder(Http2Connection connection,
                                     Http2ConnectionEncoder encoder,
                                     Http2FrameReader frameReader,
                                     Http2PromisedRequestVerifier requestVerifier,
                                     boolean autoAckSettings,
                                     boolean autoAckPing,
                                     boolean validateHeaders)
```
    Create a new instance.
    
    Parameters:
    
    connection - The Http2Connection associated with this decoder.
    
    encoder - The Http2ConnectionEncoder associated with this decoder.
    
    frameReader - Responsible for reading/parsing the raw frames. As opposed to this object which applies h2 semantics on top of the frames.
    
    requestVerifier - Determines if push promised streams are valid.
    
    autoAckSettings - false to disable automatically applying and sending settings acknowledge frame. The Http2ConnectionEncoder is expected to be an instance of Http2SettingsReceivedConsumer and will apply the earliest received but not yet ACKed SETTINGS when writing the SETTINGS ACKs. true to enable automatically applying and sending settings acknowledge frame.
    
    autoAckPing - false to disable automatically sending ping acknowledge frame. true to enable automatically sending ping ack frame.
  - DefaultHttp2ConnectionDecoder
```
public DefaultHttp2ConnectionDecoder(Http2Connection connection,
                                     Http2ConnectionEncoder encoder,
                                     Http2FrameReader frameReader,
                                     Http2PromisedRequestVerifier requestVerifier,
                                     boolean autoAckSettings,
                                     boolean autoAckPing,
                                     boolean validateHeaders,
                                     boolean validateRequiredPseudoHeaders)
```
    Create a new instance.
    
    Parameters:
    
    connection - The Http2Connection associated with this decoder.
    
    encoder - The Http2ConnectionEncoder associated with this decoder.
    
    frameReader - Responsible for reading/parsing the raw frames. As opposed to this object which applies h2 semantics on top of the frames.
    
    requestVerifier - Determines if push promised streams are valid.
    
    autoAckSettings - false to disable automatically applying and sending settings acknowledge frame. The Http2ConnectionEncoder is expected to be an instance of Http2SettingsReceivedConsumer and will apply the earliest received but not yet ACKed SETTINGS when writing the SETTINGS ACKs. true to enable automatically applying and sending settings acknowledge frame.
    
    autoAckPing - false to disable automatically sending ping acknowledge frame. true to enable automatically sending ping ack frame.
    
    validateHeaders - true to validate headers according to RFC 7540, 8.1.2.6.
    
    validateRequiredPseudoHeaders - true to reject request/response HEADERS that omit a mandatory pseudo-header field, according to RFC 9113, 8.3, and to reject PUSH_PROMISE field blocks that do not carry a complete set of request pseudo-header fields, according to RFC 9113, 8.4.1.
- Method Detail
  - lifecycleManager
```
public void lifecycleManager(Http2LifecycleManager lifecycleManager)
```
    Description copied from interface: Http2ConnectionDecoder
    
    Sets the lifecycle manager. Must be called as part of initialization before the decoder is used.
    
    Specified by:
    
    lifecycleManager in interface Http2ConnectionDecoder
  - connection
```
public Http2Connection connection()
```
    Description copied from interface: Http2ConnectionDecoder
    
    Provides direct access to the underlying connection.
    
    Specified by:
    
    connection in interface Http2ConnectionDecoder
  - flowController
```
public final Http2LocalFlowController flowController()
```
    Description copied from interface: Http2ConnectionDecoder
    
    Provides the local flow controller for managing inbound traffic.
    
    Specified by:
    
    flowController in interface Http2ConnectionDecoder
  - frameListener
```
public void frameListener(Http2FrameListener listener)
```
    Description copied from interface: Http2ConnectionDecoder
    
    Set the Http2FrameListener which will be notified when frames are decoded.
    This must be set before frames are decoded.
    
    Specified by:
    
    frameListener in interface Http2ConnectionDecoder
  - frameListener
```
public Http2FrameListener frameListener()
```
    Description copied from interface: Http2ConnectionDecoder
    
    Get the Http2FrameListener which will be notified when frames are decoded.
    
    Specified by:
    
    frameListener in interface Http2ConnectionDecoder
  - prefaceReceived
```
public boolean prefaceReceived()
```
    Description copied from interface: Http2ConnectionDecoder
    
    Indicates whether or not the first initial SETTINGS frame was received from the remote endpoint.
    
    Specified by:
    
    prefaceReceived in interface Http2ConnectionDecoder
  - decodeFrame
```
public void decodeFrame(ChannelHandlerContext ctx,
                        ByteBuf in,
                        java.util.List<java.lang.Object> out)
                 throws Http2Exception
```
    Description copied from interface: Http2ConnectionDecoder
    
    Called by the Http2ConnectionHandler to decode the next frame from the input buffer.
    
    Specified by:
    
    decodeFrame in interface Http2ConnectionDecoder
    
    Throws:
    
    Http2Exception
  - localSettings
```
public Http2Settings localSettings()
```
    Description copied from interface: Http2ConnectionDecoder
    
    Gets the local settings for this endpoint of the HTTP/2 connection.
    
    Specified by:
    
    localSettings in interface Http2ConnectionDecoder
  - close
```
public void close()
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface Http2ConnectionDecoder
  - calculateMaxHeaderListSizeGoAway
```
protected long calculateMaxHeaderListSizeGoAway(long maxHeaderListSize)
```
    Calculate the threshold in bytes which should trigger a GO_AWAY if a set of headers exceeds this amount.
    
    Parameters:
    
    maxHeaderListSize - SETTINGS_MAX_HEADER_LIST_SIZE for the local endpoint.
    
    Returns:
    
    the threshold in bytes which should trigger a GO_AWAY if a set of headers exceeds this amount.
  - unconsumedBytes
```
private int unconsumedBytes(Http2Stream stream)
```
  - onGoAwayRead0
```
void onGoAwayRead0(ChannelHandlerContext ctx,
                   int lastStreamId,
                   long errorCode,
                   ByteBuf debugData)
            throws Http2Exception
```
    Throws:
    
    Http2Exception
  - verifyContentLength
```
private void verifyContentLength(Http2Stream stream,
                                 int data,
                                 boolean isEnd)
                          throws Http2Exception
```
    Throws:
    
    Http2Exception
  - validateRequiredPseudoHeaders
```
private static void validateRequiredPseudoHeaders(boolean server,
                                                  int streamId,
                                                  Http2Headers headers)
                                           throws Http2Exception
```
    Validates that an initial request or response HEADERS frame, or a PUSH_PROMISE field block (which always carries a request header set, per RFC 9113, 8.4.1), carries the mandatory pseudo-header fields, as required by RFC 9113, 8.3. Trailers and informational (1xx) responses are handled by the caller and do not reach this method.
    
    Throws:
    
    Http2Exception
  - validatePseudoHeadersDirection
```
private static void validatePseudoHeadersDirection(boolean isServer,
                                                   int streamId,
                                                   Http2Headers headers)
                                            throws Http2Exception
```
    Validates that pseudo-headers are defined and are used in the correct endpoint direction (RFC 9113, Sections 8.1.1 and 8.3).
    
    Parameters:
    
    isServer - true if processing an inbound request on the server
    
    streamId - the target HTTP/2 stream ID
    
    headers - the HTTP/2 headers container
    
    Throws:
    
    Http2Exception - if a pseudo-header is undefined or used in the wrong endpoint direction

Class DefaultHttp2ConnectionDecoder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

internalFrameListener

connection

lifecycleManager

encoder

frameReader

listener

requestVerifier

settingsReceivedConsumer

autoAckPing

contentLengthKey

validateHeaders

validateRequiredPseudoHeaders

Constructor Detail

DefaultHttp2ConnectionDecoder

DefaultHttp2ConnectionDecoder

DefaultHttp2ConnectionDecoder

DefaultHttp2ConnectionDecoder

DefaultHttp2ConnectionDecoder

DefaultHttp2ConnectionDecoder

Method Detail

lifecycleManager

connection

flowController

frameListener

frameListener

prefaceReceived

decodeFrame

localSettings

close

calculateMaxHeaderListSizeGoAway

unconsumedBytes

onGoAwayRead0

verifyContentLength

validateRequiredPseudoHeaders

validatePseudoHeadersDirection