reactor.netty.http.server

Class HttpServer

java.lang.Object

reactor.netty.http.server.HttpServer

public abstract class HttpServer
extends Object

An HttpServer allows to build in a safe immutable way an HTTP server that is materialized and connecting when bind(TcpServer) is ultimately called.

Internally, materialization happens in two phases:

• first tcpConfiguration() is called to retrieve a ready to use TcpServer
• then bind(TcpServer) is called

Examples:

 
 HttpServer.create()
           .host("0.0.0.0")
           .handle((req, res) -> res.sendString(Flux.just("hello")))
           .bind()
           .block();
 
 

Author:

Stephane Maldini

Constructor Summary

Constructors

Constructor and Description
HttpServer()

Method Summary

Modifier and Type	Method and Description
Mono<? extends DisposableServer>	bind() Bind the HttpServer and return a Mono of DisposableServer.
protected abstract Mono<? extends DisposableServer>	bind(TcpServer b) Bind the HttpServer and return a Mono of DisposableServer
DisposableServer	bindNow() Start the server in a blocking fashion, and wait for it to finish initializing or the startup timeout expires (the startup timeout is 45 seconds).
DisposableServer	bindNow(java.time.Duration timeout) Start the server in a blocking fashion, and wait for it to finish initializing or the provided startup timeout expires.
void	bindUntilJavaShutdown(java.time.Duration timeout, java.util.function.Consumer<DisposableServer> onStart) Start the server in a fully blocking fashion, not only waiting for it to initialize but also blocking during the full lifecycle of the server.
HttpServer	compress(java.util.function.BiPredicate<HttpServerRequest,HttpServerResponse> predicate) Enable GZip response compression if the client request presents accept encoding headers and the provided Predicate matches.
HttpServer	compress(boolean compressionEnabled) Specifies whether GZip response compression/websocket compression extension is enabled if the client request presents accept encoding/websocket extensions headers.
HttpServer	compress(int minResponseSize) Enable GZip response compression if the client request presents accept encoding headers AND the response reaches a minimum threshold
HttpServer	cookieCodec(ServerCookieEncoder encoder) Configure the ServerCookieEncoder; ServerCookieDecoder will be chosen based on the encoder
HttpServer	cookieCodec(ServerCookieEncoder encoder, ServerCookieDecoder decoder) Configure the ServerCookieEncoder and ServerCookieDecoder
static HttpServer	create() Prepare an HttpServer
HttpServer	forwarded(boolean forwardedEnabled) Specifies whether support for the "Forwarded" and "X-Forwarded-*" HTTP request headers for deriving information about the connection is enabled.
static HttpServer	from(TcpServer tcpServer) Prepare an HttpServer
HttpServer	handle(java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler) Attach an I/O handler to react on a connected client
HttpServer	host(String host) The host to which this server should bind.
HttpServer	httpRequestDecoder(java.util.function.Function<HttpRequestDecoderSpec,HttpRequestDecoderSpec> requestDecoderOptions) Configure the HttpServerCodec's request decoding options.
HttpServer	observe(ConnectionObserver observer) Setup all lifecycle callbacks called on or after each child Channel has been connected and after it has been disconnected.
HttpServer	port(int port) The port to which this server should bind.
HttpServer	protocol(HttpProtocol... supportedProtocols) The HTTP protocol to support.
HttpServer	proxyProtocol(boolean proxyProtocolEnabled) Specifies whether support for the "HAProxy proxy protocol" for deriving information about the address of the remote peer is enabled.
HttpServer	route(java.util.function.Consumer<? super HttpServerRoutes> routesBuilder) Define routes for the server through the provided HttpServerRoutes builder.
HttpServer	secure(java.util.function.Consumer<? super SslProvider.SslContextSpec> sslProviderBuilder) Apply an SSL configuration customization via the passed builder.
protected TcpServer	tcpConfiguration() Materialize a TcpServer from the parent HttpServer chain to use with bind(TcpServer) or separately
HttpServer	tcpConfiguration(java.util.function.Function<? super TcpServer,? extends TcpServer> tcpMapper) Apply ServerBootstrap configuration given mapper taking currently configured one and returning a new one to be ultimately used for socket binding.
HttpServer	wiretap() Deprecated. Use wiretap(boolean)
HttpServer	wiretap(boolean enable) Apply or remove a wire logger configuration using HttpServer category and DEBUG logger level

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpServer

public HttpServer()

Method Detail

create

public static HttpServer create()

Prepare an HttpServer

Returns:

a new HttpServer

from

public static HttpServer from(TcpServer tcpServer)

Prepare an HttpServer

Returns:

a new HttpServer

bind

public final Mono<? extends DisposableServer> bind()

Bind the HttpServer and return a Mono of DisposableServer. If Mono is cancelled, the underlying binding will be aborted. Once the DisposableServer has been emitted and is not necessary anymore, disposing main server loop must be done by the user via DisposableChannel.dispose(). If update configuration phase fails, a Mono.error(Throwable) will be returned

Returns:

a Mono of DisposableServer

bindNow

public final DisposableServer bindNow()

Start the server in a blocking fashion, and wait for it to finish initializing or the startup timeout expires (the startup timeout is 45 seconds). The returned DisposableServer offers simple server API, including to DisposableChannel.disposeNow() shut it down in a blocking fashion.

Returns:

a DisposableServer

bindNow

public final DisposableServer bindNow(java.time.Duration timeout)

Start the server in a blocking fashion, and wait for it to finish initializing or the provided startup timeout expires. The returned DisposableServer offers simple server API, including to DisposableChannel.disposeNow() shut it down in a blocking fashion.

Parameters:

timeout - max startup timeout

Returns:

a DisposableServer

bindUntilJavaShutdown

public final void bindUntilJavaShutdown(java.time.Duration timeout,
                                        @Nullable
                                        java.util.function.Consumer<DisposableServer> onStart)

Start the server in a fully blocking fashion, not only waiting for it to initialize but also blocking during the full lifecycle of the server. Since most servers will be long-lived, this is more adapted to running a server out of a main method, only allowing shutdown of the servers through sigkill.

Note: JVM shutdown hook is added by this method in order to properly disconnect the server upon receiving a sigkill signal.

Parameters:

timeout - a timeout for server shutdown

onStart - an optional callback on server start

compress

public final HttpServer compress(boolean compressionEnabled)

Specifies whether GZip response compression/websocket compression extension is enabled if the client request presents accept encoding/websocket extensions headers.

Parameters:

compressionEnabled - if true GZip response compression/websocket compression extension is enabled if the client request presents accept encoding/websocket extensions headers, otherwise disabled.

Returns:

a new HttpServer

compress

public final HttpServer compress(int minResponseSize)

Enable GZip response compression if the client request presents accept encoding headers AND the response reaches a minimum threshold

Parameters:

minResponseSize - compression is performed once response size exceeds the given value in bytes

Returns:

a new HttpServer

compress

public final HttpServer compress(java.util.function.BiPredicate<HttpServerRequest,HttpServerResponse> predicate)

Enable GZip response compression if the client request presents accept encoding headers and the provided Predicate matches.

Note: the passed HttpServerRequest and HttpServerResponse should be considered read-only and the implement SHOULD NOT consume or write the request/response in this predicate.

Parameters:

predicate - that returns true to compress the response.

Returns:

a new HttpServer

forwarded

public final HttpServer forwarded(boolean forwardedEnabled)

Specifies whether support for the "Forwarded" and "X-Forwarded-*" HTTP request headers for deriving information about the connection is enabled.

Parameters:

forwardedEnabled - if true support for the "Forwarded" and "X-Forwarded-*" HTTP request headers for deriving information about the connection is enabled, otherwise disabled.

Returns:

a new HttpServer

proxyProtocol

public final HttpServer proxyProtocol(boolean proxyProtocolEnabled)

Specifies whether support for the "HAProxy proxy protocol" for deriving information about the address of the remote peer is enabled.

Parameters:

proxyProtocolEnabled - if true support for the "HAProxy proxy protocol" for deriving information about the address of the remote peer is enabled, otherwise disabled.

Returns:

a new HttpServer

host

public final HttpServer host(String host)

The host to which this server should bind. By default the server will listen on any local address.

Parameters:

host - The host to bind to.

Returns:

a new HttpServer

handle

public final HttpServer handle(java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends Publisher<Void>> handler)

Attach an I/O handler to react on a connected client

Parameters:

handler - an I/O handler that can dispose underlying connection when Publisher terminates. Only the first registered handler will subscribe to the returned Publisher while other will immediately cancel given a same Connection

Returns:

a new HttpServer

httpRequestDecoder

public final HttpServer httpRequestDecoder(java.util.function.Function<HttpRequestDecoderSpec,HttpRequestDecoderSpec> requestDecoderOptions)

Configure the HttpServerCodec's request decoding options.

Parameters:

requestDecoderOptions - a function to mutate the provided Http request decoder options

Returns:

a new HttpServer

cookieCodec

public final HttpServer cookieCodec(ServerCookieEncoder encoder)

Configure the ServerCookieEncoder; ServerCookieDecoder will be chosen based on the encoder

Parameters:

encoder - the preferred ServerCookieEncoder

Returns:

a new HttpServer

cookieCodec

public final HttpServer cookieCodec(ServerCookieEncoder encoder,
                                    ServerCookieDecoder decoder)

Configure the ServerCookieEncoder and ServerCookieDecoder

Parameters:

encoder - the preferred ServerCookieEncoder

decoder - the preferred ServerCookieDecoder

Returns:

a new HttpServer

observe

public final HttpServer observe(ConnectionObserver observer)

Setup all lifecycle callbacks called on or after each child Channel has been connected and after it has been disconnected.

Parameters:

observer - a consumer observing state changes

Returns:

a new HttpServer

protocol

public final HttpServer protocol(HttpProtocol... supportedProtocols)

The HTTP protocol to support. Default is HttpProtocol.HTTP11.

Parameters:

supportedProtocols - The various HttpProtocol this server will support

Returns:

a new HttpServer

port

public final HttpServer port(int port)

The port to which this server should bind. By default the system will pick up an ephemeral port in the bind() operation:

Parameters:

port - The port to bind to.

Returns:

a new HttpServer

secure

public final HttpServer secure(java.util.function.Consumer<? super SslProvider.SslContextSpec> sslProviderBuilder)

Apply an SSL configuration customization via the passed builder. The builder will produce the SslContext to be passed to with a default value of 10 seconds handshake timeout unless the environment property reactor.netty.tcp.sslHandshakeTimeout is set. If SelfSignedCertificate needs to be used, the sample below can be used. Note that SelfSignedCertificate should not be used in production.

 
     SelfSignedCertificate cert = new SelfSignedCertificate();
     SslContextBuilder sslContextBuilder =
             SslContextBuilder.forServer(cert.certificate(), cert.privateKey());
     secure(sslContextSpec -> sslContextSpec.sslContext(sslContextBuilder));
 
 

Parameters:

sslProviderBuilder - builder callback for further customization of SslContext.

Returns:

a new HttpServer

route

public final HttpServer route(java.util.function.Consumer<? super HttpServerRoutes> routesBuilder)

Define routes for the server through the provided HttpServerRoutes builder.

Parameters:

routesBuilder - provides a route builder to be mutated in order to define routes.

Returns:

a new HttpServer starting the router on subscribe

tcpConfiguration

public final HttpServer tcpConfiguration(java.util.function.Function<? super TcpServer,? extends TcpServer> tcpMapper)

Apply ServerBootstrap configuration given mapper taking currently configured one and returning a new one to be ultimately used for socket binding.

Configuration will apply during tcpConfiguration() phase.

Parameters:

tcpMapper - A TcpServer mapping function to update tcp configuration and return an enriched TCP server to use.

Returns:

a new HttpServer

wiretap

@Deprecated
public final HttpServer wiretap()

Deprecated. Use wiretap(boolean)

Apply a wire logger configuration using HttpServer category and DEBUG logger level

Returns:

a new HttpServer

wiretap

public final HttpServer wiretap(boolean enable)

Apply or remove a wire logger configuration using HttpServer category and DEBUG logger level

Parameters:

enable - Specifies whether the wire logger configuration will be added to the pipeline

Returns:

a new HttpServer

bind

protected abstract Mono<? extends DisposableServer> bind(TcpServer b)

Bind the HttpServer and return a Mono of DisposableServer

Parameters:

b - the TcpServer to bind

Returns:

a Mono of DisposableServer

tcpConfiguration

protected TcpServer tcpConfiguration()

Materialize a TcpServer from the parent HttpServer chain to use with bind(TcpServer) or separately

Returns:

a configured TcpServer