io.servicetalk.http.api

Class DelegatingSingleAddressHttpClientBuilder<U,R>

Object

DelegatingSingleAddressHttpClientBuilder<U,R>

Type Parameters:

U - the type of address before resolution (unresolved address)

R - the type of address after resolution (resolved address)

All Implemented Interfaces:

SingleAddressHttpClientBuilder<U,R>

public class DelegatingSingleAddressHttpClientBuilder<U,R>
extends Object
implements SingleAddressHttpClientBuilder<U,R>

A SingleAddressHttpClientBuilder that delegates all methods to another SingleAddressHttpClientBuilder.

Constructor Summary

Constructors

Constructor and Description
DelegatingSingleAddressHttpClientBuilder(SingleAddressHttpClientBuilder<U,R> delegate) Create a new instance.

Method Summary

Modifier and Type	Method and Description
SingleAddressHttpClientBuilder<U,R>	allowDropResponseTrailers(boolean allowDrop) Provide a hint if response trailers are allowed to be dropped.
SingleAddressHttpClientBuilder<U,R>	appendClientFilter(Predicate<StreamingHttpRequest> predicate, StreamingHttpClientFilterFactory factory) Appends the filter to the chain of filters used to decorate the HttpClient created by this builder, for every request that passes the provided Predicate.
SingleAddressHttpClientBuilder<U,R>	appendClientFilter(StreamingHttpClientFilterFactory factory) Appends the filter to the chain of filters used to decorate the HttpClient created by this builder.
SingleAddressHttpClientBuilder<U,R>	appendConnectionFactoryFilter(ConnectionFactoryFilter<R,FilterableStreamingHttpConnection> factory) Appends the filter to the chain of filters used to decorate the ConnectionFactory used by this builder.
SingleAddressHttpClientBuilder<U,R>	appendConnectionFilter(Predicate<StreamingHttpRequest> predicate, StreamingHttpConnectionFilterFactory factory) Appends the filter to the chain of filters used to decorate the StreamingHttpConnection created by this builder, for every request that passes the provided Predicate.
SingleAddressHttpClientBuilder<U,R>	appendConnectionFilter(StreamingHttpConnectionFilterFactory factory) Appends the filter to the chain of filters used to decorate the StreamingHttpConnection created by this builder.
SingleAddressHttpClientBuilder<U,R>	bufferAllocator(BufferAllocator allocator) Sets the BufferAllocator for all clients created from this builder.
HttpClient	build() Builds a new HttpClient.
BlockingHttpClient	buildBlocking() Creates a new BlockingHttpClient.
BlockingStreamingHttpClient	buildBlockingStreaming() Creates a new BlockingStreamingHttpClient.
StreamingHttpClient	buildStreaming() Builds a new StreamingHttpClient.
protected SingleAddressHttpClientBuilder<U,R>	delegate() Returns the SingleAddressHttpClientBuilder delegate.
SingleAddressHttpClientBuilder<U,R>	enableWireLogging(String loggerName, LogLevel logLevel, BooleanSupplier logUserData) Enables wire-logging for connections created by this builder.
SingleAddressHttpClientBuilder<U,R>	executionStrategy(HttpExecutionStrategy strategy) Sets the HttpExecutionStrategy to be used for client callbacks when executing client requests for all clients created from this builder.
SingleAddressHttpClientBuilder<U,R>	executor(Executor executor) Sets the Executor for all clients created from this builder.
SingleAddressHttpClientBuilder<U,R>	hostHeaderFallback(boolean enable) Configures automatically setting Host headers by inferring from the address.
SingleAddressHttpClientBuilder<U,R>	inferPeerHost(boolean shouldInfer) Toggle inference of value to use instead of ClientSslConfig.peerHost() from client's address when peer host is not specified.
SingleAddressHttpClientBuilder<U,R>	inferPeerPort(boolean shouldInfer) Toggle inference of value to use instead of ClientSslConfig.peerPort() from client's address when peer port is not specified (equals -1).
SingleAddressHttpClientBuilder<U,R>	inferSniHostname(boolean shouldInfer) Toggle SNI hostname inference from client's address if not explicitly specified via SingleAddressHttpClientBuilder.sslConfig(ClientSslConfig).
SingleAddressHttpClientBuilder<U,R>	ioExecutor(IoExecutor ioExecutor) Sets the IoExecutor for all clients created from this builder.
SingleAddressHttpClientBuilder<U,R>	loadBalancerFactory(HttpLoadBalancerFactory<R> loadBalancerFactory) Sets a HttpLoadBalancerFactory to create LoadBalancer instances.
SingleAddressHttpClientBuilder<U,R>	protocols(HttpProtocolConfig... protocols) Configurations of various HTTP protocol versions.
SingleAddressHttpClientBuilder<U,R>	proxyAddress(U proxyAddress) Configure proxy to serve as an intermediary for requests.
SingleAddressHttpClientBuilder<U,R>	retryServiceDiscoveryErrors(BiIntFunction<Throwable,? extends Completable> retryStrategy) Sets a retry strategy to retry errors emitted by ServiceDiscoverer.
SingleAddressHttpClientBuilder<U,R>	serviceDiscoverer(ServiceDiscoverer<U,R,? extends ServiceDiscovererEvent<R>> serviceDiscoverer) Sets a ServiceDiscoverer to resolve addresses of remote servers to connect to.
<T> SingleAddressHttpClientBuilder<U,R>	socketOption(SocketOption<T> option, T value) Adds a SocketOption for all connections created by this builder.
SingleAddressHttpClientBuilder<U,R>	sslConfig(ClientSslConfig sslConfig) Set the SSL/TLS configuration.
String	toString()
SingleAddressHttpClientBuilder<U,R>	unresolvedAddressToHost(Function<U,CharSequence> unresolvedAddressToHostFunction) Provides a means to convert U unresolved address type into a CharSequence.

Methods inherited from class Object

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

Constructor Detail

DelegatingSingleAddressHttpClientBuilder

public DelegatingSingleAddressHttpClientBuilder(SingleAddressHttpClientBuilder<U,R> delegate)

Create a new instance.

Parameters:

delegate - SingleAddressHttpClientBuilder to which all methods are delegated.

Method Detail

delegate

protected final SingleAddressHttpClientBuilder<U,R> delegate()

Returns the SingleAddressHttpClientBuilder delegate.

Returns:

Delegate SingleAddressHttpClientBuilder.

toString

public String toString()

Overrides:

toString in class Object

proxyAddress

public SingleAddressHttpClientBuilder<U,R> proxyAddress(U proxyAddress)

Description copied from interface: SingleAddressHttpClientBuilder

Configure proxy to serve as an intermediary for requests.

Specified by:

proxyAddress in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

proxyAddress - Unresolved address of the proxy. When used with a builder created for a resolved address, proxyAddress should also be already resolved – otherwise runtime exceptions may occur.

Returns:

this.

socketOption

public <T> SingleAddressHttpClientBuilder<U,R> socketOption(SocketOption<T> option,
                                                            T value)

Description copied from interface: SingleAddressHttpClientBuilder

Adds a SocketOption for all connections created by this builder.

Specified by:

socketOption in interface SingleAddressHttpClientBuilder<U,R>

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 SingleAddressHttpClientBuilder<U,R> enableWireLogging(String loggerName,
                                                             LogLevel logLevel,
                                                             BooleanSupplier logUserData)

Description copied from interface: SingleAddressHttpClientBuilder

Enables wire-logging for connections created by this builder.

Specified by:

enableWireLogging in interface SingleAddressHttpClientBuilder<U,R>

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.

protocols

public SingleAddressHttpClientBuilder<U,R> protocols(HttpProtocolConfig... protocols)

Description copied from interface: SingleAddressHttpClientBuilder

Configurations of various HTTP protocol versions.

Note: the order of specified protocols will reflect on priorities for ALPN in case the connections use TLS.

Specified by:

protocols in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

protocols - HttpProtocolConfig for each protocol that should be supported.

Returns:

this.

hostHeaderFallback

public SingleAddressHttpClientBuilder<U,R> hostHeaderFallback(boolean enable)

Description copied from interface: SingleAddressHttpClientBuilder

Configures automatically setting Host headers by inferring from the address.

When false is passed, this setting disables the default filter such that no Host header will be manipulated.

Specified by:

hostHeaderFallback in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

enable - Whether a default filter for inferring the Host headers should be added.

Returns:

this

See Also:

SingleAddressHttpClientBuilder.unresolvedAddressToHost(Function)

allowDropResponseTrailers

public SingleAddressHttpClientBuilder<U,R> allowDropResponseTrailers(boolean allowDrop)

Description copied from interface: SingleAddressHttpClientBuilder

Provide a hint if response trailers are allowed to be dropped. This hint maybe ignored if the transport can otherwise infer that trailers should be preserved. For example, if the response headers contain Trailer then this hint maybe ignored.

Specified by:

allowDropResponseTrailers in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

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

Returns:

this

appendConnectionFilter

public SingleAddressHttpClientBuilder<U,R> appendConnectionFilter(StreamingHttpConnectionFilterFactory factory)

Description copied from interface: SingleAddressHttpClientBuilder

Appends the filter to the chain of filters used to decorate the StreamingHttpConnection created by this builder.

Filtering allows you to wrap a StreamingHttpConnection and modify behavior during request/response processing Some potential candidates for filtering include logging, metrics, and decorating responses.

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

     builder.appendConnectionFilter(filter1).appendConnectionFilter(filter2).appendConnectionFilter(filter3)
 

making a request to a connection wrapped by this filter chain the order of invocation of these filters will be:

     filter1 ⇒ filter2 ⇒ filter3 ⇒ connection
 

Specified by:

appendConnectionFilter in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

factory - StreamingHttpConnectionFilterFactory to decorate a StreamingHttpConnection for the purpose of filtering.

Returns:

this

appendConnectionFilter

public SingleAddressHttpClientBuilder<U,R> appendConnectionFilter(Predicate<StreamingHttpRequest> predicate,
                                                                  StreamingHttpConnectionFilterFactory factory)

Description copied from interface: SingleAddressHttpClientBuilder

Appends the filter to the chain of filters used to decorate the StreamingHttpConnection created by this builder, for every request that passes the provided Predicate.

Filtering allows you to wrap a StreamingHttpConnection and modify behavior during request/response processing Some potential candidates for filtering include logging, metrics, and decorating responses.

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

     builder.appendConnectionFilter(filter1).appendConnectionFilter(filter2).appendConnectionFilter(filter3)
 

making a request to a connection wrapped by this filter chain the order of invocation of these filters will be:

     filter1 ⇒ filter2 ⇒ filter3 ⇒ connection
 

When overriding this method, delegate to super as it uses internal utilities to provide a consistent execution flow.

Specified by:

appendConnectionFilter in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

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

factory - StreamingHttpConnectionFilterFactory to decorate a StreamingHttpConnection for the purpose of filtering.

Returns:

this

ioExecutor

public SingleAddressHttpClientBuilder<U,R> ioExecutor(IoExecutor ioExecutor)

Sets the IoExecutor for all clients created from this builder.

Specified by:

ioExecutor in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

ioExecutor - IoExecutor to use.

Returns:

this.

executor

public SingleAddressHttpClientBuilder<U,R> executor(Executor executor)

Sets the Executor for all clients created from this builder.

Specified by:

executor in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

executor - IoExecutor to use.

Returns:

this.

executionStrategy

public SingleAddressHttpClientBuilder<U,R> executionStrategy(HttpExecutionStrategy strategy)

Description copied from interface: SingleAddressHttpClientBuilder

Sets the HttpExecutionStrategy to be used for client callbacks when executing client requests for all clients created from this builder.

Specifying an execution strategy affects the offloading used during execution of client requests:

Unspecified or HttpExecutionStrategies.defaultStrategy()

Execution of client requests will use a safe (non-blocking) execution strategy appropriate for the client API used and the filters added. Blocking is always safe as all potentially blocking paths are offloaded. Each client API variant (async/blocking streaming/aggregate) requires a specific execution strategy to avoid blocking the event-loop and filters added via SingleAddressHttpClientBuilder.appendClientFilter(StreamingHttpClientFilterFactory), SingleAddressHttpClientBuilder.appendConnectionFilter(StreamingHttpConnectionFilterFactory), or SingleAddressHttpClientBuilder.appendConnectionFactoryFilter(ConnectionFactoryFilter), etc. may also require offloading. The execution strategy for execution of client requests will be computed based on the client API in use and HttpExecutionStrategyInfluencer.requiredOffloads() of added the filters.

HttpExecutionStrategies.offloadNone() (or deprecated HttpExecutionStrategies.offloadNever())

No offloading will be used during execution of client requests regardless of the client API used or the influence of added filters. Filters and asynchronous callbacks must not ever block during the execution of client requests.

A custom execution strategy (HttpExecutionStrategies.customStrategyBuilder()) or HttpExecutionStrategies.offloadAll()

The specified execution strategy will be used for executing client requests rather than the client API's default safe strategy. Like with the default strategy, the actual execution strategy used is computed from the provided strategy and the execution strategies required by added filters. Filters and asynchronous callbacks MAY only block during the offloaded portions of the client request execution.

Specified by:

executionStrategy in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

strategy - HttpExecutionStrategy to use. If callbacks to the application code may block then those callbacks must request to be offloaded.

Returns:

this.

See Also:

HttpExecutionStrategies

bufferAllocator

public SingleAddressHttpClientBuilder<U,R> bufferAllocator(BufferAllocator allocator)

Sets the BufferAllocator for all clients created from this builder.

Specified by:

bufferAllocator in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

allocator - BufferAllocator to use.

Returns:

this.

appendConnectionFactoryFilter

public SingleAddressHttpClientBuilder<U,R> appendConnectionFactoryFilter(ConnectionFactoryFilter<R,FilterableStreamingHttpConnection> factory)

Description copied from interface: SingleAddressHttpClientBuilder

Appends the filter to the chain of filters used to decorate the ConnectionFactory used by this builder.

Filtering allows you to wrap a ConnectionFactory and modify behavior of ConnectionFactory.newConnection(Object, ContextMap, TransportObserver). Some potential candidates for filtering include logging and metrics.

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

     builder
         .appendConnectionFactoryFilter(filter1)
         .appendConnectionFactoryFilter(filter2)
         .appendConnectionFactoryFilter(filter3)
 

Calling ConnectionFactory wrapped by this filter chain, the order of invocation of these filters will be:

     filter1 ⇒ filter2 ⇒ filter3 ⇒ original connection factory
 

Specified by:

appendConnectionFactoryFilter in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

factory - ConnectionFactoryFilter to use.

Returns:

this

appendClientFilter

public SingleAddressHttpClientBuilder<U,R> appendClientFilter(StreamingHttpClientFilterFactory factory)

Description copied from interface: SingleAddressHttpClientBuilder

Appends the filter to the chain of filters used to decorate the HttpClient created by this builder.

Note this method will be used to decorate the result of build() before it is returned to the user.

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

     builder.appendClientFilter(filter1).appendClientFilter(filter2).appendClientFilter(filter3)
 

making a request to a client wrapped by this filter chain the order of invocation of these filters will be:

     filter1 ⇒ filter2 ⇒ filter3 ⇒ client
 

Specified by:

appendClientFilter in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

factory - StreamingHttpClientFilterFactory to decorate a HttpClient for the purpose of filtering.

Returns:

this

appendClientFilter

public SingleAddressHttpClientBuilder<U,R> appendClientFilter(Predicate<StreamingHttpRequest> predicate,
                                                              StreamingHttpClientFilterFactory factory)

Description copied from interface: SingleAddressHttpClientBuilder

Appends the filter to the chain of filters used to decorate the HttpClient created by this builder, for every request that passes the provided Predicate.

Note this method will be used to decorate the result of build() before it is returned to the user.

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

     builder.appendClientFilter(filter1).appendClientFilter(filter2).appendClientFilter(filter3)
 

making a request to a client wrapped by this filter chain the order of invocation of these filters will be:

     filter1 ⇒ filter2 ⇒ filter3 ⇒ client
 

Specified by:

appendClientFilter in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

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

factory - StreamingHttpClientFilterFactory to decorate a HttpClient for the purpose of filtering.

Returns:

this

unresolvedAddressToHost

public SingleAddressHttpClientBuilder<U,R> unresolvedAddressToHost(Function<U,CharSequence> unresolvedAddressToHostFunction)

Description copied from interface: SingleAddressHttpClientBuilder

Provides a means to convert U unresolved address type into a CharSequence. An example of where this maybe used is to convert the U to a default host header. It may also be used in the event of proxying.

Specified by:

unresolvedAddressToHost in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

unresolvedAddressToHostFunction - invoked to convert the U unresolved address type into a CharSequence suitable for use in Host Header format.

Returns:

this

serviceDiscoverer

public SingleAddressHttpClientBuilder<U,R> serviceDiscoverer(ServiceDiscoverer<U,R,? extends ServiceDiscovererEvent<R>> serviceDiscoverer)

Description copied from interface: SingleAddressHttpClientBuilder

Sets a ServiceDiscoverer to resolve addresses of remote servers to connect to.

Specified by:

serviceDiscoverer in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

serviceDiscoverer - The ServiceDiscoverer to resolve addresses of remote servers to connect to. Lifecycle of the provided ServiceDiscoverer is managed externally and it should be closed after all built StreamingHttpClients will be closed and this ServiceDiscoverer is no longer needed.

Returns:

this.

retryServiceDiscoveryErrors

public SingleAddressHttpClientBuilder<U,R> retryServiceDiscoveryErrors(BiIntFunction<Throwable,? extends Completable> retryStrategy)

Description copied from interface: SingleAddressHttpClientBuilder

Sets a retry strategy to retry errors emitted by ServiceDiscoverer.

Specified by:

retryServiceDiscoveryErrors in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

retryStrategy - a retry strategy to retry errors emitted by ServiceDiscoverer.

Returns:

this.

See Also:

RetryStrategies

loadBalancerFactory

public SingleAddressHttpClientBuilder<U,R> loadBalancerFactory(HttpLoadBalancerFactory<R> loadBalancerFactory)

Description copied from interface: SingleAddressHttpClientBuilder

Sets a HttpLoadBalancerFactory to create LoadBalancer instances.

Specified by:

loadBalancerFactory in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

loadBalancerFactory - HttpLoadBalancerFactory to create LoadBalancer instances.

Returns:

this.

sslConfig

public SingleAddressHttpClientBuilder<U,R> sslConfig(ClientSslConfig sslConfig)

Description copied from interface: SingleAddressHttpClientBuilder

Set the SSL/TLS configuration.

Specified by:

sslConfig in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

sslConfig - The configuration to use.

Returns:

this.

See Also:

ClientSslConfigBuilder

inferPeerHost

public SingleAddressHttpClientBuilder<U,R> inferPeerHost(boolean shouldInfer)

Description copied from interface: SingleAddressHttpClientBuilder

Toggle inference of value to use instead of ClientSslConfig.peerHost() from client's address when peer host is not specified. By default, inference is enabled.

Specified by:

inferPeerHost in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

shouldInfer - value indicating whether inference is on (true) or off (false).

Returns:

this

inferPeerPort

public SingleAddressHttpClientBuilder<U,R> inferPeerPort(boolean shouldInfer)

Description copied from interface: SingleAddressHttpClientBuilder

Toggle inference of value to use instead of ClientSslConfig.peerPort() from client's address when peer port is not specified (equals -1). By default, inference is enabled.

Specified by:

inferPeerPort in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

shouldInfer - value indicating whether inference is on (true) or off (false).

Returns:

this

inferSniHostname

public SingleAddressHttpClientBuilder<U,R> inferSniHostname(boolean shouldInfer)

Description copied from interface: SingleAddressHttpClientBuilder

Toggle SNI hostname inference from client's address if not explicitly specified via SingleAddressHttpClientBuilder.sslConfig(ClientSslConfig). By default, inference is enabled.

Specified by:

inferSniHostname in interface SingleAddressHttpClientBuilder<U,R>

Parameters:

shouldInfer - value indicating whether inference is on (true) or off (false).

Returns:

this

build

public HttpClient build()

Builds a new HttpClient.

Returns:

A new HttpClient

buildStreaming

public StreamingHttpClient buildStreaming()

Builds a new StreamingHttpClient.

Returns:

A new StreamingHttpClient

buildBlocking

public BlockingHttpClient buildBlocking()

Creates a new BlockingHttpClient.

Returns:

BlockingHttpClient

buildBlockingStreaming

public BlockingStreamingHttpClient buildBlockingStreaming()

Creates a new BlockingStreamingHttpClient.

Returns:

BlockingStreamingHttpClient