io.netty.handler.codec.http2

Class AbstractHttp2ConnectionHandlerBuilder<T extends Http2ConnectionHandler,B extends AbstractHttp2ConnectionHandlerBuilder<T,B>>

java.lang.Object

io.netty.handler.codec.http2.AbstractHttp2ConnectionHandlerBuilder<T,B>

Type Parameters:

T - The type of handler created by this builder.

B - The concrete type of this builder.

Direct Known Subclasses:

Http2ConnectionHandlerBuilder, HttpToHttp2ConnectionHandlerBuilder

@UnstableApi
public abstract class AbstractHttp2ConnectionHandlerBuilder<T extends Http2ConnectionHandler,B extends AbstractHttp2ConnectionHandlerBuilder<T,B>>
extends Object

Abstract base class which defines commonly used features required to build Http2ConnectionHandler instances.

Three ways to build a Http2ConnectionHandler

Let the builder create a Http2ConnectionHandler

Simply call all the necessary setter methods, and then use build() to build a new Http2ConnectionHandler. Setting the following properties are prohibited because they are used for other ways of building a Http2ConnectionHandler. conflicts with this option:

• connection(Http2Connection)
• codec(Http2ConnectionDecoder, Http2ConnectionEncoder)

Let the builder use the Http2ConnectionHandler you specified

Call connection(Http2Connection) to tell the builder that you want to build the handler from the Http2Connection you specified. Setting the following properties are prohibited and thus will trigger an IllegalStateException because they conflict with this option.

• server(boolean)
• codec(Http2ConnectionDecoder, Http2ConnectionEncoder)

Let the builder use the Http2ConnectionDecoder and Http2ConnectionEncoder you specified

Call codec(Http2ConnectionDecoder, Http2ConnectionEncoder) to tell the builder that you want to built the handler from the Http2ConnectionDecoder and Http2ConnectionEncoder you specified. Setting the following properties are prohibited and thus will trigger an IllegalStateException because they conflict with this option:

• server(boolean)
• connection(Http2Connection)
• frameLogger(Http2FrameLogger)
• #headerSensitivityDetector(SensitivityDetector)
• encoderEnforceMaxConcurrentStreams(boolean)
• encoderIgnoreMaxHeaderListSize(boolean)

Exposing necessary methods in a subclass

build() method and all property access methods are protected. Choose the methods to expose to the users of your builder implementation and make them public.

Constructor Summary

Constructors

Constructor and Description
AbstractHttp2ConnectionHandlerBuilder()

Method Summary

Modifier and Type	Method and Description
protected T	build() Create a new Http2ConnectionHandler.
protected abstract T	build(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder, Http2Settings initialSettings) Implement this method to create a new Http2ConnectionHandler or its subtype instance.
protected B	codec(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder) Sets the Http2ConnectionDecoder and Http2ConnectionEncoder to use.
protected Http2Connection	connection() Returns the Http2Connection to use.
protected B	connection(Http2Connection connection) Sets the Http2Connection to use.
protected Http2ConnectionDecoder	decoder() Returns the Http2ConnectionDecoder to use.
protected Http2ConnectionEncoder	encoder() Returns the Http2ConnectionEncoder to use.
protected boolean	encoderEnforceMaxConcurrentStreams() Returns if the encoder should queue frames if the maximum number of concurrent streams would otherwise be exceeded.
protected B	encoderEnforceMaxConcurrentStreams(boolean encoderEnforceMaxConcurrentStreams) Sets if the encoder should queue frames if the maximum number of concurrent streams would otherwise be exceeded.
protected B	encoderIgnoreMaxHeaderListSize(boolean ignoreMaxHeaderListSize) Sets if the SETTINGS_MAX_HEADER_LIST_SIZE should be ignored when encoding headers.
protected Http2FrameListener	frameListener() Returns the listener of inbound frames.
protected B	frameListener(Http2FrameListener frameListener) Sets the listener of inbound frames.
protected Http2FrameLogger	frameLogger() Returns the logger that is used for the encoder and decoder.
protected B	frameLogger(Http2FrameLogger frameLogger) Sets the logger that is used for the encoder and decoder.
protected long	gracefulShutdownTimeoutMillis() Returns the graceful shutdown timeout of the Http2Connection in milliseconds.
protected B	gracefulShutdownTimeoutMillis(long gracefulShutdownTimeoutMillis) Sets the graceful shutdown timeout of the Http2Connection in milliseconds.
protected Http2HeadersEncoder.SensitivityDetector	headerSensitivityDetector() Returns the Http2HeadersEncoder.SensitivityDetector to use.
protected B	headerSensitivityDetector(Http2HeadersEncoder.SensitivityDetector headerSensitivityDetector) Sets the Http2HeadersEncoder.SensitivityDetector to use.
protected Http2Settings	initialSettings() Sets the Http2Settings to use for the initial connection settings exchange.
protected B	initialSettings(Http2Settings settings) Sets the Http2Settings to use for the initial connection settings exchange.
protected boolean	isServer() Returns if build() will to create a Http2Connection in server mode (true) or client mode (false).
protected boolean	isValidateHeaders() Returns if HTTP headers should be validated according to RFC 7540, 8.1.2.6.
protected int	maxReservedStreams() Get the maximum number of streams which can be in the reserved state at any given time.
protected B	maxReservedStreams(int maxReservedStreams) Set the maximum number of streams which can be in the reserved state at any given time.
protected B	self() Returns this.
protected B	server(boolean isServer) Sets if build() will to create a Http2Connection in server mode (true) or client mode (false).
protected B	validateHeaders(boolean validateHeaders) Sets if HTTP headers should be validated according to RFC 7540, 8.1.2.6.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHttp2ConnectionHandlerBuilder

public AbstractHttp2ConnectionHandlerBuilder()

Method Detail

initialSettings

protected Http2Settings initialSettings()

Sets the Http2Settings to use for the initial connection settings exchange.

initialSettings

protected B initialSettings(Http2Settings settings)

Sets the Http2Settings to use for the initial connection settings exchange.

frameListener

protected Http2FrameListener frameListener()

Returns the listener of inbound frames.

Returns:

Http2FrameListener if set, or null if not set.

frameListener

protected B frameListener(Http2FrameListener frameListener)

Sets the listener of inbound frames. This listener will only be set if the decoder's listener is null.

gracefulShutdownTimeoutMillis

protected long gracefulShutdownTimeoutMillis()

Returns the graceful shutdown timeout of the Http2Connection in milliseconds.

gracefulShutdownTimeoutMillis

protected B gracefulShutdownTimeoutMillis(long gracefulShutdownTimeoutMillis)

Sets the graceful shutdown timeout of the Http2Connection in milliseconds.

isServer

protected boolean isServer()

Returns if build() will to create a Http2Connection in server mode (true) or client mode (false).

server

protected B server(boolean isServer)

Sets if build() will to create a Http2Connection in server mode (true) or client mode (false).

maxReservedStreams

protected int maxReservedStreams()

Get the maximum number of streams which can be in the reserved state at any given time.

By default this value will be ignored on the server for local endpoint. This is because the RFC provides no way to explicitly communicate a limit to how many states can be in the reserved state, and instead relies on the peer to send RST_STREAM frames when they will be rejected.

maxReservedStreams

protected B maxReservedStreams(int maxReservedStreams)

Set the maximum number of streams which can be in the reserved state at any given time.

connection

protected Http2Connection connection()

Returns the Http2Connection to use.

Returns:

Http2Connection if set, or null if not set.

connection

protected B connection(Http2Connection connection)

Sets the Http2Connection to use.

decoder

protected Http2ConnectionDecoder decoder()

Returns the Http2ConnectionDecoder to use.

Returns:

Http2ConnectionDecoder if set, or null if not set.

encoder

protected Http2ConnectionEncoder encoder()

Returns the Http2ConnectionEncoder to use.

Returns:

Http2ConnectionEncoder if set, or null if not set.

codec

protected B codec(Http2ConnectionDecoder decoder,
                  Http2ConnectionEncoder encoder)

Sets the Http2ConnectionDecoder and Http2ConnectionEncoder to use.

isValidateHeaders

protected boolean isValidateHeaders()

Returns if HTTP headers should be validated according to RFC 7540, 8.1.2.6.

validateHeaders

protected B validateHeaders(boolean validateHeaders)

Sets if HTTP headers should be validated according to RFC 7540, 8.1.2.6.

frameLogger

protected Http2FrameLogger frameLogger()

Returns the logger that is used for the encoder and decoder.

Returns:

Http2FrameLogger if set, or null if not set.

frameLogger

protected B frameLogger(Http2FrameLogger frameLogger)

Sets the logger that is used for the encoder and decoder.

encoderEnforceMaxConcurrentStreams

protected boolean encoderEnforceMaxConcurrentStreams()

Returns if the encoder should queue frames if the maximum number of concurrent streams would otherwise be exceeded.

encoderEnforceMaxConcurrentStreams

protected B encoderEnforceMaxConcurrentStreams(boolean encoderEnforceMaxConcurrentStreams)

Sets if the encoder should queue frames if the maximum number of concurrent streams would otherwise be exceeded.

headerSensitivityDetector

protected Http2HeadersEncoder.SensitivityDetector headerSensitivityDetector()

Returns the Http2HeadersEncoder.SensitivityDetector to use.

headerSensitivityDetector

protected B headerSensitivityDetector(Http2HeadersEncoder.SensitivityDetector headerSensitivityDetector)

Sets the Http2HeadersEncoder.SensitivityDetector to use.

encoderIgnoreMaxHeaderListSize

protected B encoderIgnoreMaxHeaderListSize(boolean ignoreMaxHeaderListSize)

Sets if the SETTINGS_MAX_HEADER_LIST_SIZE should be ignored when encoding headers.

Parameters:

ignoreMaxHeaderListSize - true to ignore SETTINGS_MAX_HEADER_LIST_SIZE.

Returns:

this.

build

protected T build()

Create a new Http2ConnectionHandler.

build

protected abstract T build(Http2ConnectionDecoder decoder,
                           Http2ConnectionEncoder encoder,
                           Http2Settings initialSettings)
                    throws Exception

Implement this method to create a new Http2ConnectionHandler or its subtype instance.

The return of this method will be subject to the following:

• frameListener(Http2FrameListener) will be set if not already set in the decoder
• gracefulShutdownTimeoutMillis(long) will always be set

Throws:

Exception

self

protected final B self()

Returns this.