Package io.servicetalk.http.api

Class DelegatingMultiAddressHttpClientBuilder<U,R>

java.lang.Object

io.servicetalk.http.api.DelegatingMultiAddressHttpClientBuilder<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:

MultiAddressHttpClientBuilder<U,R>

public class DelegatingMultiAddressHttpClientBuilder<U,R>
extends Object
implements MultiAddressHttpClientBuilder<U,R>

A MultiAddressHttpClientBuilder that delegates all methods to another MultiAddressHttpClientBuilder.

Nested Class Summary

Nested classes/interfaces inherited from interface io.servicetalk.http.api.MultiAddressHttpClientBuilder

MultiAddressHttpClientBuilder.SingleAddressInitializer<U,R>

Constructor Summary

Constructors

Constructor	Description
DelegatingMultiAddressHttpClientBuilder(MultiAddressHttpClientBuilder<U,R> delegate)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
MultiAddressHttpClientBuilder<U,R>	appendClientFilter(StreamingHttpClientFilterFactory factory)	Appends the filter to the chain of filters used to decorate the HttpClient created by this builder.
MultiAddressHttpClientBuilder<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.
MultiAddressHttpClientBuilder<U,R>	bufferAllocator(BufferAllocator allocator)
HttpClient	build()
BlockingHttpClient	buildBlocking()
BlockingStreamingHttpClient	buildBlockingStreaming()
StreamingHttpClient	buildStreaming()
MultiAddressHttpClientBuilder<U,R>	defaultHttpPort(int port)	Configures the default port for the HTTP scheme if not explicitly provided as part of the HttpRequestMetaData.requestTarget().
MultiAddressHttpClientBuilder<U,R>	defaultHttpsPort(int port)	Configures the default port for the HTTPS scheme if not explicitly provided as part of the HttpRequestMetaData.requestTarget().
protected final MultiAddressHttpClientBuilder<U,R>	delegate()	Returns the MultiAddressHttpClientBuilder delegate.
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)
MultiAddressHttpClientBuilder<U,R>	followRedirects(RedirectConfig config)	Configures redirection behavior.
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)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DelegatingMultiAddressHttpClientBuilder

public DelegatingMultiAddressHttpClientBuilder(MultiAddressHttpClientBuilder<U,R> delegate)

Create a new instance.

Parameters:

delegate - MultiAddressHttpClientBuilder to which all methods are delegated.

Method Details

delegate

protected final MultiAddressHttpClientBuilder<U,R> delegate()

Returns the MultiAddressHttpClientBuilder delegate.

Returns:

Delegate MultiAddressHttpClientBuilder.

toString

public String toString()

Overrides:

toString in class Object

ioExecutor

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

Specified by:

ioExecutor in interface MultiAddressHttpClientBuilder<U,R>

executor

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

Specified by:

executor in interface MultiAddressHttpClientBuilder<U,R>

executionStrategy

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

Description copied from interface: MultiAddressHttpClientBuilder

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

Specified by:

executionStrategy in interface MultiAddressHttpClientBuilder<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 MultiAddressHttpClientBuilder<U,R> bufferAllocator(BufferAllocator allocator)

Specified by:

bufferAllocator in interface MultiAddressHttpClientBuilder<U,R>

headersFactory

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

Description copied from interface: MultiAddressHttpClientBuilder

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

Specified by:

headersFactory in interface MultiAddressHttpClientBuilder<U,R>

Parameters:

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

Returns:

this

initializer

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

Description copied from interface: MultiAddressHttpClientBuilder

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

Specified by:

initializer in interface MultiAddressHttpClientBuilder<U,R>

Parameters:

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

Returns:

this

followRedirects

public MultiAddressHttpClientBuilder<U,R> followRedirects(RedirectConfig config)

Description copied from interface: MultiAddressHttpClientBuilder

Configures redirection behavior.

Specified by:

followRedirects in interface MultiAddressHttpClientBuilder<U,R>

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. Use null to disable redirects.

Note that this filters location is last, or as if it had been appended right before building the client. If that is not the desired position you can disable redirects and use MultiAddressHttpClientBuilder.appendClientFilter(StreamingHttpClientFilterFactory) to place the RedirectingHttpRequesterFilter in the position of your choice.

Returns:

this.

See Also:

• RedirectConfigBuilder

defaultHttpPort

public MultiAddressHttpClientBuilder<U,R> defaultHttpPort(int port)

Description copied from interface: MultiAddressHttpClientBuilder

Configures the default port for the HTTP scheme if not explicitly provided as part of the HttpRequestMetaData.requestTarget().

Specified by:

defaultHttpPort in interface MultiAddressHttpClientBuilder<U,R>

Parameters:

port - the port that should be used if not explicitly provided for HTTP requests.

Returns:

this.

defaultHttpsPort

public MultiAddressHttpClientBuilder<U,R> defaultHttpsPort(int port)

Description copied from interface: MultiAddressHttpClientBuilder

Configures the default port for the HTTPS scheme if not explicitly provided as part of the HttpRequestMetaData.requestTarget().

Specified by:

defaultHttpsPort in interface MultiAddressHttpClientBuilder<U,R>

Parameters:

port - the port that should be used if not explicitly provided for HTTPS requests.

Returns:

this.

build

public HttpClient build()

buildStreaming

public StreamingHttpClient buildStreaming()

buildBlocking

public BlockingHttpClient buildBlocking()

buildBlockingStreaming

public BlockingStreamingHttpClient buildBlockingStreaming()

appendClientFilter

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

Description copied from interface: MultiAddressHttpClientBuilder

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 but will always be before any filters applied to the underlying single address clients. 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 MultiAddressHttpClientBuilder<U,R>

Parameters:

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

Returns:

this

See Also:

• for adding filters to the underlying clients.

appendClientFilter

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

Description copied from interface: MultiAddressHttpClientBuilder

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 but will always be before any filters applied to the underlying single address clients. 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 MultiAddressHttpClientBuilder<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

See Also:

• for adding filters to the underlying clients.