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)

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 connections 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 for all connections created from this builder.
MultiAddressHttpClientBuilder<U,R>	executor(Executor executor) Sets the Executor for all connections 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 connections created from this builder.

Method Detail

ioExecutor

MultiAddressHttpClientBuilder<U,R> ioExecutor(IoExecutor ioExecutor)

Sets the IoExecutor for all connections created from this builder.

Parameters:

ioExecutor - IoExecutor to use.

Returns:

this.

executor

MultiAddressHttpClientBuilder<U,R> executor(Executor executor)

Sets the Executor for all connections created from this builder.

Parameters:

executor - IoExecutor to use.

Returns:

this.

executionStrategy

MultiAddressHttpClientBuilder<U,R> executionStrategy(HttpExecutionStrategy strategy)

Sets the HttpExecutionStrategy for all connections created from this builder.

Parameters:

strategy - HttpExecutionStrategy to use.

Returns:

this.

See Also:

HttpExecutionStrategies

bufferAllocator

MultiAddressHttpClientBuilder<U,R> bufferAllocator(BufferAllocator allocator)

Sets the BufferAllocator for all connections 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.

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