Package io.servicetalk.http.api

Class DelegatingHttpServerBuilder

java.lang.Object

io.servicetalk.http.api.DelegatingHttpServerBuilder

All Implemented Interfaces:

HttpServerBuilder

public class DelegatingHttpServerBuilder
extends Object
implements HttpServerBuilder

A HttpServerBuilder that delegates all methods to another HttpServerBuilder.

Constructor Summary

Constructors

Constructor	Description
DelegatingHttpServerBuilder(HttpServerBuilder delegate)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
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	appendEarlyConnectionAcceptor(EarlyConnectionAcceptor factory)	Appends the EarlyConnectionAcceptor to be called when a new connection has been created.
HttpServerBuilder	appendLateConnectionAcceptor(LateConnectionAcceptor factory)	Appends the LateConnectionAcceptor to be called when a new connection has been created.
HttpServerBuilder	appendNonOffloadingServiceFilter(StreamingHttpServiceFilterFactory factory)	Appends a non-offloading filter to the chain of filters used to decorate the StreamingHttpService used by this builder.
HttpServerBuilder	appendNonOffloadingServiceFilter(Predicate<StreamingHttpRequest> predicate, StreamingHttpServiceFilterFactory factory)	Appends a non-offloading 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	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	bufferAllocator(BufferAllocator allocator)	Sets the BufferAllocator to be used by this server.
protected final HttpServerBuilder	delegate()	Returns the HttpServerBuilder delegate.
HttpServerBuilder	drainRequestPayloadBody(boolean enable)	Configure automatic consumption of request payload body when it is not consumed by the service.
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 be used by this server.
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<HttpServerContext>	listen(HttpService service)	Starts this server and returns the HttpServerContext after the server has been successfully started.
HttpServerContext	listenAndAwait(HttpService service)	Starts this server and returns the HttpServerContext after the server has been successfully started.
Single<HttpServerContext>	listenBlocking(BlockingHttpService service)	Starts this server and returns the HttpServerContext after the server has been successfully started.
HttpServerContext	listenBlockingAndAwait(BlockingHttpService service)	Starts this server and returns the HttpServerContext after the server has been successfully started.
Single<HttpServerContext>	listenBlockingStreaming(BlockingStreamingHttpService service)	Starts this server and returns the HttpServerContext after the server has been successfully started.
HttpServerContext	listenBlockingStreamingAndAwait(BlockingStreamingHttpService service)	Starts this server and returns the HttpServerContext after the server has been successfully started.
Single<HttpServerContext>	listenService(HttpServiceBase service)	Starts this server and returns the HttpServerContext after the server has been successfully started.
HttpServerContext	listenServiceAndAwait(HttpServiceBase service)	Starts this server and returns the HttpServerContext after the server has been successfully started.
<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<HttpServerContext>	listenStreaming(StreamingHttpService service)	Starts this server and returns the HttpServerContext after the server has been successfully started.
HttpServerContext	listenStreamingAndAwait(StreamingHttpService service)	Starts this server and returns the HttpServerContext after the server has been successfully started.
HttpServerBuilder	protocols(HttpProtocolConfig... protocols)	Configurations of various HTTP protocol versions.
<T> HttpServerBuilder	socketOption(SocketOption<T> option, T value)	Adds a SocketOption that is applied to connected/accepted socket channels.
HttpServerBuilder	sslConfig(ServerSslConfig config)	Set the SSL/TLS configuration.
HttpServerBuilder	sslConfig(ServerSslConfig config, boolean acceptInsecureConnections)	Set the SSL/TLS configuration and allows to specify if insecure connections should also be allowed.
HttpServerBuilder	sslConfig(ServerSslConfig defaultConfig, Map<String,ServerSslConfig> sniMap)	Set the SSL/TLS and SNI configuration.
HttpServerBuilder	sslConfig(ServerSslConfig defaultConfig, Map<String,ServerSslConfig> sniMap, int maxClientHelloLength, Duration clientHelloTimeout)	Set the SSL/TLS and SNI configuration.
String	toString()
HttpServerBuilder	transportConfig(TransportConfig transportConfig)	Set the transport configuration.
HttpServerBuilder	transportObserver(TransportObserver transportObserver)	Sets a TransportObserver that provides visibility into transport events.

Methods inherited from class java.lang.Object

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

Constructor Details

DelegatingHttpServerBuilder

public DelegatingHttpServerBuilder(HttpServerBuilder delegate)

Create a new instance.

Parameters:

delegate - HttpServerBuilder to which all methods are delegated.

Method Details

delegate

protected final HttpServerBuilder delegate()

Returns the HttpServerBuilder delegate.

Returns:

Delegate HttpServerBuilder.

toString

public String toString()

Overrides:

toString in class Object

protocols

public HttpServerBuilder protocols(HttpProtocolConfig... protocols)

Description copied from interface: HttpServerBuilder

Configurations of various HTTP protocol versions.

Note: the order of specified protocols will reflect on priorities for ALPN in case the connections use HttpServerBuilder.sslConfig(ServerSslConfig).

Specified by:

protocols in interface HttpServerBuilder

Parameters:

protocols - HttpProtocolConfig for each protocol that should be supported.

Returns:

this.

sslConfig

public HttpServerBuilder sslConfig(ServerSslConfig config)

Description copied from interface: HttpServerBuilder

Set the SSL/TLS configuration.

Specified by:

sslConfig in interface HttpServerBuilder

Parameters:

config - The configuration to use.

Returns:

this.

sslConfig

public HttpServerBuilder sslConfig(ServerSslConfig defaultConfig,
 Map<String,ServerSslConfig> sniMap)

Description copied from interface: HttpServerBuilder

Set the SSL/TLS and SNI configuration.

Specified by:

sslConfig in interface HttpServerBuilder

Parameters:

defaultConfig - The configuration to use if 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.

sslConfig

public HttpServerBuilder sslConfig(ServerSslConfig defaultConfig,
 Map<String,ServerSslConfig> sniMap,
 int maxClientHelloLength,
 Duration clientHelloTimeout)

Description copied from interface: HttpServerBuilder

Set the SSL/TLS and SNI configuration.

Specified by:

sslConfig in interface HttpServerBuilder

Parameters:

defaultConfig - The configuration to use if 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.

maxClientHelloLength - The maximum length of a ClientHello message in bytes, up to 2^24 - 1 bytes. Zero (0) disables validation.

clientHelloTimeout - The timeout for waiting until ClientHello message is received. Implementations can round the specified Duration to full time units, depending on their time granularity. Zero (0) disables timeout.

Returns:

this.

sslConfig

public HttpServerBuilder sslConfig(ServerSslConfig config,
 boolean acceptInsecureConnections)

Description copied from interface: HttpServerBuilder

Set the SSL/TLS configuration and allows to specify if insecure connections should also be allowed.

Specified by:

sslConfig in interface HttpServerBuilder

Parameters:

config - The configuration to use.

acceptInsecureConnections - if non-TLS connections are accepted on the same socket.

Returns:

this.

transportConfig

public HttpServerBuilder transportConfig(TransportConfig transportConfig)

Description copied from interface: HttpServerBuilder

Set the transport configuration.

Specified by:

transportConfig in interface HttpServerBuilder

Parameters:

transportConfig - TransportConfig to use.

Returns:

this.

See Also:

• TransportConfigBuilder

socketOption

public <T> HttpServerBuilder socketOption(SocketOption<T> option,
 T value)

Description copied from interface: HttpServerBuilder

Adds a SocketOption that is applied to connected/accepted socket channels.

Specified by:

socketOption in interface HttpServerBuilder

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 <T> HttpServerBuilder listenSocketOption(SocketOption<T> option,
 T value)

Description copied from interface: HttpServerBuilder

Adds a SocketOption that is applied to the server socket channel which listens/accepts socket channels.

Specified by:

listenSocketOption in interface HttpServerBuilder

Type Parameters:

T - the type of the value.

Parameters:

option - the option to apply.

value - the value.

Returns:

this.

See Also:

• StandardSocketOptions
• ServiceTalkSocketOptions

enableWireLogging

public HttpServerBuilder enableWireLogging(String loggerName,
 LogLevel logLevel,
 BooleanSupplier logUserData)

Description copied from interface: HttpServerBuilder

Enables wire-logging for this server.

Specified by:

enableWireLogging in interface HttpServerBuilder

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. This method is invoked for each data object allowing for dynamic behavior.

Returns:

this.

transportObserver

public HttpServerBuilder transportObserver(TransportObserver transportObserver)

Description copied from interface: HttpServerBuilder

Sets a TransportObserver that provides visibility into transport events.

Specified by:

transportObserver in interface HttpServerBuilder

Parameters:

transportObserver - A TransportObserver that provides visibility into transport events.

Returns:

this.

lifecycleObserver

public HttpServerBuilder lifecycleObserver(HttpLifecycleObserver lifecycleObserver)

Description copied from interface: HttpServerBuilder

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.

Specified by:

lifecycleObserver in interface HttpServerBuilder

Parameters:

lifecycleObserver - A HttpLifecycleObserver that provides visibility into HTTP lifecycle events.

Returns:

this.

drainRequestPayloadBody

public HttpServerBuilder drainRequestPayloadBody(boolean enable)

Description copied from interface: HttpServerBuilder

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.

Specified by:

drainRequestPayloadBody in interface HttpServerBuilder

Parameters:

enable - When false it will disable the automatic consumption of request StreamingHttpRequest.payloadBody().

Returns:

this.

allowDropRequestTrailers

public HttpServerBuilder allowDropRequestTrailers(boolean allowDrop)

Description copied from interface: HttpServerBuilder

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.

Specified by:

allowDropRequestTrailers in interface HttpServerBuilder

Parameters:

allowDrop - true if request trailers are allowed to be dropped.

Returns:

this

appendConnectionAcceptorFilter

public HttpServerBuilder appendConnectionAcceptorFilter(ConnectionAcceptorFactory factory)

Description copied from interface: HttpServerBuilder

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
 

The connection acceptor will, by default, not be offloaded. If your filter requires the ConnectionAcceptor.accept(ConnectionContext) to be offloaded then your ConnectionAcceptorFactory will need to return ConnectExecutionStrategy.offloadAll() from the ExecutionStrategyInfluencer.requiredOffloads().

Specified by:

appendConnectionAcceptorFilter in interface HttpServerBuilder

Parameters:

factory - ConnectionAcceptorFactory to append. Lifetime of this ConnectionAcceptorFactory is managed by this builder and the server started thereof.

Returns:

this

appendEarlyConnectionAcceptor

public HttpServerBuilder appendEarlyConnectionAcceptor(EarlyConnectionAcceptor factory)

Description copied from interface: HttpServerBuilder

Appends the EarlyConnectionAcceptor to be called when a new connection has been created.

The difference between the EarlyConnectionAcceptor and the LateConnectionAcceptor is that the early one is called right after the connection has been accepted - and most importantly - before any TLS handshake has been performed. This allows to terminate connections quickly and spend less CPU resources if the amount of information provided to make such a decision is sufficient.

The order of execution of these acceptors are in order of append. If 3 acceptors are added as follows:

     builder
          .appendEarlyConnectionAcceptor(acceptor1)
          .appendEarlyConnectionAcceptor(acceptor2)
          .appendEarlyConnectionAcceptor(acceptor3)
 

the order of invocation of these filters will be:

     acceptor1 ⇒ acceptor2 ⇒ acceptor3
 

The acceptor is offloaded by default. If an acceptor in the chain fails the Completable, the later ones will not be called.

Specified by:

appendEarlyConnectionAcceptor in interface HttpServerBuilder

Parameters:

factory - the acceptor to append to the chain of acceptors.

Returns:

this HttpServerBuilder for chaining purposes.

See Also:

• HttpServerBuilder.appendLateConnectionAcceptor(LateConnectionAcceptor)

appendLateConnectionAcceptor

public HttpServerBuilder appendLateConnectionAcceptor(LateConnectionAcceptor factory)

Description copied from interface: HttpServerBuilder

Appends the LateConnectionAcceptor to be called when a new connection has been created.

The LateConnectionAcceptor (compared to the EarlyConnectionAcceptor) gets called later in the connection establishment process. Instead of being invoked right after the connection has been accepted, this acceptor gets called after the connection is fully initialized, the TLS handshake has been completed and as a result has more contextual information available in the ConnectionInfo.

The order of execution of these acceptors are in order of append. If 3 acceptors are added as follows:

     builder
          .appendLateConnectionAcceptor(acceptor1)
          .appendLateConnectionAcceptor(acceptor2)
          .appendLateConnectionAcceptor(acceptor3)
 

the order of invocation of these filters will be:

     acceptor1 ⇒ acceptor2 ⇒ acceptor3
 

The acceptor is offloaded by default. If an acceptor in the chain fails the Completable, the later ones will not be called.

Specified by:

appendLateConnectionAcceptor in interface HttpServerBuilder

Parameters:

factory - the acceptor to append to the chain of acceptors.

Returns:

this HttpServerBuilder for chaining purposes.

See Also:

• HttpServerBuilder.appendEarlyConnectionAcceptor(EarlyConnectionAcceptor)

appendNonOffloadingServiceFilter

public HttpServerBuilder appendNonOffloadingServiceFilter(StreamingHttpServiceFilterFactory factory)

Description copied from interface: HttpServerBuilder

Appends a non-offloading 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 HttpServerBuilder.listenStreaming(StreamingHttpService) before it is used by the server.

The order of execution of these filters are in order of append, before the filters added with HttpServerBuilder.appendServiceFilter(StreamingHttpServiceFilterFactory). If 3 filters are added as follows:

     builder
         .appendServiceFilter(filter1)
         .appendNonOffloadingServiceFilter(filter2)
         .appendServiceFilter(filter3)
 

accepting a request by a service wrapped by this filter chain, the order of invocation of these filters will be:

     filter2 ⇒ [offloading] ⇒ filter1 ⇒ filter3 ⇒ service
 

Specified by:

appendNonOffloadingServiceFilter in interface HttpServerBuilder

Parameters:

factory - StreamingHttpServiceFilterFactory to append.

Returns:

this

appendNonOffloadingServiceFilter

public HttpServerBuilder appendNonOffloadingServiceFilter(Predicate<StreamingHttpRequest> predicate,
 StreamingHttpServiceFilterFactory factory)

Description copied from interface: HttpServerBuilder

Appends a non-offloading filter to the chain of filters used to decorate the StreamingHttpService used by this builder, for every request that passes the provided Predicate. Filters added via this method will be executed before offloading occurs and before filters appended via HttpServerBuilder.appendServiceFilter(StreamingHttpServiceFilterFactory).

Note this method will be used to decorate the StreamingHttpService passed to HttpServerBuilder.listenStreaming(StreamingHttpService) before it is used by the server. The order of execution of these filters are in order of append, before the filters added with HttpServerBuilder.appendServiceFilter(StreamingHttpServiceFilterFactory). If 3 filters are added as follows:

     builder
         .appendServiceFilter(filter1)
         .appendNonOffloadingServiceFilter(filter2)
         .appendServiceFilter(filter3)
 

accepting a request by a service wrapped by this filter chain, the order of invocation of these filters will be:

     filter2 ⇒ [offloading] ⇒ filter1 ⇒ filter3 ⇒ service
 

Specified by:

appendNonOffloadingServiceFilter in interface HttpServerBuilder

Parameters:

predicate - the Predicate to test if the filter must be applied. This must not block.

factory - StreamingHttpServiceFilterFactory to append.

Returns:

this

appendServiceFilter

public HttpServerBuilder appendServiceFilter(StreamingHttpServiceFilterFactory factory)

Description copied from interface: HttpServerBuilder

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 HttpServerBuilder.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.appendServiceFilter(filter1).appendServiceFilter(filter2).appendServiceFilter(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
 

Specified by:

appendServiceFilter in interface HttpServerBuilder

Parameters:

factory - StreamingHttpServiceFilterFactory to append.

Returns:

this

appendServiceFilter

public HttpServerBuilder appendServiceFilter(Predicate<StreamingHttpRequest> predicate,
 StreamingHttpServiceFilterFactory factory)

Description copied from interface: HttpServerBuilder

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 HttpServerBuilder.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.appendServiceFilter(filter1).appendServiceFilter(filter2).appendServiceFilter(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
 

Specified by:

appendServiceFilter in interface HttpServerBuilder

Parameters:

predicate - the Predicate to test if the filter must be applied. This must not block.

factory - StreamingHttpServiceFilterFactory to append.

Returns:

this

ioExecutor

public HttpServerBuilder ioExecutor(IoExecutor ioExecutor)

Description copied from interface: HttpServerBuilder

Sets the IoExecutor to be used by this server.

Specified by:

ioExecutor in interface HttpServerBuilder

Parameters:

ioExecutor - IoExecutor to use.

Returns:

this.

executor

public HttpServerBuilder executor(Executor executor)

Description copied from interface: HttpServerBuilder

Sets the Executor to be used by this server.

Specified by:

executor in interface HttpServerBuilder

Parameters:

executor - Executor to use.

Returns:

this.

bufferAllocator

public HttpServerBuilder bufferAllocator(BufferAllocator allocator)

Description copied from interface: HttpServerBuilder

Sets the BufferAllocator to be used by this server.

Specified by:

bufferAllocator in interface HttpServerBuilder

Parameters:

allocator - BufferAllocator to use.

Returns:

this.

executionStrategy

public HttpServerBuilder executionStrategy(HttpExecutionStrategy strategy)

Description copied from interface: HttpServerBuilder

Sets the HttpExecutionStrategy to be used by this server.

Specified by:

executionStrategy in interface HttpServerBuilder

Parameters:

strategy - HttpExecutionStrategy to use by this server.

Returns:

this.

listenService

public Single<HttpServerContext> listenService(HttpServiceBase service)

Description copied from interface: HttpServerBuilder

Starts this server and returns the HttpServerContext after the server has been successfully started.

If the underlying protocol (e.g. TCP) supports it this will result in a socket bind/listen on address.

Note that this method is generic in the sense that it accepts all HTTP HttpServiceBase implementations to be passed in, namely StreamingHttpService, HttpService, BlockingStreamingHttpService and BlockingHttpService. It is especially useful when Dependency Injection is used and the type of service is not known at compile time.

Specified by:

listenService in interface HttpServerBuilder

Parameters:

service - Service invoked for every request received by this server. The returned HttpServerContext manages the lifecycle of the service, ensuring it is closed when the HttpServerContext 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.

listen

public Single<HttpServerContext> listen(HttpService service)

Description copied from interface: HttpServerBuilder

Starts this server and returns the HttpServerContext after the server has been successfully started.

If the underlying protocol (e.g. TCP) supports it this will result in a socket bind/listen on address.

Specified by:

listen in interface HttpServerBuilder

Parameters:

service - Service invoked for every request received by this server. The returned HttpServerContext manages the lifecycle of the service, ensuring it is closed when the HttpServerContext 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<HttpServerContext> listenStreaming(StreamingHttpService service)

Description copied from interface: HttpServerBuilder

Starts this server and returns the HttpServerContext after the server has been successfully started.

If the underlying protocol (e.g. TCP) supports it this will result in a socket bind/listen on address.

Specified by:

listenStreaming in interface HttpServerBuilder

Parameters:

service - Service invoked for every request received by this server. The returned HttpServerContext manages the lifecycle of the service, ensuring it is closed when the HttpServerContext 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<HttpServerContext> listenBlocking(BlockingHttpService service)

Description copied from interface: HttpServerBuilder

Starts this server and returns the HttpServerContext after the server has been successfully started.

If the underlying protocol (e.g. TCP) supports it this will result in a socket bind/listen on address.

Specified by:

listenBlocking in interface HttpServerBuilder

Parameters:

service - Service invoked for every request received by this server. The returned HttpServerContext manages the lifecycle of the service, ensuring it is closed when the HttpServerContext 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<HttpServerContext> listenBlockingStreaming(BlockingStreamingHttpService service)

Description copied from interface: HttpServerBuilder

Starts this server and returns the HttpServerContext after the server has been successfully started.

If the underlying protocol (e.g. TCP) supports it this will result in a socket bind/listen on address.

Specified by:

listenBlockingStreaming in interface HttpServerBuilder

Parameters:

service - Service invoked for every request received by this server. The returned HttpServerContext manages the lifecycle of the service, ensuring it is closed when the HttpServerContext 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.

listenServiceAndAwait

public HttpServerContext listenServiceAndAwait(HttpServiceBase service)
                                        throws Exception

Description copied from interface: HttpServerBuilder

Starts this server and returns the HttpServerContext after the server has been successfully started.

If the underlying protocol (e.g. TCP) supports it this will result in a socket bind/listen on address.

Note that this method is generic in the sense that it accepts all HTTP HttpServiceBase implementations to be passed in, namely StreamingHttpService, HttpService, BlockingStreamingHttpService and BlockingHttpService. It is especially useful when Dependency Injection is used and the type of service is not known at compile time.

Specified by:

listenServiceAndAwait in interface HttpServerBuilder

Parameters:

service - Service invoked for every request received by this server. The returned HttpServerContext manages the lifecycle of the service, ensuring it is closed when the HttpServerContext is closed.

Returns:

A HttpServerContext by blocking the calling thread until the server is successfully started or throws an Exception if the server could not be started.

Throws:

IllegalArgumentException - if an unsupported HttpServiceBase type is being provided.

Exception - if the server could not be started.

listenAndAwait

public HttpServerContext listenAndAwait(HttpService service)
                                 throws Exception

Description copied from interface: HttpServerBuilder

Starts this server and returns the HttpServerContext after the server has been successfully started.

If the underlying protocol (e.g. TCP) supports it this will result in a socket bind/listen on address.

Specified by:

listenAndAwait in interface HttpServerBuilder

Parameters:

service - Service invoked for every request received by this server. The returned HttpServerContext manages the lifecycle of the service, ensuring it is closed when the HttpServerContext is closed.

Returns:

A HttpServerContext 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 HttpServerContext listenStreamingAndAwait(StreamingHttpService service)
                                          throws Exception

Description copied from interface: HttpServerBuilder

Starts this server and returns the HttpServerContext after the server has been successfully started.

If the underlying protocol (e.g. TCP) supports it this will result in a socket bind/listen on address.

Specified by:

listenStreamingAndAwait in interface HttpServerBuilder

Parameters:

service - Service invoked for every request received by this server. The returned HttpServerContext manages the lifecycle of the service, ensuring it is closed when the HttpServerContext is closed.

Returns:

A HttpServerContext 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 HttpServerContext listenBlockingAndAwait(BlockingHttpService service)
                                         throws Exception

Description copied from interface: HttpServerBuilder

Starts this server and returns the HttpServerContext after the server has been successfully started.

If the underlying protocol (e.g. TCP) supports it this will result in a socket bind/listen on address.

Specified by:

listenBlockingAndAwait in interface HttpServerBuilder

Parameters:

service - Service invoked for every request received by this server. The returned HttpServerContext manages the lifecycle of the service, ensuring it is closed when the HttpServerContext is closed.

Returns:

A HttpServerContext 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 HttpServerContext listenBlockingStreamingAndAwait(BlockingStreamingHttpService service)
                                                  throws Exception

Description copied from interface: HttpServerBuilder

Starts this server and returns the HttpServerContext after the server has been successfully started.

If the underlying protocol (e.g. TCP) supports it this will result in a socket bind/listen on address.

Specified by:

listenBlockingStreamingAndAwait in interface HttpServerBuilder

Parameters:

service - Service invoked for every request received by this server. The returned HttpServerContext manages the lifecycle of the service, ensuring it is closed when the HttpServerContext is closed.

Returns:

A HttpServerContext 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.