io.servicetalk.http.api

Interface PartitionedHttpClientBuilder<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:

DelegatingPartitionedHttpClientBuilder

Deprecated.

We are unaware of anyone using "partition" feature and plan to remove it in future releases. If you depend on it, consider using ClientGroup as an alternative or reach out to the maintainers describing the use-case.

@Deprecated
public interface PartitionedHttpClientBuilder<U,R>

A builder of homogeneous StreamingHttpClient instances which call the server associated with a partition selected from a set of PartitionedServiceDiscovererEvents resolved from a single unresolved address.

Partition selection uses a function to infer PartitionAttributes from the HttpRequestMetaData. 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.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
PartitionedHttpClientBuilder<U,R>	bufferAllocator(BufferAllocator allocator) Deprecated. 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.
PartitionedHttpClientBuilder<U,R>	executionStrategy(HttpExecutionStrategy strategy) Deprecated. Sets the HttpExecutionStrategy to be used for client callbacks when executing client requests for all clients created from this builder.
PartitionedHttpClientBuilder<U,R>	executor(Executor executor) Deprecated. Sets the Executor for all clients created from this builder.
default PartitionedHttpClientBuilder<U,R>	headersFactory(HttpHeadersFactory headersFactory) Deprecated. Sets the HttpHeadersFactory to be used for creating HttpHeaders for new requests.
PartitionedHttpClientBuilder<U,R>	initializer(PartitionedHttpClientBuilder.SingleAddressInitializer<U,R> initializer) Deprecated. Set a function which can customize options for each StreamingHttpClient that is built.
PartitionedHttpClientBuilder<U,R>	ioExecutor(IoExecutor ioExecutor) Deprecated. Sets the IoExecutor for all clients created from this builder.
PartitionedHttpClientBuilder<U,R>	partitionMapFactory(PartitionMapFactory partitionMapFactory) Deprecated. Sets PartitionMapFactory to use by all StreamingHttpClients created by this builder.
PartitionedHttpClientBuilder<U,R>	retryServiceDiscoveryErrors(BiIntFunction<Throwable,? extends Completable> retryStrategy) Deprecated. Sets a retry strategy to retry errors emitted by ServiceDiscoverer.
PartitionedHttpClientBuilder<U,R>	serviceDiscoverer(ServiceDiscoverer<U,R,PartitionedServiceDiscovererEvent<R>> serviceDiscoverer) Deprecated. Sets a ServiceDiscoverer to resolve addresses of remote servers to connect to.
PartitionedHttpClientBuilder<U,R>	serviceDiscoveryMaxQueueSize(int serviceDiscoveryMaxQueueSize) Deprecated. Sets the maximum amount of ServiceDiscovererEvent objects that will be queued for each partition.

Method Detail

ioExecutor

PartitionedHttpClientBuilder<U,R> ioExecutor(IoExecutor ioExecutor)

Deprecated.

Sets the IoExecutor for all clients created from this builder.

Parameters:

ioExecutor - IoExecutor to use.

Returns:

this.

executor

PartitionedHttpClientBuilder<U,R> executor(Executor executor)

Deprecated.

Sets the Executor for all clients created from this builder.

Parameters:

executor - IoExecutor to use.

Returns:

this.

executionStrategy

PartitionedHttpClientBuilder<U,R> executionStrategy(HttpExecutionStrategy strategy)

Deprecated.

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

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

PartitionedHttpClientBuilder<U,R> bufferAllocator(BufferAllocator allocator)

Deprecated.

Sets the BufferAllocator for all clients created from this builder.

Parameters:

allocator - BufferAllocator to use.

Returns:

this.

headersFactory

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

Deprecated.

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

serviceDiscoverer

PartitionedHttpClientBuilder<U,R> serviceDiscoverer(ServiceDiscoverer<U,R,PartitionedServiceDiscovererEvent<R>> serviceDiscoverer)

Deprecated.

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

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

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

Deprecated.

Sets a retry strategy to retry errors emitted by ServiceDiscoverer.

Parameters:

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

Returns:

this.

See Also:

RetryStrategies

serviceDiscoveryMaxQueueSize

PartitionedHttpClientBuilder<U,R> serviceDiscoveryMaxQueueSize(int serviceDiscoveryMaxQueueSize)

Deprecated.

Sets the maximum amount of ServiceDiscovererEvent objects that will be queued for each partition.

It is assumed that the PublisherSource.Subscribers will process events in a timely manner (typically synchronously) so this typically doesn't need to be very large.

Parameters:

serviceDiscoveryMaxQueueSize - the maximum amount of ServiceDiscovererEvent objects that will be queued for each partition.

Returns:

this.

partitionMapFactory

PartitionedHttpClientBuilder<U,R> partitionMapFactory(PartitionMapFactory partitionMapFactory)

Deprecated.

Sets PartitionMapFactory to use by all StreamingHttpClients created by this builder.

Parameters:

partitionMapFactory - PartitionMapFactory to use.

Returns:

this.

initializer

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

Deprecated.

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

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