HttpServerBuilder (servicetalk-http-api 0.41.16 API)

Object
- HttpServerBuilder

public abstract class HttpServerBuilder
extends Object

A builder for building HTTP Servers.

Constructor Summary

Constructors
Constructor and Description

HttpServerBuilder()

Constructors
Constructor and Description
`HttpServerBuilder()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`abstract HttpServerBuilder`	`allowDropRequestTrailers(boolean allowDrop)` Provide a hint if request trailers are allowed to be dropped.
`HttpServerBuilder`	`appendConnectionAcceptorFilter(ConnectionAcceptorFactory factory)` Appends the filter to the chain of filters used to decorate the `ConnectionAcceptor` used by this builder.
`HttpServerBuilder`	`appendServiceFilter(Predicate<StreamingHttpRequest> predicate, StreamingHttpServiceFilterFactory factory)` Appends the filter to the chain of filters used to decorate the `StreamingHttpService` used by this builder, for every request that passes the provided `Predicate`.
`HttpServerBuilder`	`appendServiceFilter(StreamingHttpServiceFilterFactory factory)` Appends the filter to the chain of filters used to decorate the `StreamingHttpService` used by this builder.
`HttpServerBuilder`	`backlog(int backlog)` Deprecated. Use `listenSocketOption(SocketOption, Object)` with key `ServiceTalkSocketOptions.SO_BACKLOG`.
`abstract HttpServerBuilder`	`bufferAllocator(BufferAllocator allocator)` Sets the `BufferAllocator` to be used by this server.
`HttpServerBuilder`	`disableDrainingRequestPayloadBody()` Deprecated. Use `drainRequestPayloadBody(boolean)`.
`protected abstract Single<ServerContext>`	`doListen(ConnectionAcceptor connectionAcceptor, StreamingHttpService service, HttpExecutionStrategy strategy, boolean drainRequestPayloadBody)` Deprecated. This method will be removed. If you depend upon it consider copying the implementation from `DefaultHttpServerBuilder#doListen(ConnectionAcceptor, StreamingHttpService, HttpExecutionStrategy, boolean)`
`HttpServerBuilder`	`drainRequestPayloadBody(boolean enable)` Configure automatic consumption of request `payload body` when it is not consumed by the service.
`abstract HttpServerBuilder`	`enableWireLogging(String loggerName)` Deprecated. Use `enableWireLogging(String, LogLevel, BooleanSupplier)` instead.
`abstract HttpServerBuilder`	`enableWireLogging(String loggerName, LogLevel logLevel, BooleanSupplier logUserData)` Enables wire-logging for this server.
`HttpServerBuilder`	`executionStrategy(HttpExecutionStrategy strategy)` Sets the `HttpExecutionStrategy` to be used by this server.
`HttpServerBuilder`	`executor(Executor executor)` Sets the `Executor` to use.
`abstract HttpServerBuilder`	`ioExecutor(IoExecutor ioExecutor)` Sets the `IoExecutor` to be used by this server.
`HttpServerBuilder`	`lifecycleObserver(HttpLifecycleObserver lifecycleObserver)` Sets a `HttpLifecycleObserver` that provides visibility into HTTP lifecycle events.
`Single<ServerContext>`	`listen(HttpService service)` Starts this server and returns the `ServerContext` after the server has been successfully started.
`ServerContext`	`listenAndAwait(HttpService service)` Starts this server and returns the `ServerContext` after the server has been successfully started.
`Single<ServerContext>`	`listenBlocking(BlockingHttpService service)` Starts this server and returns the `ServerContext` after the server has been successfully started.
`ServerContext`	`listenBlockingAndAwait(BlockingHttpService service)` Starts this server and returns the `ServerContext` after the server has been successfully started.
`Single<ServerContext>`	`listenBlockingStreaming(BlockingStreamingHttpService service)` Starts this server and returns the `ServerContext` after the server has been successfully started.
`ServerContext`	`listenBlockingStreamingAndAwait(BlockingStreamingHttpService handler)` Starts this server and returns the `ServerContext` after the server has been successfully started.
`abstract <T> HttpServerBuilder`	`listenSocketOption(SocketOption<T> option, T value)` Adds a `SocketOption` that is applied to the server socket channel which listens/accepts socket channels.
`Single<ServerContext>`	`listenStreaming(StreamingHttpService service)` Starts this server and returns the `ServerContext` after the server has been successfully started.
`ServerContext`	`listenStreamingAndAwait(StreamingHttpService handler)` Starts this server and returns the `ServerContext` after the server has been successfully started.
`abstract HttpServerBuilder`	`protocols(HttpProtocolConfig... protocols)` Configurations of various HTTP protocol versions.
`abstract HttpServerSecurityConfigurator`	`secure()` Deprecated. Use `sslConfig(ServerSslConfig)`.
`abstract <T> HttpServerBuilder`	`socketOption(SocketOption<T> option, T value)` Adds a `SocketOption` that is applied to connected/accepted socket channels.
`abstract HttpServerBuilder`	`sslConfig(ServerSslConfig config)` Set the SSL/TLS configuration.
`abstract HttpServerBuilder`	`sslConfig(ServerSslConfig defaultConfig, Map<String,ServerSslConfig> sniMap)` Set the SSL/TLS and SNI configuration.
`abstract HttpServerBuilder`	`transportObserver(TransportObserver transportObserver)` Sets a `TransportObserver` that provides visibility into transport events.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HttpServerBuilder
```
public HttpServerBuilder()
```
- Method Detail
  - protocols
```
public abstract HttpServerBuilder protocols(HttpProtocolConfig... protocols)
```
    Configurations of various HTTP protocol versions.
    Note: the order of specified protocols will reflect on priorities for ALPN in case the connections use sslConfig(ServerSslConfig).
    
    Parameters:
    
    protocols - HttpProtocolConfig for each protocol that should be supported.
    
    Returns:
    
    this.
  - backlog
```
@Deprecated
public HttpServerBuilder backlog(int backlog)
```
    Deprecated. Use listenSocketOption(SocketOption, Object) with key ServiceTalkSocketOptions.SO_BACKLOG.
    
    Sets the maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full, the connection may time out.
    
    Parameters:
    
    backlog - the backlog to use when accepting connections.
    
    Returns:
    
    this.
  - secure
```
@Deprecated
public abstract HttpServerSecurityConfigurator secure()
```
    Deprecated. Use sslConfig(ServerSslConfig).
    
    Initiates security configuration for this server. Calling any commit method on the returned HttpServerSecurityConfigurator will commit the configuration.
    
    Returns:
    
    HttpServerSecurityConfigurator to configure security for this server. It is mandatory to call any one of the commit methods after all configuration is done.
  - sslConfig
```
public abstract HttpServerBuilder sslConfig(ServerSslConfig config)
```
    Set the SSL/TLS configuration.
    
    Parameters:
    
    config - The configuration to use.
    
    Returns:
    
    this.
  - sslConfig
```
public abstract HttpServerBuilder sslConfig(ServerSslConfig defaultConfig,
                                            Map<String,ServerSslConfig> sniMap)
```
    Set the SSL/TLS and SNI configuration.
    
    Parameters:
    
    defaultConfig - The configuration to use is the client certificate's SNI extension isn't present or the SNI hostname doesn't match any values in sniMap.
    
    sniMap - A map where the keys are matched against the client certificate's SNI extension value in order to provide the corresponding ServerSslConfig.
    
    Returns:
    
    this.
  - socketOption
```
public abstract <T> HttpServerBuilder socketOption(SocketOption<T> option,
                                                   T value)
```
    Adds a SocketOption that is applied to connected/accepted socket channels.
    
    Type Parameters:
    
    T - the type of the value.
    
    Parameters:
    
    option - the option to apply.
    
    value - the value.
    
    Returns:
    
    this.
    
    See Also:
    
    StandardSocketOptions, ServiceTalkSocketOptions
  - listenSocketOption
```
public abstract <T> HttpServerBuilder listenSocketOption(SocketOption<T> option,
                                                         T value)
```
    Adds a SocketOption that is applied to the server socket channel which listens/accepts socket channels.
    
    Type Parameters:
    
    T - the type of the value.
    
    Parameters:
    
    option - the option to apply.
    
    value - the value.
    
    Returns:
    
    this.
    
    See Also:
    
    StandardSocketOptions, ServiceTalkSocketOptions
  - enableWireLogging
```
@Deprecated
public abstract HttpServerBuilder enableWireLogging(String loggerName)
```
    Deprecated. Use enableWireLogging(String, LogLevel, BooleanSupplier) instead.
    
    Enables wire-logging for this server.
    
    Parameters:
    
    loggerName - The name of the logger to log wire events.
    
    Returns:
    
    this.
  - enableWireLogging
```
public abstract HttpServerBuilder enableWireLogging(String loggerName,
                                                    LogLevel logLevel,
                                                    BooleanSupplier logUserData)
```
    Enables wire-logging for this server.
    
    Parameters:
    
    loggerName - The name of the logger to log wire events.
    
    logLevel - The level to log at.
    
    logUserData - true to include user data (e.g. data, headers, etc.). false to exclude user data and log only network events.
    
    Returns:
    
    this.
  - transportObserver
```
public abstract HttpServerBuilder transportObserver(TransportObserver transportObserver)
```
    Sets a TransportObserver that provides visibility into transport events.
    
    Parameters:
    
    transportObserver - A TransportObserver that provides visibility into transport events.
    
    Returns:
    
    this.
  - lifecycleObserver
```
public HttpServerBuilder lifecycleObserver(HttpLifecycleObserver lifecycleObserver)
```
    Sets a HttpLifecycleObserver that provides visibility into HTTP lifecycle events.
    This method allows setting a HttpLifecycleObserver in a position that captures entire state of the execution chain, including all filters and internal post-processing. If it's necessary to observe an exchange after other filters or apply it conditionally, consider using io.servicetalk.http.netty.HttpLifecycleObserverServiceFilter instead.
    
    Parameters:
    
    lifecycleObserver - A HttpLifecycleObserver that provides visibility into HTTP lifecycle events.
    
    Returns:
    
    this.
  - disableDrainingRequestPayloadBody
```
@Deprecated
public HttpServerBuilder disableDrainingRequestPayloadBody()
```
    Deprecated. Use drainRequestPayloadBody(boolean).
    
    Disables automatic consumption of request payload body when it is not consumed by the service.
    For persistent HTTP connections it is required to eventually consume the entire request payload to enable reading of the next request. This is required because requests are pipelined for HTTP/1.1, so if the previous request is not completely read, next request can not be read from the socket. For cases when there is a possibility that user may forget to consume request payload, ServiceTalk automatically consumes request payload body. This automatic consumption behavior may create some overhead and can be disabled using this method when it is guaranteed that all request paths consumes all request payloads eventually. An example of guaranteed consumption are non-streaming APIs.
    
    Returns:
    
    this.
  - drainRequestPayloadBody
```
public HttpServerBuilder drainRequestPayloadBody(boolean enable)
```
    Configure automatic consumption of request payload body when it is not consumed by the service.
    For persistent HTTP connections it is required to eventually consume the entire request payload to enable reading of the next request. This is required because requests are pipelined for HTTP/1.1, so if the previous request is not completely read, next request can not be read from the socket. For cases when there is a possibility that user may forget to consume request payload, ServiceTalk automatically consumes request payload body. This automatic consumption behavior may create some overhead and can be disabled using this method when it is guaranteed that all request paths consumes all request payloads eventually. An example of guaranteed consumption are non-streaming APIs.
    
    Parameters:
    
    enable - When false it will disable the automatic consumption of request StreamingHttpRequest.payloadBody().
    
    Returns:
    
    this.
  - allowDropRequestTrailers
```
public abstract HttpServerBuilder allowDropRequestTrailers(boolean allowDrop)
```
    Provide a hint if request trailers are allowed to be dropped. This hint maybe ignored if the transport can otherwise infer that the trailers should be preserved. For example, if the request headers contain Trailer then this hint maybe ignored.
    
    Parameters:
    
    allowDrop - true if request trailers are allowed to be dropped.
    
    Returns:
    
    this
  - appendConnectionAcceptorFilter
```
public HttpServerBuilder appendConnectionAcceptorFilter(ConnectionAcceptorFactory factory)
```
    Appends the filter to the chain of filters used to decorate the ConnectionAcceptor used by this builder.
    The order of execution of these filters are in order of append. If 3 filters are added as follows:
```
     builder.appendConnectionAcceptorFilter(filter1).appendConnectionAcceptorFilter(filter2).
     appendConnectionAcceptorFilter(filter3)
 
```
    accepting a connection by a filter wrapped by this filter chain, the order of invocation of these filters will be:
```
     filter1 ⇒ filter2 ⇒ filter3
 
```
    Parameters:
    
    factory - ConnectionAcceptorFactory to append. Lifetime of this ConnectionAcceptorFactory is managed by this builder and the server started thereof.
    
    Returns:
    
    this
  - appendServiceFilter
```
public HttpServerBuilder appendServiceFilter(StreamingHttpServiceFilterFactory factory)
```
    Appends the filter to the chain of filters used to decorate the StreamingHttpService used by this builder.
    Note this method will be used to decorate the StreamingHttpService passed to listenStreaming(StreamingHttpService) before it is used by the server.
    The order of execution of these filters are in order of append. If 3 filters are added as follows:
```
     builder.append(filter1).append(filter2).append(filter3)
 
```
    accepting a request by a service wrapped by this filter chain, the order of invocation of these filters will be:
```
     filter1 ⇒ filter2 ⇒ filter3 ⇒ service
 
```
    Parameters:
    
    factory - StreamingHttpServiceFilterFactory to append.
    
    Returns:
    
    this
  - appendServiceFilter
```
public HttpServerBuilder appendServiceFilter(Predicate<StreamingHttpRequest> predicate,
                                             StreamingHttpServiceFilterFactory factory)
```
    Appends the filter to the chain of filters used to decorate the StreamingHttpService used by this builder, for every request that passes the provided Predicate.
    Note this method will be used to decorate the StreamingHttpService passed to listenStreaming(StreamingHttpService) before it is used by the server.
    The order of execution of these filters are in order of append. If 3 filters are added as follows:
```
     builder.append(filter1).append(filter2).append(filter3)
 
```
    accepting a request by a service wrapped by this filter chain, the order of invocation of these filters will be:
```
     filter1 ⇒ filter2 ⇒ filter3 ⇒ service
 
```
    Parameters:
    
    predicate - the Predicate to test if the filter must be applied.
    
    factory - StreamingHttpServiceFilterFactory to append.
    
    Returns:
    
    this
  - ioExecutor
```
public abstract HttpServerBuilder ioExecutor(IoExecutor ioExecutor)
```
    Sets the IoExecutor to be used by this server.
    
    Parameters:
    
    ioExecutor - IoExecutor to use.
    
    Returns:
    
    this.
  - executor
```
public HttpServerBuilder executor(Executor executor)
```
    Sets the Executor to use.
    
    Parameters:
    
    executor - Executor to use.
    
    Returns:
    
    this.
  - bufferAllocator
```
public abstract HttpServerBuilder bufferAllocator(BufferAllocator allocator)
```
    Sets the BufferAllocator to be used by this server.
    
    Parameters:
    
    allocator - BufferAllocator to use.
    
    Returns:
    
    this.
  - executionStrategy
```
public HttpServerBuilder executionStrategy(HttpExecutionStrategy strategy)
```
    Sets the HttpExecutionStrategy to be used by this server.
    
    Parameters:
    
    strategy - HttpExecutionStrategy to use by this server.
    
    Returns:
    
    this.
  - listenAndAwait
```
public ServerContext listenAndAwait(HttpService service)
                             throws Exception
```
    Starts this server and returns the ServerContext after the server has been successfully started.
    If the underlying protocol (eg. TCP) supports it this will result in a socket bind/listen on address.
    
    Parameters:
    
    service - Service invoked for every request received by this server. The returned ServerContext manages the lifecycle of the service, ensuring it is closed when the ServerContext is closed.
    
    Returns:
    
    A ServerContext by blocking the calling thread until the server is successfully started or throws an Exception if the server could not be started.
    
    Throws:
    
    Exception - if the server could not be started.
  - listenStreamingAndAwait
```
public ServerContext listenStreamingAndAwait(StreamingHttpService handler)
                                      throws Exception
```
    Starts this server and returns the ServerContext after the server has been successfully started.
    If the underlying protocol (eg. TCP) supports it this will result in a socket bind/listen on address.
    
    Parameters:
    
    handler - Service invoked for every request received by this server. The returned ServerContext manages the lifecycle of the service, ensuring it is closed when the ServerContext is closed.
    
    Returns:
    
    A ServerContext by blocking the calling thread until the server is successfully started or throws an Exception if the server could not be started.
    
    Throws:
    
    Exception - if the server could not be started.
  - listenBlockingAndAwait
```
public ServerContext listenBlockingAndAwait(BlockingHttpService service)
                                     throws Exception
```
    Starts this server and returns the ServerContext after the server has been successfully started.
    If the underlying protocol (eg. TCP) supports it this will result in a socket bind/listen on address.
    
    Parameters:
    
    service - Service invoked for every request received by this server. The returned ServerContext manages the lifecycle of the service, ensuring it is closed when the ServerContext is closed.
    
    Returns:
    
    A ServerContext by blocking the calling thread until the server is successfully started or throws an Exception if the server could not be started.
    
    Throws:
    
    Exception - if the server could not be started.
  - listenBlockingStreamingAndAwait
```
public ServerContext listenBlockingStreamingAndAwait(BlockingStreamingHttpService handler)
                                              throws Exception
```
    Starts this server and returns the ServerContext after the server has been successfully started.
    If the underlying protocol (eg. TCP) supports it this will result in a socket bind/listen on address.
    
    Parameters:
    
    handler - Service invoked for every request received by this server. The returned ServerContext manages the lifecycle of the service, ensuring it is closed when the ServerContext is closed.
    
    Returns:
    
    A ServerContext by blocking the calling thread until the server is successfully started or throws an Exception if the server could not be started.
    
    Throws:
    
    Exception - if the server could not be started.
  - listen
```
public Single<ServerContext> listen(HttpService service)
```
    Starts this server and returns the ServerContext after the server has been successfully started.
    If the underlying protocol (eg. TCP) supports it this will result in a socket bind/listen on address.
    
    Parameters:
    
    service - Service invoked for every request received by this server. The returned ServerContext manages the lifecycle of the service, ensuring it is closed when the ServerContext is closed.
    
    Returns:
    
    A Single that completes when the server is successfully started or terminates with an error if the server could not be started.
  - listenStreaming
```
public Single<ServerContext> listenStreaming(StreamingHttpService service)
```
    Starts this server and returns the ServerContext after the server has been successfully started.
    If the underlying protocol (eg. TCP) supports it this will result in a socket bind/listen on address.
    
    Parameters:
    
    service - Service invoked for every request received by this server. The returned ServerContext manages the lifecycle of the service, ensuring it is closed when the ServerContext is closed.
    
    Returns:
    
    A Single that completes when the server is successfully started or terminates with an error if the server could not be started.
  - listenBlocking
```
public Single<ServerContext> listenBlocking(BlockingHttpService service)
```
    Starts this server and returns the ServerContext after the server has been successfully started.
    If the underlying protocol (eg. TCP) supports it this will result in a socket bind/listen on address.
    
    Parameters:
    
    service - Service invoked for every request received by this server. The returned ServerContext manages the lifecycle of the service, ensuring it is closed when the ServerContext is closed.
    
    Returns:
    
    A Single that completes when the server is successfully started or terminates with an error if the server could not be started.
  - listenBlockingStreaming
```
public Single<ServerContext> listenBlockingStreaming(BlockingStreamingHttpService service)
```
    Starts this server and returns the ServerContext after the server has been successfully started.
    If the underlying protocol (eg. TCP) supports it this will result in a socket bind/listen on address.
    
    Parameters:
    
    service - Service invoked for every request received by this server. The returned ServerContext manages the lifecycle of the service, ensuring it is closed when the ServerContext is closed.
    
    Returns:
    
    A Single that completes when the server is successfully started or terminates with an error if the server could not be started.
  - doListen
```
@Deprecated
protected abstract Single<ServerContext> doListen(@Nullable
                                                              ConnectionAcceptor connectionAcceptor,
                                                              StreamingHttpService service,
                                                              HttpExecutionStrategy strategy,
                                                              boolean drainRequestPayloadBody)
```
    Deprecated. This method will be removed. If you depend upon it consider copying the implementation from DefaultHttpServerBuilder#doListen(ConnectionAcceptor, StreamingHttpService, HttpExecutionStrategy, boolean)
    
    Starts this server and returns the ServerContext after the server has been successfully started.
    If the underlying protocol (eg. TCP) supports it this should result in a socket bind/listen on address.
    
    Parameters:
    
    connectionAcceptor - ConnectionAcceptor to use for the server.
    
    service - StreamingHttpService to use for the server.
    
    strategy - the HttpExecutionStrategy to use for the service.
    
    drainRequestPayloadBody - if true the server implementation should automatically subscribe and ignore the payload body of incoming requests.
    
    Returns:
    
    A Single that completes when the server is successfully started or terminates with an error if the server could not be started.

Class HttpServerBuilder

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

HttpServerBuilder

Method Detail

protocols

backlog

secure

sslConfig

sslConfig

socketOption

listenSocketOption

enableWireLogging

enableWireLogging

transportObserver

lifecycleObserver

disableDrainingRequestPayloadBody

drainRequestPayloadBody

allowDropRequestTrailers

appendConnectionAcceptorFilter

appendServiceFilter

appendServiceFilter

ioExecutor

executor

bufferAllocator

executionStrategy

listenAndAwait

listenStreamingAndAwait

listenBlockingAndAwait

listenBlockingStreamingAndAwait

listen

listenStreaming

listenBlocking

listenBlockingStreaming

doListen