ServerBuilder (filter-service-metrics 1.13 1.13 API)

java.lang.Object
- com.linecorp.armeria.server.ServerBuilder

public final class ServerBuilder
extends Object

Builds a new Server and its ServerConfig.

Example


 ServerBuilder sb = Server.builder();
 // Add a port to listen
 sb.http(8080);
 // Add services to the default virtual host.
 sb.service(...);
 sb.serviceUnder(...);
 // Build a server.
 Server s = sb.build();

Example 2


 ServerBuilder sb = Server.builder();
 Server server =
     sb.http(8080) // Add a port to listen
       .defaultVirtualHost() // Add services to the default virtual host.
           .service(...)
           .serviceUnder(...)
       .and().virtualHost("*.foo.com") // Add a another virtual host.
           .service(...)
           .serviceUnder(...)
       .and().build(); // Build a server.

What happens if no HTTP(S) port is specified?

When no TCP/IP port number or local address is specified, ServerBuilder will automatically bind to a random TCP/IP port assigned by the OS. It will serve HTTPS if you configured TLS (or HTTP otherwise), e.g.


 // Build an HTTP server that runs on an ephemeral TCP/IP port.
 Server httpServer = Server.builder()
                           .service(...)
                           .build();

 // Build an HTTPS server that runs on an ephemeral TCP/IP port.
 Server httpsServer = Server.builder()
                            .tls(...)
                            .service(...)
                            .build();

See Also:: VirtualHostBuilder

Constructor Summary

Constructors
Constructor and Description

ServerBuilder()
Deprecated.
Use Server.builder().

Constructors
Constructor and Description
`ServerBuilder()` Deprecated. Use `Server.builder()`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ServerBuilder`	`accessLogFormat(String accessLogFormat)` Sets the format of this `Server`'s access log.
`ServerBuilder`	`accessLogger(Function<? super VirtualHost,? extends org.slf4j.Logger> mapper)` Sets the default access logger mapper for all `VirtualHost`s.
`ServerBuilder`	`accessLogger(org.slf4j.Logger logger)` Sets the default access `Logger` for all `VirtualHost`s.
`ServerBuilder`	`accessLogger(String loggerName)` Sets the default access logger name for all `VirtualHost`s.
`ServerBuilder`	`accessLogWriter(AccessLogWriter accessLogWriter, boolean shutdownOnStop)` Sets an access log writer of this `Server`.
`AnnotatedServiceBindingBuilder`	`annotatedService()` Returns an `AnnotatedServiceBindingBuilder` to build annotated service.
`ServerBuilder`	`annotatedService(Object service)` Binds the specified annotated service object under the path prefix `"/"`.
`ServerBuilder`	`annotatedService(Object service, Function<? super HttpService,? extends HttpService> decorator, Object... exceptionHandlersAndConverters)` Binds the specified annotated service object under the path prefix `"/"`.
`ServerBuilder`	`annotatedService(Object service, Object... exceptionHandlersAndConverters)` Binds the specified annotated service object under the path prefix `"/"`.
`ServerBuilder`	`annotatedService(String pathPrefix, Object service)` Binds the specified annotated service object under the specified path prefix.
`ServerBuilder`	`annotatedService(String pathPrefix, Object service, Function<? super HttpService,? extends HttpService> decorator, Iterable<?> exceptionHandlersAndConverters)` Binds the specified annotated service object under the specified path prefix.
`ServerBuilder`	`annotatedService(String pathPrefix, Object service, Function<? super HttpService,? extends HttpService> decorator, Iterable<? extends ExceptionHandlerFunction> exceptionHandlerFunctions, Iterable<? extends RequestConverterFunction> requestConverterFunctions, Iterable<? extends ResponseConverterFunction> responseConverterFunctions)` Binds the specified annotated service object under the specified path prefix.
`ServerBuilder`	`annotatedService(String pathPrefix, Object service, Function<? super HttpService,? extends HttpService> decorator, Object... exceptionHandlersAndConverters)` Binds the specified annotated service object under the specified path prefix.
`ServerBuilder`	`annotatedService(String pathPrefix, Object service, Iterable<?> exceptionHandlersAndConverters)` Binds the specified annotated service object under the specified path prefix.
`ServerBuilder`	`annotatedService(String pathPrefix, Object service, Object... exceptionHandlersAndConverters)` Binds the specified annotated service object under the specified path prefix.
`ServerBuilder`	`annotatedServiceExtensions(Iterable<? extends RequestConverterFunction> requestConverterFunctions, Iterable<? extends ResponseConverterFunction> responseConverterFunctions, Iterable<? extends ExceptionHandlerFunction> exceptionHandlerFunctions)` Sets the `RequestConverterFunction`s, `ResponseConverterFunction` and `ExceptionHandlerFunction`s for creating an `AnnotatedServiceExtensions`.
`ServerBuilder`	`blockingTaskExecutor(ScheduledExecutorService blockingTaskExecutor, boolean shutdownOnStop)` Sets the `ScheduledExecutorService` dedicated to the execution of blocking tasks or invocations.
`Server`	`build()` Returns a newly-created `Server` based on the configuration properties set so far.
`<T> ServerBuilder`	`channelOption(io.netty.channel.ChannelOption<T> option, T value)` Sets the `ChannelOption` of the server socket bound by `Server`.
`<T> ServerBuilder`	`childChannelOption(io.netty.channel.ChannelOption<T> option, T value)` Sets the `ChannelOption` of sockets accepted by `Server`.
`ServerBuilder`	`clientAddressFilter(Predicate<? super InetAddress> clientAddressFilter)` Sets a filter which evaluates whether an `InetAddress` can be used as a client address.
`ServerBuilder`	`clientAddressMapper(Function<? super ProxiedAddresses,? extends InetSocketAddress> clientAddressMapper)` Sets a `Function` to use when determining the client address from `ProxiedAddresses`.
`ServerBuilder`	`clientAddressSources(ClientAddressSource... clientAddressSources)` Sets a list of `ClientAddressSource`s which are used to determine where to look for the client address, in the order of preference.
`ServerBuilder`	`clientAddressSources(Iterable<ClientAddressSource> clientAddressSources)` Sets a list of `ClientAddressSource`s which are used to determine where to look for the client address, in the order of preference.
`ServerBuilder`	`clientAddressTrustedProxyFilter(Predicate<? super InetAddress> clientAddressTrustedProxyFilter)` Sets a filter which evaluates whether an `InetAddress` of a remote endpoint is trusted.
`ServerBuilder`	`decorator(DecoratingHttpServiceFunction decoratingHttpServiceFunction)` Decorates all `HttpService`s with the specified `DecoratingHttpServiceFunction`.
`ServerBuilder`	`decorator(Function<? super HttpService,? extends HttpService> decorator)` Decorates all `HttpService`s with the specified `decorator`.
`ServerBuilder`	`decorator(Route route, DecoratingHttpServiceFunction decoratingHttpServiceFunction)` Decorates `HttpService`s with the specified `Route`.
`ServerBuilder`	`decorator(Route route, Function<? super HttpService,? extends HttpService> decorator)` Decorates `HttpService`s with the specified `Route`.
`ServerBuilder`	`decorator(String pathPattern, DecoratingHttpServiceFunction decoratingHttpServiceFunction)` Decorates `HttpService`s whose `Route` matches the specified `pathPattern`.
`ServerBuilder`	`decorator(String pathPattern, Function<? super HttpService,? extends HttpService> decorator)` Decorates `HttpService`s whose `Route` matches the specified `pathPattern`.
`ServerBuilder`	`decoratorUnder(String prefix, DecoratingHttpServiceFunction decoratingHttpServiceFunction)` Decorates `HttpService`s under the specified directory.
`ServerBuilder`	`decoratorUnder(String prefix, Function<? super HttpService,? extends HttpService> decorator)` Decorates `HttpService`s under the specified directory.
`ServerBuilder`	`defaultHostname(String defaultHostname)` Sets the default hostname of the default `VirtualHostBuilder`.
`ServerBuilder`	`defaultMaxRequestLength(long maxRequestLength)` Deprecated. Use `maxRequestLength(long)`.
`ServerBuilder`	`defaultRequestTimeout(Duration requestTimeout)` Deprecated. Use `requestTimeout(Duration)`.
`ServerBuilder`	`defaultRequestTimeoutMillis(long requestTimeoutMillis)` Deprecated. Use `requestTimeoutMillis(long)`.
`VirtualHostBuilder`	`defaultVirtualHost()` Returns the `VirtualHostBuilder` for building the default name-based virtual host.
`ServerBuilder`	`disableDateHeader()` Sets the response header not to include default `"Date"` header.
`ServerBuilder`	`disableServerHeader()` Sets the response header not to include default `"Server"` header.
`ServerBuilder`	`gracefulShutdownTimeout(Duration quietPeriod, Duration timeout)` Sets the amount of time to wait after calling `Server.stop()` for requests to go away before actually shutting down.
`ServerBuilder`	`gracefulShutdownTimeout(long quietPeriodMillis, long timeoutMillis)` Deprecated. Use `gracefulShutdownTimeoutMillis(long, long)`.
`ServerBuilder`	`gracefulShutdownTimeoutMillis(long quietPeriodMillis, long timeoutMillis)` Sets the amount of time to wait after calling `Server.stop()` for requests to go away before actually shutting down.
`ServerBuilder`	`http(InetSocketAddress localAddress)` Adds an HTTP port that listens to the specified `localAddress`.
`ServerBuilder`	`http(int port)` Adds an HTTP port that listens on all available network interfaces.
`ServerBuilder`	`http1MaxChunkSize(int http1MaxChunkSize)` Sets the maximum length of each chunk in an HTTP/1 response content.
`ServerBuilder`	`http1MaxHeaderSize(int http1MaxHeaderSize)` Sets the maximum length of all headers in an HTTP/1 response.
`ServerBuilder`	`http1MaxInitialLineLength(int http1MaxInitialLineLength)` Sets the maximum length of an HTTP/1 response initial line.
`ServerBuilder`	`http2InitialConnectionWindowSize(int http2InitialConnectionWindowSize)` Sets the initial connection-level HTTP/2 flow control window size.
`ServerBuilder`	`http2InitialStreamWindowSize(int http2InitialStreamWindowSize)` Sets the initial stream-level HTTP/2 flow control window size.
`ServerBuilder`	`http2MaxFrameSize(int http2MaxFrameSize)` Sets the maximum size of HTTP/2 frame that can be received.
`ServerBuilder`	`http2MaxHeaderListSize(long http2MaxHeaderListSize)` Sets the maximum size of headers that can be received.
`ServerBuilder`	`http2MaxStreamsPerConnection(long http2MaxStreamsPerConnection)` Sets the maximum number of concurrent streams per HTTP/2 connection.
`ServerBuilder`	`https(InetSocketAddress localAddress)` Adds an HTTPS port that listens to the specified `localAddress`.
`ServerBuilder`	`https(int port)` Adds an HTTPS port that listens on all available network interfaces.
`ServerBuilder`	`idleTimeout(Duration idleTimeout)` Sets the idle timeout of a connection for keep-alive.
`ServerBuilder`	`idleTimeoutMillis(long idleTimeoutMillis)` Sets the idle timeout of a connection in milliseconds for keep-alive.
`ServerBuilder`	`maxNumConnections(int maxNumConnections)` Sets the maximum allowed number of open connections.
`ServerBuilder`	`maxRequestLength(long maxRequestLength)` Sets the maximum allowed length of the content decoded at the session layer.
`ServerBuilder`	`meterRegistry(MeterRegistry meterRegistry)` Sets the `MeterRegistry` that collects various stats.
`ServerBuilder`	`port(InetSocketAddress localAddress, Iterable<SessionProtocol> protocols)` Adds a new `ServerPort` that listens to the specified `localAddress` using the specified `SessionProtocol`s.
`ServerBuilder`	`port(InetSocketAddress localAddress, SessionProtocol... protocols)` Adds a new `ServerPort` that listens to the specified `localAddress` using the specified `SessionProtocol`s.
`ServerBuilder`	`port(InetSocketAddress localAddress, String protocol)` Deprecated. Use `http(InetSocketAddress)` or `https(InetSocketAddress)`.
`ServerBuilder`	`port(int port, Iterable<SessionProtocol> protocols)` Adds a new `ServerPort` that listens to the specified `port` of all available network interfaces using the specified `SessionProtocol`s.
`ServerBuilder`	`port(int port, SessionProtocol... protocols)` Adds a new `ServerPort` that listens to the specified `port` of all available network interfaces using the specified `SessionProtocol`s.
`ServerBuilder`	`port(int port, String protocol)` Deprecated. Use `http(int)` or `https(int)`.
`ServerBuilder`	`port(ServerPort port)` Adds the specified `ServerPort`.
`ServerBuilder`	`proxyProtocolMaxTlvSize(int proxyProtocolMaxTlvSize)` Sets the maximum size of additional data for PROXY protocol.
`ServerBuilder`	`rejectedRouteHandler(RejectedRouteHandler handler)` Sets the `RejectedRouteHandler` which will be invoked when an attempt to bind an `HttpService` at a certain `Route` is rejected.
`ServerBuilder`	`requestIdGenerator(Supplier<? extends RequestId> requestIdGenerator)` Sets the `Supplier` which generates a `RequestId`.
`ServerBuilder`	`requestTimeout(Duration requestTimeout)` Sets the timeout of a request.
`ServerBuilder`	`requestTimeoutMillis(long requestTimeoutMillis)` Sets the timeout of a request in milliseconds.
`ServiceBindingBuilder`	`route()` Returns a `ServiceBindingBuilder` which is for binding an `HttpService` fluently.
`DecoratingServiceBindingBuilder`	`routeDecorator()` Returns a `DecoratingServiceBindingBuilder` which is for binding a `decorator` fluently.
`ServerBuilder`	`serverListener(ServerListener serverListener)` Adds the specified `ServerListener`.
`ServerBuilder`	`service(HttpServiceWithRoutes serviceWithRoutes, Function<? super HttpService,? extends HttpService>... decorators)` Decorates and binds the specified `HttpServiceWithRoutes` at multiple `Route`s of the default `VirtualHost`.
`ServerBuilder`	`service(HttpServiceWithRoutes serviceWithRoutes, Iterable<? extends Function<? super HttpService,? extends HttpService>> decorators)` Decorates and binds the specified `HttpServiceWithRoutes` at multiple `Route`s of the default `VirtualHost`.
`ServerBuilder`	`service(Route route, HttpService service)` Binds the specified `HttpService` at the specified `Route` of the default `VirtualHost`.
`ServerBuilder`	`service(String pathPattern, HttpService service)` Binds the specified `HttpService` at the specified path pattern of the default `VirtualHost`.
`ServerBuilder`	`serviceAt(String pathPattern, HttpService service)` Deprecated. Use `service(String, HttpService)` instead.
`ServerBuilder`	`serviceUnder(String pathPrefix, HttpService service)` Binds the specified `HttpService` under the specified directory of the default `VirtualHost`.
`ServerBuilder`	`startStopExecutor(Executor startStopExecutor)` Sets the `Executor` which will invoke the callbacks of `Server.start()`, `Server.stop()` and `ServerListener`.
`ServerBuilder`	`tls(File keyCertChainFile, File keyFile)` Configures SSL or TLS of the `Server` from the specified `keyCertChainFile` and cleartext `keyFile`.
`ServerBuilder`	`tls(File keyCertChainFile, File keyFile, Consumer<io.netty.handler.ssl.SslContextBuilder> tlsCustomizer)` Deprecated. Use `tls(File, File)` and `tlsCustomizer(Consumer)`.
`ServerBuilder`	`tls(File keyCertChainFile, File keyFile, String keyPassword)` Configures SSL or TLS of the `Server` from the specified `keyCertChainFile`, `keyFile` and `keyPassword`.
`ServerBuilder`	`tls(File keyCertChainFile, File keyFile, String keyPassword, Consumer<io.netty.handler.ssl.SslContextBuilder> tlsCustomizer)` Deprecated. Use `tls(File, File, String)` and `tlsCustomizer(Consumer)`.
`ServerBuilder`	`tls(InputStream keyCertChainInputStream, InputStream keyInputStream)` Configures SSL or TLS of this `Server` with the specified `keyCertChainInputStream` and cleartext `keyInputStream`.
`ServerBuilder`	`tls(InputStream keyCertChainInputStream, InputStream keyInputStream, String keyPassword)` Configures SSL or TLS of this `Server` with the specified `keyCertChainInputStream`, `keyInputStream` and `keyPassword`.
`ServerBuilder`	`tls(KeyManagerFactory keyManagerFactory)` Configures SSL or TLS of this `Server` with the specified `KeyManagerFactory`.
`ServerBuilder`	`tls(KeyManagerFactory keyManagerFactory, Consumer<io.netty.handler.ssl.SslContextBuilder> tlsCustomizer)` Deprecated. Use `tls(KeyManagerFactory)` and `tlsCustomizer(Consumer)`.
`ServerBuilder`	`tls(PrivateKey key, Iterable<? extends X509Certificate> keyCertChain)` Configures SSL or TLS of this `Server` with the specified cleartext `PrivateKey` and `X509Certificate` chain.
`ServerBuilder`	`tls(PrivateKey key, String keyPassword, Iterable<? extends X509Certificate> keyCertChain)` Configures SSL or TLS of this `Server` with the specified `PrivateKey`, `keyPassword` and `X509Certificate` chain.
`ServerBuilder`	`tls(PrivateKey key, String keyPassword, X509Certificate... keyCertChain)` Configures SSL or TLS of this `Server` with the specified `PrivateKey`, `keyPassword` and `X509Certificate` chain.
`ServerBuilder`	`tls(PrivateKey key, X509Certificate... keyCertChain)` Configures SSL or TLS of this `Server` with the specified cleartext `PrivateKey` and `X509Certificate` chain.
`ServerBuilder`	`tls(io.netty.handler.ssl.SslContext sslContext)` Deprecated. This method has been deprecated because an incorrectly built `SslContext` can cause a `Server` to malfunction. Use other `tls()` methods.
`ServerBuilder`	`tlsCustomizer(Consumer<? super io.netty.handler.ssl.SslContextBuilder> tlsCustomizer)` Adds the `Consumer` which can arbitrarily configure the `SslContextBuilder` that will be applied to the SSL session.
`ServerBuilder`	`tlsSelfSigned()` Configures SSL or TLS of the `Server` with an auto-generated self-signed certificate.
`ServerBuilder`	`tlsSelfSigned(boolean tlsSelfSigned)` Configures SSL or TLS of the `Server` with an auto-generated self-signed certificate.
`String`	`toString()`
`ServerBuilder`	`verboseResponses(boolean verboseResponses)` Sets whether the verbose response mode is enabled.
`VirtualHostBuilder`	`virtualHost(String hostnamePattern)` Adds the name-based virtual host.
`VirtualHostBuilder`	`virtualHost(String defaultHostname, String hostnamePattern)` Adds the name-based virtual host.
`VirtualHostBuilder`	`withDefaultVirtualHost()` Deprecated. Use `defaultVirtualHost()`.
`ServerBuilder`	`withDefaultVirtualHost(Consumer<? super VirtualHostBuilder> customizer)` Configures the default `VirtualHost` with the `customizer`.
`ServerBuilder`	`withRoute(Consumer<? super ServiceBindingBuilder> customizer)` Configures an `HttpService` of the default `VirtualHost` with the `customizer`.
`ServerBuilder`	`withVirtualHost(Consumer<? super VirtualHostBuilder> customizer)` Configures a `VirtualHost` with the `customizer`.
`VirtualHostBuilder`	`withVirtualHost(String hostnamePattern)` Deprecated. Use `virtualHost(String)`.
`VirtualHostBuilder`	`withVirtualHost(String defaultHostname, String hostnamePattern)` Deprecated. Use `virtualHost(String, String)`.
`ServerBuilder`	`workerGroup(io.netty.channel.EventLoopGroup workerGroup, boolean shutdownOnStop)` Sets the worker `EventLoopGroup` which is responsible for performing socket I/O and running `Service.serve(ServiceRequestContext, Request)`.

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

- Constructor Detail
  - ServerBuilder
```
@Deprecated
public ServerBuilder()
```
    Deprecated. Use Server.builder().
    
    Returns a new ServerBuilder.
- Method Detail
  - http
```
public ServerBuilder http(int port)
```
    Adds an HTTP port that listens on all available network interfaces.
    
    Parameters:
    
    port - the HTTP port number.
    
    See Also:
    
    http(InetSocketAddress), What happens if no HTTP(S) port is specified?
  - http
```
public ServerBuilder http(InetSocketAddress localAddress)
```
    Adds an HTTP port that listens to the specified localAddress.
    
    Parameters:
    
    localAddress - the local address to bind
    
    See Also:
    
    http(int), What happens if no HTTP(S) port is specified?
  - https
```
public ServerBuilder https(int port)
```
    Adds an HTTPS port that listens on all available network interfaces.
    
    Parameters:
    
    port - the HTTPS port number.
    
    See Also:
    
    https(InetSocketAddress), What happens if no HTTP(S) port is specified?
  - https
```
public ServerBuilder https(InetSocketAddress localAddress)
```
    Adds an HTTPS port that listens to the specified localAddress.
    
    Parameters:
    
    localAddress - the local address to bind
    
    See Also:
    
    http(int), What happens if no HTTP(S) port is specified?
  - port
```
@Deprecated
public ServerBuilder port(int port,
                                      String protocol)
```
    Deprecated. Use http(int) or https(int).
    
    Adds a new ServerPort that listens to the specified port of all available network interfaces using the specified protocol.
    
    See Also:
    
    What happens if no HTTP(S) port is specified?
  - port
```
public ServerBuilder port(int port,
                          SessionProtocol... protocols)
```
    Adds a new ServerPort that listens to the specified port of all available network interfaces using the specified SessionProtocols. Specify multiple protocols to serve more than one protocol on the same port:
```
 ServerBuilder sb = Server.builder();
 // Serve both HTTP and HTTPS at port 8080.
 sb.port(8080,
         SessionProtocol.HTTP,
         SessionProtocol.HTTPS);
 // Enable HTTPS with PROXY protocol support at port 8443.
 sb.port(8443,
         SessionProtocol.PROXY,
         SessionProtocol.HTTPS);
 
```
  - port
```
public ServerBuilder port(int port,
                          Iterable<SessionProtocol> protocols)
```
    Adds a new ServerPort that listens to the specified port of all available network interfaces using the specified SessionProtocols. Specify multiple protocols to serve more than one protocol on the same port:
```
 ServerBuilder sb = Server.builder();
 // Serve both HTTP and HTTPS at port 8080.
 sb.port(8080,
         Arrays.asList(SessionProtocol.HTTP,
                       SessionProtocol.HTTPS));
 // Enable HTTPS with PROXY protocol support at port 8443.
 sb.port(8443,
         Arrays.asList(SessionProtocol.PROXY,
                       SessionProtocol.HTTPS));
 
```
  - port
```
@Deprecated
public ServerBuilder port(InetSocketAddress localAddress,
                                      String protocol)
```
    Deprecated. Use http(InetSocketAddress) or https(InetSocketAddress).
    
    Adds a new ServerPort that listens to the specified localAddress using the specified protocol.
  - port
```
public ServerBuilder port(InetSocketAddress localAddress,
                          SessionProtocol... protocols)
```
    Adds a new ServerPort that listens to the specified localAddress using the specified SessionProtocols. Specify multiple protocols to serve more than one protocol on the same port:
```
 ServerBuilder sb = Server.builder();
 // Serve both HTTP and HTTPS at port 8080.
 sb.port(new InetSocketAddress(8080),
         SessionProtocol.HTTP,
         SessionProtocol.HTTPS);
 // Enable HTTPS with PROXY protocol support at port 8443.
 sb.port(new InetSocketAddress(8443),
         SessionProtocol.PROXY,
         SessionProtocol.HTTPS);
 
```
  - port
```
public ServerBuilder port(InetSocketAddress localAddress,
                          Iterable<SessionProtocol> protocols)
```
    Adds a new ServerPort that listens to the specified localAddress using the specified SessionProtocols. Specify multiple protocols to serve more than one protocol on the same port:
```
 ServerBuilder sb = Server.builder();
 // Serve both HTTP and HTTPS at port 8080.
 sb.port(new InetSocketAddress(8080),
         Arrays.asList(SessionProtocol.HTTP,
                       SessionProtocol.HTTPS));
 // Enable HTTPS with PROXY protocol support at port 8443.
 sb.port(new InetSocketAddress(8443),
         Arrays.asList(SessionProtocol.PROXY,
                       SessionProtocol.HTTPS));
 
```
  - port
```
public ServerBuilder port(ServerPort port)
```
    Adds the specified ServerPort.
    
    See Also:
    
    What happens if no HTTP(S) port is specified?
  - channelOption
```
public <T> ServerBuilder channelOption(io.netty.channel.ChannelOption<T> option,
                                       T value)
```
    Sets the ChannelOption of the server socket bound by Server. Note that the previously added option will be overridden if the same option is set again.
```
 ServerBuilder sb = Server.builder();
 sb.channelOption(ChannelOption.BACKLOG, 1024);
 
```
  - childChannelOption
```
public <T> ServerBuilder childChannelOption(io.netty.channel.ChannelOption<T> option,
                                            T value)
```
    Sets the ChannelOption of sockets accepted by Server. Note that the previously added option will be overridden if the same option is set again.
```
 ServerBuilder sb = Server.builder();
 sb.childChannelOption(ChannelOption.SO_REUSEADDR, true)
   .childChannelOption(ChannelOption.SO_KEEPALIVE, true);
 
```
  - workerGroup
```
public ServerBuilder workerGroup(io.netty.channel.EventLoopGroup workerGroup,
                                 boolean shutdownOnStop)
```
    Sets the worker EventLoopGroup which is responsible for performing socket I/O and running Service.serve(ServiceRequestContext, Request). If not set, the common worker group is used.
    
    Parameters:
    
    shutdownOnStop - whether to shut down the worker EventLoopGroup when the Server stops
  - startStopExecutor
```
public ServerBuilder startStopExecutor(Executor startStopExecutor)
```
    Sets the Executor which will invoke the callbacks of Server.start(), Server.stop() and ServerListener. If not set, GlobalEventExecutor will be used by default.
  - maxNumConnections
```
public ServerBuilder maxNumConnections(int maxNumConnections)
```
    Sets the maximum allowed number of open connections.
  - idleTimeoutMillis
```
public ServerBuilder idleTimeoutMillis(long idleTimeoutMillis)
```
    Sets the idle timeout of a connection in milliseconds for keep-alive.
    
    Parameters:
    
    idleTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.
  - idleTimeout
```
public ServerBuilder idleTimeout(Duration idleTimeout)
```
    Sets the idle timeout of a connection for keep-alive.
    
    Parameters:
    
    idleTimeout - the timeout. 0 disables the timeout.
  - http2InitialConnectionWindowSize
```
public ServerBuilder http2InitialConnectionWindowSize(int http2InitialConnectionWindowSize)
```
    Sets the initial connection-level HTTP/2 flow control window size. Larger values can lower stream warmup time at the expense of being easier to overload the server. Defaults to Flags.defaultHttp2InitialConnectionWindowSize(). Note that this setting affects the connection-level window size, not the window size of streams.
    
    See Also:
    
    http2InitialStreamWindowSize(int)
  - http2InitialStreamWindowSize
```
public ServerBuilder http2InitialStreamWindowSize(int http2InitialStreamWindowSize)
```
    Sets the initial stream-level HTTP/2 flow control window size. Larger values can lower stream warmup time at the expense of being easier to overload the server. Defaults to Flags.defaultHttp2InitialStreamWindowSize(). Note that this setting affects the stream-level window size, not the window size of connections.
    
    See Also:
    
    http2InitialConnectionWindowSize(int)
  - http2MaxStreamsPerConnection
```
public ServerBuilder http2MaxStreamsPerConnection(long http2MaxStreamsPerConnection)
```
    Sets the maximum number of concurrent streams per HTTP/2 connection. Unset means there is no limit on the number of concurrent streams. Note, this differs from maxNumConnections(), which is the maximum number of HTTP/2 connections themselves, not the streams that are multiplexed over each.
  - http2MaxFrameSize
```
public ServerBuilder http2MaxFrameSize(int http2MaxFrameSize)
```
    Sets the maximum size of HTTP/2 frame that can be received. Defaults to Flags.defaultHttp2MaxFrameSize().
  - http2MaxHeaderListSize
```
public ServerBuilder http2MaxHeaderListSize(long http2MaxHeaderListSize)
```
    Sets the maximum size of headers that can be received. Defaults to Flags.defaultHttp2MaxHeaderListSize().
  - http1MaxInitialLineLength
```
public ServerBuilder http1MaxInitialLineLength(int http1MaxInitialLineLength)
```
    Sets the maximum length of an HTTP/1 response initial line.
  - http1MaxHeaderSize
```
public ServerBuilder http1MaxHeaderSize(int http1MaxHeaderSize)
```
    Sets the maximum length of all headers in an HTTP/1 response.
  - http1MaxChunkSize
```
public ServerBuilder http1MaxChunkSize(int http1MaxChunkSize)
```
    Sets the maximum length of each chunk in an HTTP/1 response content. The content or a chunk longer than this value will be split into smaller chunks so that their lengths never exceed it.
  - gracefulShutdownTimeoutMillis
```
public ServerBuilder gracefulShutdownTimeoutMillis(long quietPeriodMillis,
                                                   long timeoutMillis)
```
    Sets the amount of time to wait after calling Server.stop() for requests to go away before actually shutting down.
    
    Parameters:
    
    quietPeriodMillis - the number of milliseconds to wait for active requests to go end before shutting down. 0 means the server will stop right away without waiting.
    
    timeoutMillis - the number of milliseconds to wait before shutting down the server regardless of active requests. This should be set to a time greater than quietPeriodMillis to ensure the server shuts down even if there is a stuck request.
  - gracefulShutdownTimeout
```
@Deprecated
public ServerBuilder gracefulShutdownTimeout(long quietPeriodMillis,
                                                         long timeoutMillis)
```
    Deprecated. Use gracefulShutdownTimeoutMillis(long, long).
    
    Sets the amount of time to wait after calling Server.stop() for requests to go away before actually shutting down.
    
    Parameters:
    
    quietPeriodMillis - the number of milliseconds to wait for active requests to go end before shutting down. 0 means the server will stop right away without waiting.
    
    timeoutMillis - the number of milliseconds to wait before shutting down the server regardless of active requests. This should be set to a time greater than quietPeriodMillis to ensure the server shuts down even if there is a stuck request.
  - gracefulShutdownTimeout
```
public ServerBuilder gracefulShutdownTimeout(Duration quietPeriod,
                                             Duration timeout)
```
    Sets the amount of time to wait after calling Server.stop() for requests to go away before actually shutting down.
    
    Parameters:
    
    quietPeriod - the number of milliseconds to wait for active requests to go end before shutting down. Duration.ZERO means the server will stop right away without waiting.
    
    timeout - the amount of time to wait before shutting down the server regardless of active requests. This should be set to a time greater than quietPeriod to ensure the server shuts down even if there is a stuck request.
  - blockingTaskExecutor
```
public ServerBuilder blockingTaskExecutor(ScheduledExecutorService blockingTaskExecutor,
                                          boolean shutdownOnStop)
```
    Sets the ScheduledExecutorService dedicated to the execution of blocking tasks or invocations. If not set, the common pool is used.
    
    Parameters:
    
    shutdownOnStop - whether to shut down the ScheduledExecutorService when the Server stops
  - meterRegistry
```
public ServerBuilder meterRegistry(MeterRegistry meterRegistry)
```
    Sets the MeterRegistry that collects various stats.
  - accessLogFormat
```
public ServerBuilder accessLogFormat(String accessLogFormat)
```
    Sets the format of this Server's access log. The specified accessLogFormat would be parsed by AccessLogWriter.custom(String).
  - accessLogWriter
```
public ServerBuilder accessLogWriter(AccessLogWriter accessLogWriter,
                                     boolean shutdownOnStop)
```
    Sets an access log writer of this Server. AccessLogWriter.disabled() is used by default.
    
    Parameters:
    
    shutdownOnStop - whether to shut down the AccessLogWriter when the Server stops
  - proxyProtocolMaxTlvSize
```
public ServerBuilder proxyProtocolMaxTlvSize(int proxyProtocolMaxTlvSize)
```
    Sets the maximum size of additional data for PROXY protocol. The default value of this property is .
    Note: limiting TLV size only affects processing of v2, binary headers. Also, as allowed by the 1.5 spec, TLV data is currently ignored. For maximum performance, it would be best to configure your upstream proxy host to NOT send TLV data and set this property to 0.
  - tls
```
@Deprecated
public ServerBuilder tls(io.netty.handler.ssl.SslContext sslContext)
```
    Deprecated. This method has been deprecated because an incorrectly built SslContext can cause a Server to malfunction. Use other tls() methods.
    
    Sets the SslContext of the Server.
  - tls
```
public ServerBuilder tls(File keyCertChainFile,
                         File keyFile)
```
    Configures SSL or TLS of the Server from the specified keyCertChainFile and cleartext keyFile.
    
    See Also:
    
    tlsCustomizer(Consumer)
  - tls
```
@Deprecated
public ServerBuilder tls(File keyCertChainFile,
                                     File keyFile,
                                     Consumer<io.netty.handler.ssl.SslContextBuilder> tlsCustomizer)
```
    Deprecated. Use tls(File, File) and tlsCustomizer(Consumer).
    
    Configures SSL or TLS of the Server from the specified keyCertChainFile, cleartext keyFile and tlsCustomizer.
  - tls
```
public ServerBuilder tls(File keyCertChainFile,
                         File keyFile,
                         String keyPassword)
```
    Configures SSL or TLS of the Server from the specified keyCertChainFile, keyFile and keyPassword.
    
    See Also:
    
    tlsCustomizer(Consumer)
  - tls
```
@Deprecated
public ServerBuilder tls(File keyCertChainFile,
                                     File keyFile,
                                     String keyPassword,
                                     Consumer<io.netty.handler.ssl.SslContextBuilder> tlsCustomizer)
```
    Deprecated. Use tls(File, File, String) and tlsCustomizer(Consumer).
    
    Configures SSL or TLS of the Server from the specified keyCertChainFile, keyFile, keyPassword and tlsCustomizer.
  - tls
```
public ServerBuilder tls(InputStream keyCertChainInputStream,
                         InputStream keyInputStream)
```
    Configures SSL or TLS of this Server with the specified keyCertChainInputStream and cleartext keyInputStream.
    
    See Also:
    
    tlsCustomizer(Consumer)
  - tls
```
public ServerBuilder tls(InputStream keyCertChainInputStream,
                         InputStream keyInputStream,
                         String keyPassword)
```
    Configures SSL or TLS of this Server with the specified keyCertChainInputStream, keyInputStream and keyPassword.
    
    See Also:
    
    tlsCustomizer(Consumer)
  - tls
```
public ServerBuilder tls(PrivateKey key,
                         X509Certificate... keyCertChain)
```
    Configures SSL or TLS of this Server with the specified cleartext PrivateKey and X509Certificate chain.
    
    See Also:
    
    tlsCustomizer(Consumer)
  - tls
```
public ServerBuilder tls(PrivateKey key,
                         Iterable<? extends X509Certificate> keyCertChain)
```
    Configures SSL or TLS of this Server with the specified cleartext PrivateKey and X509Certificate chain.
    
    See Also:
    
    tlsCustomizer(Consumer)
  - tls
```
public ServerBuilder tls(PrivateKey key,
                         String keyPassword,
                         X509Certificate... keyCertChain)
```
    Configures SSL or TLS of this Server with the specified PrivateKey, keyPassword and X509Certificate chain.
    
    See Also:
    
    tlsCustomizer(Consumer)
  - tls
```
public ServerBuilder tls(PrivateKey key,
                         String keyPassword,
                         Iterable<? extends X509Certificate> keyCertChain)
```
    Configures SSL or TLS of this Server with the specified PrivateKey, keyPassword and X509Certificate chain.
    
    See Also:
    
    tlsCustomizer(Consumer)
  - tls
```
public ServerBuilder tls(KeyManagerFactory keyManagerFactory)
```
    Configures SSL or TLS of this Server with the specified KeyManagerFactory.
    
    See Also:
    
    tlsCustomizer(Consumer)
  - tls
```
@Deprecated
public ServerBuilder tls(KeyManagerFactory keyManagerFactory,
                                     Consumer<io.netty.handler.ssl.SslContextBuilder> tlsCustomizer)
```
    Deprecated. Use tls(KeyManagerFactory) and tlsCustomizer(Consumer).
    
    Configures SSL or TLS of the Server from the specified keyManagerFactory and tlsCustomizer.
  - tlsSelfSigned
```
public ServerBuilder tlsSelfSigned()
```
    Configures SSL or TLS of the Server with an auto-generated self-signed certificate. Note: You should never use this in production but only for a testing purpose.
    
    See Also:
    
    tlsCustomizer(Consumer)
  - tlsSelfSigned
```
public ServerBuilder tlsSelfSigned(boolean tlsSelfSigned)
```
    Configures SSL or TLS of the Server with an auto-generated self-signed certificate. Note: You should never use this in production but only for a testing purpose.
    
    See Also:
    
    tlsCustomizer(Consumer)
  - tlsCustomizer
```
public ServerBuilder tlsCustomizer(Consumer<? super io.netty.handler.ssl.SslContextBuilder> tlsCustomizer)
```
    Adds the Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session.
  - withRoute
```
public ServerBuilder withRoute(Consumer<? super ServiceBindingBuilder> customizer)
```
    Configures an HttpService of the default VirtualHost with the customizer.
  - route
```
public ServiceBindingBuilder route()
```
    Returns a ServiceBindingBuilder which is for binding an HttpService fluently.
  - routeDecorator
```
public DecoratingServiceBindingBuilder routeDecorator()
```
    Returns a DecoratingServiceBindingBuilder which is for binding a decorator fluently.
  - serviceAt
```
@Deprecated
public ServerBuilder serviceAt(String pathPattern,
                                           HttpService service)
```
    Deprecated. Use service(String, HttpService) instead.
    
    Binds the specified HttpService at the specified path pattern of the default VirtualHost.
  - serviceUnder
```
public ServerBuilder serviceUnder(String pathPrefix,
                                  HttpService service)
```
    Binds the specified HttpService under the specified directory of the default VirtualHost.
  - service
```
public ServerBuilder service(String pathPattern,
                             HttpService service)
```
    Binds the specified HttpService at the specified path pattern of the default VirtualHost. e.g.
    - /login (no path parameters)
    - /users/{userId} (curly-brace style)
    - /list/:productType/by/:ordering (colon style)
    - exact:/foo/bar (exact match)
    - prefix:/files (prefix match)
    - glob:/~*/downloads/** (glob pattern)
    - regex:^/files/(?<filePath>.*)$ (regular expression)
    Throws:
    
    IllegalArgumentException - if the specified path pattern is invalid
  - service
```
public ServerBuilder service(Route route,
                             HttpService service)
```
    Binds the specified HttpService at the specified Route of the default VirtualHost.
  - service
```
public ServerBuilder service(HttpServiceWithRoutes serviceWithRoutes,
                             Iterable<? extends Function<? super HttpService,? extends HttpService>> decorators)
```
    Decorates and binds the specified HttpServiceWithRoutes at multiple Routes of the default VirtualHost.
    
    Parameters:
    
    serviceWithRoutes - the HttpServiceWithRoutes.
    
    decorators - the decorator functions, which will be applied in the order specified.
  - service
```
@SafeVarargs
public final ServerBuilder service(HttpServiceWithRoutes serviceWithRoutes,
                                                Function<? super HttpService,? extends HttpService>... decorators)
```
    Decorates and binds the specified HttpServiceWithRoutes at multiple Routes of the default VirtualHost.
    
    Parameters:
    
    serviceWithRoutes - the HttpServiceWithRoutes.
    
    decorators - the decorator functions, which will be applied in the order specified.
  - annotatedService
```
public ServerBuilder annotatedService(Object service)
```
    Binds the specified annotated service object under the path prefix "/".
  - annotatedService
```
public ServerBuilder annotatedService(Object service,
                                      Object... exceptionHandlersAndConverters)
```
    Binds the specified annotated service object under the path prefix "/".
    
    Parameters:
    
    exceptionHandlersAndConverters - the ExceptionHandlerFunctions, the RequestConverterFunctions and/or the ResponseConverterFunctions
  - annotatedService
```
public ServerBuilder annotatedService(Object service,
                                      Function<? super HttpService,? extends HttpService> decorator,
                                      Object... exceptionHandlersAndConverters)
```
    Binds the specified annotated service object under the path prefix "/".
    
    Parameters:
    
    exceptionHandlersAndConverters - the ExceptionHandlerFunctions, the RequestConverterFunctions and/or the ResponseConverterFunctions
  - annotatedService
```
public ServerBuilder annotatedService(String pathPrefix,
                                      Object service)
```
    Binds the specified annotated service object under the specified path prefix.
  - annotatedService
```
public ServerBuilder annotatedService(String pathPrefix,
                                      Object service,
                                      Object... exceptionHandlersAndConverters)
```
    Binds the specified annotated service object under the specified path prefix.
    
    Parameters:
    
    exceptionHandlersAndConverters - the ExceptionHandlerFunctions, the RequestConverterFunctions and/or the ResponseConverterFunctions
  - annotatedService
```
public ServerBuilder annotatedService(String pathPrefix,
                                      Object service,
                                      Function<? super HttpService,? extends HttpService> decorator,
                                      Object... exceptionHandlersAndConverters)
```
    Binds the specified annotated service object under the specified path prefix.
    
    Parameters:
    
    exceptionHandlersAndConverters - the ExceptionHandlerFunctions, the RequestConverterFunctions and/or the ResponseConverterFunctions
  - annotatedService
```
public ServerBuilder annotatedService(String pathPrefix,
                                      Object service,
                                      Iterable<?> exceptionHandlersAndConverters)
```
    Binds the specified annotated service object under the specified path prefix.
    
    Parameters:
    
    exceptionHandlersAndConverters - the ExceptionHandlerFunctions, the RequestConverterFunctions and/or the ResponseConverterFunctions
  - annotatedService
```
public ServerBuilder annotatedService(String pathPrefix,
                                      Object service,
                                      Function<? super HttpService,? extends HttpService> decorator,
                                      Iterable<?> exceptionHandlersAndConverters)
```
    Binds the specified annotated service object under the specified path prefix.
    
    Parameters:
    
    exceptionHandlersAndConverters - the ExceptionHandlerFunction, the RequestConverterFunction and/or the ResponseConverterFunction
  - annotatedService
```
public ServerBuilder annotatedService(String pathPrefix,
                                      Object service,
                                      Function<? super HttpService,? extends HttpService> decorator,
                                      Iterable<? extends ExceptionHandlerFunction> exceptionHandlerFunctions,
                                      Iterable<? extends RequestConverterFunction> requestConverterFunctions,
                                      Iterable<? extends ResponseConverterFunction> responseConverterFunctions)
```
    Binds the specified annotated service object under the specified path prefix.
    
    Parameters:
    
    exceptionHandlerFunctions - the ExceptionHandlerFunctions
    
    requestConverterFunctions - the RequestConverterFunctions
    
    responseConverterFunctions - the ResponseConverterFunctions
  - annotatedService
```
public AnnotatedServiceBindingBuilder annotatedService()
```
    Returns an AnnotatedServiceBindingBuilder to build annotated service.
  - serverListener
```
public ServerBuilder serverListener(ServerListener serverListener)
```
    Adds the specified ServerListener.
  - defaultHostname
```
public ServerBuilder defaultHostname(String defaultHostname)
```
    Sets the default hostname of the default VirtualHostBuilder.
  - withDefaultVirtualHost
```
public ServerBuilder withDefaultVirtualHost(Consumer<? super VirtualHostBuilder> customizer)
```
    Configures the default VirtualHost with the customizer.
  - withDefaultVirtualHost
```
@Deprecated
public VirtualHostBuilder withDefaultVirtualHost()
```
    Deprecated. Use defaultVirtualHost().
    
    Returns the VirtualHostBuilder for building the default name-based virtual host.
  - defaultVirtualHost
```
public VirtualHostBuilder defaultVirtualHost()
```
    Returns the VirtualHostBuilder for building the default name-based virtual host.
  - withVirtualHost
```
public ServerBuilder withVirtualHost(Consumer<? super VirtualHostBuilder> customizer)
```
    Configures a VirtualHost with the customizer.
  - withVirtualHost
```
@Deprecated
public VirtualHostBuilder withVirtualHost(String hostnamePattern)
```
    Deprecated. Use virtualHost(String).
    
    Adds the name-based virtual host.
    
    Parameters:
    
    hostnamePattern - virtual host name regular expression
    
    Returns:
    
    VirtualHostBuilder for building the virtual host
  - withVirtualHost
```
@Deprecated
public VirtualHostBuilder withVirtualHost(String defaultHostname,
                                                      String hostnamePattern)
```
    Deprecated. Use virtualHost(String, String).
    
    Adds the name-based virtual host.
    
    Parameters:
    
    defaultHostname - default hostname of this virtual host
    
    hostnamePattern - virtual host name regular expression
    
    Returns:
    
    VirtualHostBuilder for building the virtual host
  - virtualHost
```
public VirtualHostBuilder virtualHost(String hostnamePattern)
```
    Adds the name-based virtual host.
    
    Parameters:
    
    hostnamePattern - virtual host name regular expression
    
    Returns:
    
    VirtualHostBuilder for building the virtual host
  - virtualHost
```
public VirtualHostBuilder virtualHost(String defaultHostname,
                                      String hostnamePattern)
```
    Adds the name-based virtual host.
    
    Parameters:
    
    defaultHostname - default hostname of this virtual host
    
    hostnamePattern - virtual host name regular expression
    
    Returns:
    
    VirtualHostBuilder for building the virtual host
  - decorator
```
public ServerBuilder decorator(Function<? super HttpService,? extends HttpService> decorator)
```
    Decorates all HttpServices with the specified decorator.
    
    Parameters:
    
    decorator - the Function that decorates HttpServices
  - decorator
```
public ServerBuilder decorator(DecoratingHttpServiceFunction decoratingHttpServiceFunction)
```
    Decorates all HttpServices with the specified DecoratingHttpServiceFunction.
    
    Parameters:
    
    decoratingHttpServiceFunction - the DecoratingHttpServiceFunction that decorates HttpServices
  - decorator
```
public ServerBuilder decorator(String pathPattern,
                               Function<? super HttpService,? extends HttpService> decorator)
```
    Decorates HttpServices whose Route matches the specified pathPattern.
  - decorator
```
public ServerBuilder decorator(String pathPattern,
                               DecoratingHttpServiceFunction decoratingHttpServiceFunction)
```
    Decorates HttpServices whose Route matches the specified pathPattern.
    
    Parameters:
    
    decoratingHttpServiceFunction - the DecoratingHttpServiceFunction that decorates HttpService.
  - decorator
```
public ServerBuilder decorator(Route route,
                               Function<? super HttpService,? extends HttpService> decorator)
```
    Decorates HttpServices with the specified Route.
    
    Parameters:
    
    route - the route being decorated
    
    decorator - the Function that decorates HttpService which matches the specified Route
  - decorator
```
public ServerBuilder decorator(Route route,
                               DecoratingHttpServiceFunction decoratingHttpServiceFunction)
```
    Decorates HttpServices with the specified Route.
    
    Parameters:
    
    route - the route being decorated
    
    decoratingHttpServiceFunction - the DecoratingHttpServiceFunction that decorates HttpServices
  - decoratorUnder
```
public ServerBuilder decoratorUnder(String prefix,
                                    DecoratingHttpServiceFunction decoratingHttpServiceFunction)
```
    Decorates HttpServices under the specified directory.
    
    Parameters:
    
    decoratingHttpServiceFunction - the DecoratingHttpServiceFunction that decorates HttpServices
  - decoratorUnder
```
public ServerBuilder decoratorUnder(String prefix,
                                    Function<? super HttpService,? extends HttpService> decorator)
```
    Decorates HttpServices under the specified directory.
  - clientAddressSources
```
public ServerBuilder clientAddressSources(ClientAddressSource... clientAddressSources)
```
    Sets a list of ClientAddressSources which are used to determine where to look for the client address, in the order of preference. Forwarded header, X-Forwarded-For header and the source address of a PROXY protocol header will be used by default.
  - clientAddressSources
```
public ServerBuilder clientAddressSources(Iterable<ClientAddressSource> clientAddressSources)
```
    Sets a list of ClientAddressSources which are used to determine where to look for the client address, in the order of preference. Forwarded header, X-Forwarded-For header and the source address of a PROXY protocol header will be used by default.
  - clientAddressTrustedProxyFilter
```
public ServerBuilder clientAddressTrustedProxyFilter(Predicate<? super InetAddress> clientAddressTrustedProxyFilter)
```
    Sets a filter which evaluates whether an InetAddress of a remote endpoint is trusted.
  - clientAddressFilter
```
public ServerBuilder clientAddressFilter(Predicate<? super InetAddress> clientAddressFilter)
```
    Sets a filter which evaluates whether an InetAddress can be used as a client address.
  - clientAddressMapper
```
public ServerBuilder clientAddressMapper(Function<? super ProxiedAddresses,? extends InetSocketAddress> clientAddressMapper)
```
    Sets a Function to use when determining the client address from ProxiedAddresses. If not set, the ProxiedAddresses.sourceAddress()} is used as a client address.
  - accessLogger
```
public ServerBuilder accessLogger(String loggerName)
```
    Sets the default access logger name for all VirtualHosts. The VirtualHosts which do not have an access logger specified by a VirtualHostBuilder will have the same access Logger named the loggerName when build() is called.
  - accessLogger
```
public ServerBuilder accessLogger(org.slf4j.Logger logger)
```
    Sets the default access Logger for all VirtualHosts. The VirtualHosts which do not have an access logger specified by a VirtualHostBuilder will have the same access Logger when build() is called.
  - accessLogger
```
public ServerBuilder accessLogger(Function<? super VirtualHost,? extends org.slf4j.Logger> mapper)
```
    Sets the default access logger mapper for all VirtualHosts. The VirtualHosts which do not have an access logger specified by a VirtualHostBuilder will have an access logger set by the mapper when build() is called.
  - rejectedRouteHandler
```
public ServerBuilder rejectedRouteHandler(RejectedRouteHandler handler)
```
    Sets the RejectedRouteHandler which will be invoked when an attempt to bind an HttpService at a certain Route is rejected. By default, the duplicate routes are logged at WARN level.
  - disableServerHeader
```
public ServerBuilder disableServerHeader()
```
    Sets the response header not to include default "Server" header.
  - disableDateHeader
```
public ServerBuilder disableDateHeader()
```
    Sets the response header not to include default "Date" header.
  - requestIdGenerator
```
public ServerBuilder requestIdGenerator(Supplier<? extends RequestId> requestIdGenerator)
```
    Sets the Supplier which generates a RequestId. By default, a RequestId is generated from a random 64-bit integer.
    
    See Also:
    
    RequestContext.id()
  - defaultRequestTimeout
```
@Deprecated
public ServerBuilder defaultRequestTimeout(Duration requestTimeout)
```
    Deprecated. Use requestTimeout(Duration).
    
    Sets the timeout of a request.
    
    Parameters:
    
    requestTimeout - the timeout. 0 disables the timeout.
  - defaultRequestTimeoutMillis
```
@Deprecated
public ServerBuilder defaultRequestTimeoutMillis(long requestTimeoutMillis)
```
    Deprecated. Use requestTimeoutMillis(long).
    
    Sets the timeout of a request in milliseconds.
    
    Parameters:
    
    requestTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.
  - requestTimeout
```
public ServerBuilder requestTimeout(Duration requestTimeout)
```
    Sets the timeout of a request.
    
    Parameters:
    
    requestTimeout - the timeout. 0 disables the timeout.
  - requestTimeoutMillis
```
public ServerBuilder requestTimeoutMillis(long requestTimeoutMillis)
```
    Sets the timeout of a request in milliseconds.
    
    Parameters:
    
    requestTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.
  - defaultMaxRequestLength
```
@Deprecated
public ServerBuilder defaultMaxRequestLength(long maxRequestLength)
```
    Deprecated. Use maxRequestLength(long).
    
    Sets the maximum allowed length of the content decoded at the session layer. e.g. the content length of an HTTP request.
    
    Parameters:
    
    maxRequestLength - the maximum allowed length. 0 disables the length limit.
  - maxRequestLength
```
public ServerBuilder maxRequestLength(long maxRequestLength)
```
    Sets the maximum allowed length of the content decoded at the session layer. e.g. the content length of an HTTP request.
    
    Parameters:
    
    maxRequestLength - the maximum allowed length. 0 disables the length limit.
  - verboseResponses
```
public ServerBuilder verboseResponses(boolean verboseResponses)
```
    Sets whether the verbose response mode is enabled. When enabled, the server responses will contain the exception type and its full stack trace, which may be useful for debugging while potentially insecure. When disabled, the server responses will not expose such server-side details to the client. The default value of this property is retrieved from Flags.verboseResponses().
  - annotatedServiceExtensions
```
public ServerBuilder annotatedServiceExtensions(Iterable<? extends RequestConverterFunction> requestConverterFunctions,
                                                Iterable<? extends ResponseConverterFunction> responseConverterFunctions,
                                                Iterable<? extends ExceptionHandlerFunction> exceptionHandlerFunctions)
```
    Sets the RequestConverterFunctions, ResponseConverterFunction and ExceptionHandlerFunctions for creating an AnnotatedServiceExtensions.
    
    Parameters:
    
    requestConverterFunctions - the RequestConverterFunctions
    
    responseConverterFunctions - the ResponseConverterFunctions
    
    exceptionHandlerFunctions - the ExceptionHandlerFunctions
  - build
```
public Server build()
```
    Returns a newly-created Server based on the configuration properties set so far.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ServerBuilder

Example

Example 2

What happens if no HTTP(S) port is specified?

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServerBuilder

Method Detail

http

http

https

https

port

port

port

port

port

port

port

channelOption

childChannelOption

workerGroup

startStopExecutor

maxNumConnections

idleTimeoutMillis

idleTimeout

http2InitialConnectionWindowSize

http2InitialStreamWindowSize

http2MaxStreamsPerConnection

http2MaxFrameSize

http2MaxHeaderListSize

http1MaxInitialLineLength

http1MaxHeaderSize

http1MaxChunkSize

gracefulShutdownTimeoutMillis

gracefulShutdownTimeout

gracefulShutdownTimeout

blockingTaskExecutor

meterRegistry

accessLogFormat

accessLogWriter

proxyProtocolMaxTlvSize

tls

tls

tls

tls

tls

tls

tls

tls

tls

tls

tls

tls

tls

tlsSelfSigned

tlsSelfSigned

tlsCustomizer

withRoute

route

routeDecorator

serviceAt

serviceUnder

service

service

service

service

annotatedService

annotatedService

annotatedService

annotatedService

annotatedService

annotatedService

annotatedService

annotatedService

annotatedService

annotatedService

serverListener