Class H2ServerBootstrap

java.lang.Object

org.apache.hc.core5.http2.impl.nio.bootstrap.H2ServerBootstrap

public class H2ServerBootstrap
extends Object

HTTP/2 capable HttpAsyncServer bootstrap.

Since:

5.0

Field Summary

Fields

Modifier and Type	Field	Description
private String	canonicalHostName
private CharCodingConfig	charCodingConfig
private Callback<Exception>	exceptionCallback
private final List<FilterEntry<AsyncFilterHandler>>	filters
private FrameFactory	frameFactory
private H2Config	h2Config
private H2StreamListener	h2StreamListener
private Timeout	handshakeTimeout
private Http1Config	http1Config
private Http1StreamListener	http1StreamListener
private HttpProcessor	httpProcessor
private IOReactorConfig	ioReactorConfig
private Decorator<IOSession>	ioSessionDecorator
private LookupRegistry<Supplier<AsyncServerExchangeHandler>>	lookupRegistry
private HttpRequestMapper<Supplier<AsyncServerExchangeHandler>>	requestRouter
private final List<RequestRouter.Entry<Supplier<AsyncServerExchangeHandler>>>	routeEntries
private IOSessionListener	sessionListener
private IOReactorMetricsListener	threadPoolListener
private TlsStrategy	tlsStrategy
private HttpVersionPolicy	versionPolicy

Constructor Summary

Constructors

Modifier	Constructor	Description
private	H2ServerBootstrap()

Method Summary

Modifier and Type	Method	Description
final H2ServerBootstrap	addFilterAfter(String existing, String name, AsyncFilterHandler filterHandler)	Adds the filter after the filter with the given name.
final H2ServerBootstrap	addFilterBefore(String existing, String name, AsyncFilterHandler filterHandler)	Adds the filter before the filter with the given name.
final H2ServerBootstrap	addFilterFirst(String name, AsyncFilterHandler filterHandler)	Add an filter to the head of the processing list.
final H2ServerBootstrap	addFilterLast(String name, AsyncFilterHandler filterHandler)	Add an filter to the tail of the processing list.
static H2ServerBootstrap	bootstrap()
HttpAsyncServer	create()
final H2ServerBootstrap	register(String hostname, String uriPattern, Supplier<AsyncServerExchangeHandler> supplier)	Registers the given AsyncServerExchangeHandler Supplier as a handler for URIs matching the given host and the pattern.
final <T> H2ServerBootstrap	register(String hostname, String uriPattern, AsyncServerRequestHandler<T> requestHandler)	Registers the given AsyncServerRequestHandler as a handler for URIs matching the given host and the pattern.
final H2ServerBootstrap	register(String uriPattern, Supplier<AsyncServerExchangeHandler> supplier)	Registers the given AsyncServerExchangeHandler Supplier as a default handler for URIs matching the given pattern.
final <T> H2ServerBootstrap	register(String uriPattern, AsyncServerRequestHandler<T> requestHandler)	Registers the given AsyncServerRequestHandler as a default handler for URIs matching the given pattern.
final H2ServerBootstrap	registerVirtual(String hostname, String uriPattern, Supplier<AsyncServerExchangeHandler> supplier)	Deprecated. Use register(String, String, Supplier).
final <T> H2ServerBootstrap	registerVirtual(String hostname, String uriPattern, AsyncServerRequestHandler<T> requestHandler)	Deprecated. Use register(String, String, Supplier).
final H2ServerBootstrap	replaceFilter(String existing, AsyncFilterHandler filterHandler)	Replace an existing filter with the given name with new filter.
final H2ServerBootstrap	setCanonicalHostName(String canonicalHostName)	Sets canonical name (fully qualified domain name) of the server.
final H2ServerBootstrap	setCharset(CharCodingConfig charCodingConfig)	Sets message char coding.
final H2ServerBootstrap	setExceptionCallback(Callback<Exception> exceptionCallback)	Sets Exception Callback instance.
final H2ServerBootstrap	setFrameFactory(FrameFactory frameFactory)	Sets FrameFactory instance.
final H2ServerBootstrap	setH2Config(H2Config h2Config)	Sets HTTP/2 protocol parameters
final H2ServerBootstrap	setHandshakeTimeout(Timeout handshakeTimeout)
final H2ServerBootstrap	setHttp1Config(Http1Config http1Config)	Sets HTTP/1.1 protocol parameters
final H2ServerBootstrap	setHttpProcessor(HttpProcessor httpProcessor)	Sets HttpProcessor instance.
final H2ServerBootstrap	setIOReactorConfig(IOReactorConfig ioReactorConfig)	Sets I/O reactor configuration.
final H2ServerBootstrap	setIOReactorMetricsListener(IOReactorMetricsListener threadPoolListener)	Sets IOReactorMetricsListener instance.
final H2ServerBootstrap	setIOSessionDecorator(Decorator<IOSession> ioSessionDecorator)	Sets IOSession Decorator instance.
final H2ServerBootstrap	setIOSessionListener(IOSessionListener sessionListener)	Sets IOSessionListener instance.
final H2ServerBootstrap	setLookupRegistry(LookupRegistry<Supplier<AsyncServerExchangeHandler>> lookupRegistry)	Deprecated. Use RequestRouter.
final H2ServerBootstrap	setRequestRouter(HttpRequestMapper<Supplier<AsyncServerExchangeHandler>> requestRouter)	Sets HttpRequestMapper instance.
final H2ServerBootstrap	setStreamListener(Http1StreamListener http1StreamListener)	Sets Http1StreamListener instance.
final H2ServerBootstrap	setStreamListener(H2StreamListener h2StreamListener)	Sets H2StreamListener instance.
final H2ServerBootstrap	setTlsStrategy(TlsStrategy tlsStrategy)	Sets TlsStrategy instance.
final H2ServerBootstrap	setVersionPolicy(HttpVersionPolicy versionPolicy)	Sets HTTP protocol version policy

Methods inherited from class Object

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

Field Details

routeEntries

private final List<RequestRouter.Entry<Supplier<AsyncServerExchangeHandler>>> routeEntries

filters

private final List<FilterEntry<AsyncFilterHandler>> filters

canonicalHostName

private String canonicalHostName

lookupRegistry

private LookupRegistry<Supplier<AsyncServerExchangeHandler>> lookupRegistry

requestRouter

private HttpRequestMapper<Supplier<AsyncServerExchangeHandler>> requestRouter

ioReactorConfig

private IOReactorConfig ioReactorConfig

httpProcessor

private HttpProcessor httpProcessor

charCodingConfig

private CharCodingConfig charCodingConfig

versionPolicy

private HttpVersionPolicy versionPolicy

h2Config

private H2Config h2Config

http1Config

private Http1Config http1Config

tlsStrategy

private TlsStrategy tlsStrategy

handshakeTimeout

private Timeout handshakeTimeout

ioSessionDecorator

private Decorator<IOSession> ioSessionDecorator

exceptionCallback

private Callback<Exception> exceptionCallback

sessionListener

private IOSessionListener sessionListener

h2StreamListener

private H2StreamListener h2StreamListener

http1StreamListener

private Http1StreamListener http1StreamListener

threadPoolListener

private IOReactorMetricsListener threadPoolListener

frameFactory

private FrameFactory frameFactory

Constructor Details

H2ServerBootstrap

private H2ServerBootstrap()

Method Details

bootstrap

public static H2ServerBootstrap bootstrap()

setCanonicalHostName

public final H2ServerBootstrap setCanonicalHostName(String canonicalHostName)

Sets canonical name (fully qualified domain name) of the server.

Returns:

this instance.

Since:

5.0

setIOReactorConfig

public final H2ServerBootstrap setIOReactorConfig(IOReactorConfig ioReactorConfig)

Sets I/O reactor configuration.

Returns:

this instance.

setHttpProcessor

public final H2ServerBootstrap setHttpProcessor(HttpProcessor httpProcessor)

Sets HttpProcessor instance.

Returns:

this instance.

setVersionPolicy

public final H2ServerBootstrap setVersionPolicy(HttpVersionPolicy versionPolicy)

Sets HTTP protocol version policy

Returns:

this instance.

setH2Config

public final H2ServerBootstrap setH2Config(H2Config h2Config)

Sets HTTP/2 protocol parameters

Returns:

this instance.

setHttp1Config

public final H2ServerBootstrap setHttp1Config(Http1Config http1Config)

Sets HTTP/1.1 protocol parameters

Returns:

this instance.

setCharset

public final H2ServerBootstrap setCharset(CharCodingConfig charCodingConfig)

Sets message char coding.

Returns:

this instance.

setTlsStrategy

public final H2ServerBootstrap setTlsStrategy(TlsStrategy tlsStrategy)

Sets TlsStrategy instance.

Returns:

this instance.

setHandshakeTimeout

public final H2ServerBootstrap setHandshakeTimeout(Timeout handshakeTimeout)

setIOSessionDecorator

public final H2ServerBootstrap setIOSessionDecorator(Decorator<IOSession> ioSessionDecorator)

Sets IOSession Decorator instance.

Returns:

this instance.

setIOReactorMetricsListener

public final H2ServerBootstrap setIOReactorMetricsListener(IOReactorMetricsListener threadPoolListener)

Sets IOReactorMetricsListener instance.

Returns:

this instance.

Since:

5.4

setExceptionCallback

public final H2ServerBootstrap setExceptionCallback(Callback<Exception> exceptionCallback)

Sets Exception Callback instance.

Returns:

this instance.

setIOSessionListener

public final H2ServerBootstrap setIOSessionListener(IOSessionListener sessionListener)

Sets IOSessionListener instance.

Returns:

this instance.

setStreamListener

public final H2ServerBootstrap setStreamListener(H2StreamListener h2StreamListener)

Sets H2StreamListener instance.

Returns:

this instance.

setFrameFactory

public final H2ServerBootstrap setFrameFactory(FrameFactory frameFactory)

Sets FrameFactory instance.

Returns:

this instance.

Since:

5.4

setStreamListener

public final H2ServerBootstrap setStreamListener(Http1StreamListener http1StreamListener)

Sets Http1StreamListener instance.

Returns:

this instance.

setLookupRegistry

@Deprecated
public final H2ServerBootstrap setLookupRegistry(LookupRegistry<Supplier<AsyncServerExchangeHandler>> lookupRegistry)

Deprecated.

Use RequestRouter.

Returns:

this instance.

setRequestRouter

public final H2ServerBootstrap setRequestRouter(HttpRequestMapper<Supplier<AsyncServerExchangeHandler>> requestRouter)

Sets HttpRequestMapper instance.

Returns:

this instance.

Since:

5.3

See Also:

• RequestRouter

register

public final H2ServerBootstrap register(String uriPattern,
 Supplier<AsyncServerExchangeHandler> supplier)

Registers the given AsyncServerExchangeHandler Supplier as a default handler for URIs matching the given pattern.

Parameters:

uriPattern - the pattern to register the handler for.

supplier - the handler supplier.

Returns:

this instance.

register

public final H2ServerBootstrap register(String hostname,
 String uriPattern,
 Supplier<AsyncServerExchangeHandler> supplier)

Registers the given AsyncServerExchangeHandler Supplier as a handler for URIs matching the given host and the pattern.

Parameters:

hostname - the host name

uriPattern - the pattern to register the handler for.

supplier - the handler supplier.

Returns:

this instance.

Since:

5.3

registerVirtual

@Deprecated
public final H2ServerBootstrap registerVirtual(String hostname,
 String uriPattern,
 Supplier<AsyncServerExchangeHandler> supplier)

Deprecated.

Use register(String, String, Supplier).

Returns:

this instance.

register

public final <T> H2ServerBootstrap register(String uriPattern,
 AsyncServerRequestHandler<T> requestHandler)

Registers the given AsyncServerRequestHandler as a default handler for URIs matching the given pattern.

Type Parameters:

T - request handler representation.

Parameters:

uriPattern - the pattern to register the handler for.

requestHandler - the handler.

Returns:

this instance.

register

public final <T> H2ServerBootstrap register(String hostname,
 String uriPattern,
 AsyncServerRequestHandler<T> requestHandler)

Registers the given AsyncServerRequestHandler as a handler for URIs matching the given host and the pattern.

Type Parameters:

T - request handler representation.

Parameters:

hostname - the host name

uriPattern - the pattern to register the handler for.

requestHandler - the handler.

Returns:

this instance.

Since:

5.3

registerVirtual

@Deprecated
public final <T> H2ServerBootstrap registerVirtual(String hostname,
 String uriPattern,
 AsyncServerRequestHandler<T> requestHandler)

Deprecated.

Use register(String, String, Supplier).

Type Parameters:

T - request handler representation.

Returns:

this instance.

addFilterBefore

public final H2ServerBootstrap addFilterBefore(String existing,
 String name,
 AsyncFilterHandler filterHandler)

Adds the filter before the filter with the given name.

Returns:

this instance.

addFilterAfter

public final H2ServerBootstrap addFilterAfter(String existing,
 String name,
 AsyncFilterHandler filterHandler)

Adds the filter after the filter with the given name.

Returns:

this instance.

replaceFilter

public final H2ServerBootstrap replaceFilter(String existing,
 AsyncFilterHandler filterHandler)

Replace an existing filter with the given name with new filter.

Returns:

this instance.

addFilterFirst

public final H2ServerBootstrap addFilterFirst(String name,
 AsyncFilterHandler filterHandler)

Add an filter to the head of the processing list.

Returns:

this instance.

addFilterLast

public final H2ServerBootstrap addFilterLast(String name,
 AsyncFilterHandler filterHandler)

Add an filter to the tail of the processing list.

Returns:

this instance.

create

public HttpAsyncServer create()