io.servicetalk.http.api

Interface MultiAddressHttpClientBuilder<U,R>

Type Parameters:

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

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

All Known Implementing Classes:

DelegatingMultiAddressHttpClientBuilder

public interface MultiAddressHttpClientBuilder<U,R>

A builder of StreamingHttpClient instances which have a capacity to call any server based on the parsed absolute-form URL address information from each StreamingHttpRequest.

It also provides a good set of default settings and configurations, which could be used by most users as-is or could be overridden to address specific use cases.

See Also:

absolute-form rfc7230#section-5.3.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MultiAddressHttpClientBuilder.SingleAddressInitializer<U,R> Initializes the SingleAddressHttpClientBuilder for each new client.

Method Summary

Modifier and Type	Method and Description
MultiAddressHttpClientBuilder<U,R>	bufferAllocator(BufferAllocator allocator) Sets the BufferAllocator for all clients created from this builder.
default HttpClient	build() Builds a new HttpClient.
default BlockingHttpClient	buildBlocking() Creates a new BlockingHttpClient.
default BlockingStreamingHttpClient	buildBlockingStreaming() Creates a new BlockingStreamingHttpClient.
StreamingHttpClient	buildStreaming() Builds a new StreamingHttpClient.
MultiAddressHttpClientBuilder<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.
MultiAddressHttpClientBuilder<U,R>	executor(Executor executor) Sets the Executor for all clients created from this builder.
MultiAddressHttpClientBuilder<U,R>	followRedirects(RedirectConfig config) Enables redirection.
default MultiAddressHttpClientBuilder<U,R>	headersFactory(HttpHeadersFactory headersFactory) Sets the HttpHeadersFactory to be used for creating HttpHeaders for new requests.
MultiAddressHttpClientBuilder<U,R>	initializer(MultiAddressHttpClientBuilder.SingleAddressInitializer<U,R> initializer) Set a function which can customize options for each StreamingHttpClient that is built.
MultiAddressHttpClientBuilder<U,R>	ioExecutor(IoExecutor ioExecutor) Sets the IoExecutor for all clients created from this builder.

Method Detail

ioExecutor

MultiAddressHttpClientBuilder<U,R> ioExecutor(IoExecutor ioExecutor)

Sets the IoExecutor for all clients created from this builder.

Parameters:

ioExecutor - IoExecutor to use.

Returns:

this.

executor

MultiAddressHttpClientBuilder<U,R> executor(Executor executor)

Sets the Executor for all clients created from this builder.

Parameters:

executor - IoExecutor to use.

Returns:

this.

executionStrategy

MultiAddressHttpClientBuilder<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.

Provides the base execution strategy for all clients created from this builder and the default strategy for the SingleAddressHttpClientBuilder used to construct client instances. The initializer(SingleAddressInitializer) may be used for some customization of the execution strategy for a specific single address client instance, but may not reduce the offloading to be performed. Specifically, the initializer may introduce additional offloading via SingleAddressHttpClientBuilder.executionStrategy(HttpExecutionStrategy) and may add filters which influence the computed execution strategy.

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

Unspecified or HttpExecutionStrategies.defaultStrategy()

The resulting client instances will use the default safe strategy for each API variant and SingleAddressHttpClientBuilder instances generated will also have default strategy.

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

SingleAddressHttpClientBuilder instances created by the client will have a strategy of HttpExecutionStrategies.offloadNone(). HttpExecutionStrategies.offloadNone() execution strategy requires that filters and asynchronous callbacks must not ever block during the execution of client requests. An initializer may override to add offloads using SingleAddressHttpClientBuilder.executionStrategy(HttpExecutionStrategy).

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

SingleAddressHttpClientBuilder instances created by the client will start with the provided strategy and may add additional offloading as required by added filters.

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

MultiAddressHttpClientBuilder<U,R> bufferAllocator(BufferAllocator allocator)

Sets the BufferAllocator for all clients created from this builder.

Parameters:

allocator - BufferAllocator to use.

Returns:

this.

headersFactory

default MultiAddressHttpClientBuilder<U,R> headersFactory(HttpHeadersFactory headersFactory)

Sets the HttpHeadersFactory to be used for creating HttpHeaders for new requests.

Parameters:

headersFactory - HttpHeadersFactory to be used for creating HttpHeaders for new requests

Returns:

this

initializer

MultiAddressHttpClientBuilder<U,R> initializer(MultiAddressHttpClientBuilder.SingleAddressInitializer<U,R> initializer)

Set a function which can customize options for each StreamingHttpClient that is built.

Parameters:

initializer - Initializes the SingleAddressHttpClientBuilder used to build new StreamingHttpClients. See executionStrategy(HttpExecutionStrategy) for discussion of restrictions on the use of SingleAddressHttpClientBuilder.executionStrategy(HttpExecutionStrategy) within an initializer.

Returns:

this

followRedirects

MultiAddressHttpClientBuilder<U,R> followRedirects(RedirectConfig config)

Enables redirection.

Parameters:

config - RedirectConfig to configure redirection behavior. It can be used to tune what requests should follow redirects and which parts of the original request (headers/payload body/trailers) should be redirected to non-relative locations.

Returns:

this.

See Also:

RedirectConfigBuilder

buildStreaming

StreamingHttpClient buildStreaming()

Builds a new StreamingHttpClient.

Returns:

A new StreamingHttpClient

Throws:

IllegalArgumentException - for incomplete or illegal configurations

IllegalStateException - for unsupported configuration combinations

build

default HttpClient build()

Builds a new HttpClient.

Returns:

A new HttpClient

buildBlockingStreaming

default BlockingStreamingHttpClient buildBlockingStreaming()

Creates a new BlockingStreamingHttpClient.

Returns:

BlockingStreamingHttpClient

buildBlocking

default BlockingHttpClient buildBlocking()

Creates a new BlockingHttpClient.

Returns:

BlockingHttpClient