HttpServer (reactor-netty 1.0.1 API)

java.lang.Object
- reactor.netty.transport.Transport<T,CONF>
- - reactor.netty.transport.ServerTransport<HttpServer,HttpServerConfig>
  - - reactor.netty.http.server.HttpServer

public abstract class HttpServer
extends ServerTransport<HttpServer,HttpServerConfig>

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

Examples:

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

Constructor Summary

Constructors
Constructor and Description

HttpServer()

Constructors
Constructor and Description
`HttpServer()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`HttpServer`	`accessLog(java.util.function.Function<AccessLogArgProvider,AccessLog> accessLog)` Provide customized access log.
`HttpServer`	`bindAddress(java.util.function.Supplier<? extends java.net.SocketAddress> bindAddressSupplier)` Set a new local address to which this transport should bind on subscribe.
`HttpServer`	`channelGroup(io.netty.channel.group.ChannelGroup channelGroup)` Provide a `ChannelGroup` to hold all active connected channels.
`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 is enabled if the client request presents accept encoding.
`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(io.netty.handler.codec.http.cookie.ServerCookieEncoder encoder)` Configure the `ServerCookieEncoder`; `ServerCookieDecoder` will be chosen based on the encoder
`HttpServer`	`cookieCodec(io.netty.handler.codec.http.cookie.ServerCookieEncoder encoder, io.netty.handler.codec.http.cookie.ServerCookieDecoder decoder)` Configure the `ServerCookieEncoder` and `ServerCookieDecoder`
`static HttpServer`	`create()` Prepare an `HttpServer`
`HttpServer`	`forwarded(java.util.function.BiFunction<ConnectionInfo,io.netty.handler.codec.http.HttpRequest,ConnectionInfo> handler)` Specifies a custom request handler for deriving information about the connection.
`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)` Deprecated. Use `HttpServer` methods for TCP level configurations. This method will be removed in version 1.1.0.
`HttpServer`	`handle(java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends org.reactivestreams.Publisher<java.lang.Void>> handler)` Attach an I/O handler to react on a connected client
`HttpServer`	`host(java.lang.String host)` The host to which this server should bind.
`HttpServer`	`http2Settings(java.util.function.Consumer<Http2SettingsSpec.Builder> http2Settings)` Apply HTTP/2 configuration
`HttpServer`	`httpRequestDecoder(java.util.function.Function<HttpRequestDecoderSpec,HttpRequestDecoderSpec> requestDecoderOptions)` Configure the `HttpServerCodec`'s request decoding options.
`HttpServer`	`mapHandle(java.util.function.BiFunction<? super reactor.core.publisher.Mono<java.lang.Void>,? super Connection,? extends reactor.core.publisher.Mono<java.lang.Void>> mapHandle)` Decorate the configured I/O handler.
`HttpServer`	`metrics(boolean enable, java.util.function.Function<java.lang.String,java.lang.String> uriTagValue)` Whether to enable metrics to be collected and registered in Micrometer's `globalRegistry` under the name `Metrics.HTTP_SERVER_PREFIX`.
`HttpServer`	`metrics(boolean enable, java.util.function.Supplier<? extends ChannelMetricsRecorder> recorder)` Specifies whether the metrics are enabled on the `Transport`.
`HttpServer`	`metrics(boolean enable, java.util.function.Supplier<? extends ChannelMetricsRecorder> recorder, java.util.function.Function<java.lang.String,java.lang.String> uriValue)` Specifies whether the metrics are enabled on the `HttpServer`.
`HttpServer`	`noSSL()` Removes any previously applied SSL configuration customization
`HttpServer`	`port(int port)` The port to which this server should bind.
`HttpServer`	`protocol(HttpProtocol... supportedProtocols)` The HTTP protocol to support.
`HttpServer`	`proxyProtocol(ProxyProtocolSupportType proxyProtocolSupportType)` 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.
`HttpServer`	`secure(SslProvider sslProvider)` Applies an SSL configuration via the passed `SslProvider`.
`HttpServer`	`tcpConfiguration(java.util.function.Function<? super TcpServer,? extends TcpServer> tcpMapper)` Deprecated. Use `HttpServer` methods for TCP level configurations. This method will be removed in version 1.1.0.
`HttpServer`	`wiretap(boolean enable)` Apply or remove a wire logger configuration using `Transport` category, `DEBUG` logger level and `AdvancedByteBufFormat.HEX_DUMP` for `ByteBuf` format.

Methods inherited from class reactor.netty.transport.ServerTransport
bind, bindNow, bindNow, bindUntilJavaShutdown, childAttr, childObserve, childOption, doOnBind, doOnBound, doOnConnection, doOnUnbound

Methods inherited from class reactor.netty.transport.Transport
attr, configuration, doOnChannelInit, duplicate, metrics, observe, option, runOn, runOn, runOn, wiretap, wiretap, wiretap, wiretap

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
```
@Deprecated
public static HttpServer from(TcpServer tcpServer)
```
    Deprecated. Use HttpServer methods for TCP level configurations. This method will be removed in version 1.1.0.
    
    Prepare an HttpServer
    
    Returns:
    
    a new HttpServer
  - accessLog
```
public final HttpServer accessLog(java.util.function.Function<AccessLogArgProvider,AccessLog> accessLog)
```
    Provide customized access log.
    Example:
```
 
 HttpServer.create()
           .port(8080)
           .route(r -> r.get("/hello",
                   (req, res) -> res.header(CONTENT_TYPE, TEXT_PLAIN)
                                    .sendString(Mono.just("Hello World!"))))
           .accessLog(argProvider ->
                   AccessLog.create("user-agent={}", argProvider.requestHeader("user-agent")))
           .bindNow()
           .onDispose()
           .block();
 
 
```
    Parameters:
    
    accessLog - apply an AccessLog by an AccessLogArgProvider
    
    Returns:
    
    a new HttpServer
  - bindAddress
```
public final HttpServer bindAddress(java.util.function.Supplier<? extends java.net.SocketAddress> bindAddressSupplier)
```
    Description copied from class: Transport
    
    Set a new local address to which this transport should bind on subscribe.
    
    Overrides:
    
    bindAddress in class Transport<HttpServer,HttpServerConfig>
    
    Parameters:
    
    bindAddressSupplier - A supplier of the address to bind to.
    
    Returns:
    
    a new Transport
  - channelGroup
```
public final HttpServer channelGroup(io.netty.channel.group.ChannelGroup channelGroup)
```
    Description copied from class: Transport
    
    Provide a ChannelGroup to hold all active connected channels.
    Graceful Shutdown:
    When a ChannelGroup is set, calls to DisposableChannel.disposeNow() and DisposableChannel.disposeNow(Duration) not only stop accepting new requests but also additionally wait for all active requests, in the ChannelGroup, to complete, within the given timeout.
    
    Overrides:
    
    channelGroup in class Transport<HttpServer,HttpServerConfig>
    
    Parameters:
    
    channelGroup - a ChannelGroup
    
    Returns:
    
    a new Transport reference
  - 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
  - compress
```
public final HttpServer compress(boolean compressionEnabled)
```
    Specifies whether GZip response compression is enabled if the client request presents accept encoding.
    
    Parameters:
    
    compressionEnabled - if true GZip response compression is enabled if the client request presents accept encoding, 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
  - cookieCodec
```
public final HttpServer cookieCodec(io.netty.handler.codec.http.cookie.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(io.netty.handler.codec.http.cookie.ServerCookieEncoder encoder,
                                    io.netty.handler.codec.http.cookie.ServerCookieDecoder decoder)
```
    Configure the ServerCookieEncoder and ServerCookieDecoder
    
    Parameters:
    
    encoder - the preferred ServerCookieEncoder
    
    decoder - the preferred ServerCookieDecoder
    
    Returns:
    
    a new HttpServer
  - forwarded
```
public final HttpServer forwarded(java.util.function.BiFunction<ConnectionInfo,io.netty.handler.codec.http.HttpRequest,ConnectionInfo> handler)
```
    Specifies a custom request handler for deriving information about the connection.
    
    Parameters:
    
    handler - the forwarded header handler
    
    Returns:
    
    a new HttpServer
    
    Since:
    
    0.9.12
  - 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
    
    Since:
    
    0.9.7
  - handle
```
public final HttpServer handle(java.util.function.BiFunction<? super HttpServerRequest,? super HttpServerResponse,? extends org.reactivestreams.Publisher<java.lang.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
  - host
```
public final HttpServer host(java.lang.String host)
```
    Description copied from class: ServerTransport
    
    The host to which this server should bind.
    
    Overrides:
    
    host in class ServerTransport<HttpServer,HttpServerConfig>
    
    Parameters:
    
    host - the host to bind to.
    
    Returns:
    
    a new ServerTransport reference
  - http2Settings
```
public final HttpServer http2Settings(java.util.function.Consumer<Http2SettingsSpec.Builder> http2Settings)
```
    Apply HTTP/2 configuration
    
    Parameters:
    
    http2Settings - configures Http2SettingsSpec before requesting
    
    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
  - mapHandle
```
public final HttpServer mapHandle(java.util.function.BiFunction<? super reactor.core.publisher.Mono<java.lang.Void>,? super Connection,? extends reactor.core.publisher.Mono<java.lang.Void>> mapHandle)
```
    Decorate the configured I/O handler. See handle(BiFunction).
    
    Parameters:
    
    mapHandle - A BiFunction to decorate the configured I/O handler
    
    Returns:
    
    a new HttpServer
  - metrics
```
public final HttpServer metrics(boolean enable,
                                java.util.function.Function<java.lang.String,java.lang.String> uriTagValue)
```
    Whether to enable metrics to be collected and registered in Micrometer's globalRegistry under the name Metrics.HTTP_SERVER_PREFIX.
    uriTagValue function receives the actual uri and returns the uri tag value that will be used for the metrics with Metrics.URI tag. For example instead of using the actual uri "/users/1" as uri tag value, templated uri "/users/{id}" can be used.
    Note: It is strongly recommended applications to configure an upper limit for the number of the URI tags. For example:
```
 Metrics.globalRegistry
        .config()
        .meterFilter(MeterFilter.maximumAllowableTags(HTTP_SERVER_PREFIX, URI, 100, MeterFilter.deny()));
 
```
    By default metrics are not enabled.
    Parameters:
    
    enable - true enables metrics collection; false disables it
    
    uriTagValue - a function that receives the actual uri and returns the uri tag value that will be used for the metrics with Metrics.URI tag
    
    Returns:
    
    a new HttpServer
    
    Since:
    
    0.9.7
  - metrics
```
public final HttpServer metrics(boolean enable,
                                java.util.function.Supplier<? extends ChannelMetricsRecorder> recorder)
```
    Description copied from class: Transport
    
    Specifies whether the metrics are enabled on the Transport. All generated metrics are provided to the specified recorder which is only instantiated if metrics are being enabled.
    
    Overrides:
    
    metrics in class Transport<HttpServer,HttpServerConfig>
    
    Parameters:
    
    enable - if true enables the metrics on the Transport.
    
    recorder - a supplier for the ChannelMetricsRecorder
    
    Returns:
    
    a new Transport reference
  - metrics
```
public final HttpServer metrics(boolean enable,
                                java.util.function.Supplier<? extends ChannelMetricsRecorder> recorder,
                                java.util.function.Function<java.lang.String,java.lang.String> uriValue)
```
    Specifies whether the metrics are enabled on the HttpServer. All generated metrics are provided to the specified recorder which is only instantiated if metrics are being enabled.
    uriValue function receives the actual uri and returns the uri value that will be used when the metrics are propagated to the recorder. For example instead of using the actual uri "/users/1" as uri value, templated uri "/users/{id}" can be used.
    
    Parameters:
    
    enable - true enables metrics collection; false disables it
    
    recorder - a supplier for the metrics recorder that receives the collected metrics
    
    uriValue - a function that receives the actual uri and returns the uri value that will be used when the metrics are propagated to the recorder.
    
    Returns:
    
    a new HttpServer
  - noSSL
```
public final HttpServer noSSL()
```
    Removes any previously applied SSL configuration customization
    
    Returns:
    
    a new HttpServer
  - port
```
public final HttpServer port(int port)
```
    Description copied from class: ServerTransport
    
    The port to which this server should bind.
    
    Overrides:
    
    port in class ServerTransport<HttpServer,HttpServerConfig>
    
    Parameters:
    
    port - The port to bind to.
    
    Returns:
    
    a new ServerTransport reference
  - 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
  - proxyProtocol
```
public final HttpServer proxyProtocol(ProxyProtocolSupportType proxyProtocolSupportType)
```
    Specifies whether support for the "HAProxy proxy protocol" for deriving information about the address of the remote peer is enabled.
    Parameters:
    proxyProtocolSupportType -
    
    choose ProxyProtocolSupportType.ON to enable support for the "HAProxy proxy protocol" for deriving information about the address of the remote peer.
    
    choose ProxyProtocolSupportType.OFF to disable the proxy protocol support.
    
    choose ProxyProtocolSupportType.AUTO then each connection of the same HttpServer will auto detect whether there is proxy protocol, so HttpServer can accept requests with or without proxy protocol at the same time.
    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
  - 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
  - secure
```
public final HttpServer secure(SslProvider sslProvider)
```
    Applies an SSL configuration via the passed SslProvider. 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:
    
    sslProvider - The provider to set when configuring SSL
    
    Returns:
    
    a new HttpServer
  - tcpConfiguration
```
@Deprecated
public final HttpServer tcpConfiguration(java.util.function.Function<? super TcpServer,? extends TcpServer> tcpMapper)
```
    Deprecated. Use HttpServer methods for TCP level configurations. This method will be removed in version 1.1.0.
    
    Apply a TcpServer mapping function to update TCP configuration and return an enriched HttpServer to use.
    
    Parameters:
    
    tcpMapper - A TcpServer mapping function to update TCP configuration and return an enriched HttpServer to use.
    
    Returns:
    
    a new HttpServer
  - wiretap
```
public final HttpServer wiretap(boolean enable)
```
    Description copied from class: Transport
    
    Apply or remove a wire logger configuration using Transport category, DEBUG logger level and AdvancedByteBufFormat.HEX_DUMP for ByteBuf format.
    
    Overrides:
    
    wiretap in class Transport<HttpServer,HttpServerConfig>
    
    Parameters:
    
    enable - specifies whether the wire logger configuration will be added to the pipeline
    
    Returns:
    
    a new Transport reference

Class HttpServer

Constructor Summary

Method Summary

Methods inherited from class reactor.netty.transport.ServerTransport

Methods inherited from class reactor.netty.transport.Transport

Methods inherited from class java.lang.Object

Constructor Detail

HttpServer

Method Detail

create

from

accessLog

bindAddress

channelGroup

compress

compress

compress

cookieCodec

cookieCodec

forwarded

forwarded

handle

host

http2Settings

httpRequestDecoder

mapHandle

metrics

metrics

metrics

noSSL

port

protocol

proxyProtocol

route

secure

secure

tcpConfiguration

wiretap