Package io.servicetalk.http.netty

Class HttpClients

java.lang.Object

io.servicetalk.http.netty.HttpClients

public final class HttpClients
extends Object

Factory methods for building HttpClient (and other API variations) instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HttpClients.DiscoveryStrategy	Defines ServiceDiscoverer will be used.

Method Summary

Modifier and Type	Method	Description
static MultiAddressHttpClientBuilder<HostAndPort,InetSocketAddress>	forMultiAddressUrl()	Creates a MultiAddressHttpClientBuilder for clients capable of parsing an absolute-form URL, connecting to multiple addresses with default LoadBalancer and DNS ServiceDiscoverer using background discovery strategy.
static MultiAddressHttpClientBuilder<HostAndPort,InetSocketAddress>	forMultiAddressUrl(ServiceDiscoverer<HostAndPort,InetSocketAddress,ServiceDiscovererEvent<InetSocketAddress>> serviceDiscoverer)	Deprecated. Use forMultiAddressUrl() to create MultiAddressHttpClientBuilder, then use MultiAddressHttpClientBuilder.initializer(SingleAddressInitializer) to override ServiceDiscoverer using SingleAddressHttpClientBuilder.serviceDiscoverer(ServiceDiscoverer) for all or some of the internal clients.
static MultiAddressHttpClientBuilder<HostAndPort,InetSocketAddress>	forMultiAddressUrl(String id)	Creates a MultiAddressHttpClientBuilder for clients capable of parsing an absolute-form URL, connecting to multiple addresses with default LoadBalancer and DNS ServiceDiscoverer using background discovery strategy.
static MultiAddressHttpClientBuilder<HostAndPort,InetSocketAddress>	forMultiAddressUrl(String id, ServiceDiscoverer<HostAndPort,InetSocketAddress,ServiceDiscovererEvent<InetSocketAddress>> serviceDiscoverer, HttpClients.DiscoveryStrategy discoveryStrategy)	Creates a MultiAddressHttpClientBuilder for clients capable of parsing an absolute-form URL, connecting to multiple addresses with default LoadBalancer, using the specified ServiceDiscoverer and HttpClients.DiscoveryStrategy.
static MultiAddressHttpClientBuilder<HostAndPort,InetSocketAddress>	forMultiAddressUrl(String id, HttpClients.DiscoveryStrategy discoveryStrategy)	Creates a MultiAddressHttpClientBuilder for clients capable of parsing an absolute-form URL, connecting to multiple addresses with default LoadBalancer and DNS ServiceDiscoverer using the specified HttpClients.DiscoveryStrategy.
static <U, R> PartitionedHttpClientBuilder<U,R>	forPartitionedAddress(ServiceDiscoverer<U,R,PartitionedServiceDiscovererEvent<R>> serviceDiscoverer, U address, Function<HttpRequestMetaData,PartitionAttributesBuilder> partitionAttributesBuilderFactory)	Deprecated. We are unaware of anyone using "partition" feature and plan to remove it in future releases.
static SingleAddressHttpClientBuilder<HostAndPort,InetSocketAddress>	forResolvedAddress(HostAndPort address)	Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer.
static SingleAddressHttpClientBuilder<HostAndPort,InetSocketAddress>	forResolvedAddress(String host, int port)	Creates a SingleAddressHttpClientBuilder for a resolved address with default LoadBalancer.
static <R extends SocketAddress> SingleAddressHttpClientBuilder<R,R>	forResolvedAddress(R address)	Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer.
static SingleAddressHttpClientBuilder<String,InetSocketAddress>	forServiceAddress(String serviceName)	Creates a SingleAddressHttpClientBuilder for the passed serviceName with default LoadBalancer and a DNS ServiceDiscoverer using SRV record lookups with background discovery strategy.
static <U, R> SingleAddressHttpClientBuilder<U,R>	forSingleAddress(ServiceDiscoverer<U,R,? extends ServiceDiscovererEvent<R>> serviceDiscoverer, U address)	Creates a SingleAddressHttpClientBuilder for a custom address type with default LoadBalancer and user provided ServiceDiscoverer using background discovery strategy.
static <U, R> SingleAddressHttpClientBuilder<U,R>	forSingleAddress(ServiceDiscoverer<U,R,? extends ServiceDiscovererEvent<R>> serviceDiscoverer, U address, HttpClients.DiscoveryStrategy discoveryStrategy)	Creates a SingleAddressHttpClientBuilder for a custom address type with default LoadBalancer and user provided ServiceDiscoverer using the specified HttpClients.DiscoveryStrategy.
static SingleAddressHttpClientBuilder<HostAndPort,InetSocketAddress>	forSingleAddress(HostAndPort address)	Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer using background discovery strategy.
static SingleAddressHttpClientBuilder<HostAndPort,InetSocketAddress>	forSingleAddress(HostAndPort address, HttpClients.DiscoveryStrategy discoveryStrategy)	Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer using the specified HttpClients.DiscoveryStrategy.
static SingleAddressHttpClientBuilder<HostAndPort,InetSocketAddress>	forSingleAddress(String host, int port)	Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer using background discovery strategy.
static SingleAddressHttpClientBuilder<HostAndPort,InetSocketAddress>	forSingleAddress(String host, int port, HttpClients.DiscoveryStrategy discoveryStrategy)	Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer using the specified HttpClients.DiscoveryStrategy.

Methods inherited from class java.lang.Object

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

Method Details

forMultiAddressUrl

public static MultiAddressHttpClientBuilder<HostAndPort,InetSocketAddress> forMultiAddressUrl()

Creates a MultiAddressHttpClientBuilder for clients capable of parsing an absolute-form URL, connecting to multiple addresses with default LoadBalancer and DNS ServiceDiscoverer using background discovery strategy.

When a relative URL is passed in the StreamingHttpRequest.requestTarget(String) this client requires a HttpHeaderNames.HOST present in order to infer the remote address.

The returned builder can be customized using HttpProviders.MultiAddressHttpClientBuilderProvider.

Returns:

new builder with default configuration

See Also:

• HttpProviders.MultiAddressHttpClientBuilderProvider

forMultiAddressUrl

public static MultiAddressHttpClientBuilder<HostAndPort,InetSocketAddress> forMultiAddressUrl(String id)

Creates a MultiAddressHttpClientBuilder for clients capable of parsing an absolute-form URL, connecting to multiple addresses with default LoadBalancer and DNS ServiceDiscoverer using background discovery strategy.

When a relative URL is passed in the StreamingHttpRequest.requestTarget(String) this client requires a HttpHeaderNames.HOST present in order to infer the remote address.

The returned builder can be customized using HttpProviders.MultiAddressHttpClientBuilderProvider.

Parameters:

id - a (unique) ID to identify the created MultiAddressHttpClientBuilder, like a name or a purpose of the future client that will be built. This helps HttpProviders.MultiAddressHttpClientBuilderProvider to distinguish this builder from others.

Returns:

new builder with default configuration

See Also:

• HttpProviders.MultiAddressHttpClientBuilderProvider

forMultiAddressUrl

public static MultiAddressHttpClientBuilder<HostAndPort,InetSocketAddress> forMultiAddressUrl(String id,
 HttpClients.DiscoveryStrategy discoveryStrategy)

Creates a MultiAddressHttpClientBuilder for clients capable of parsing an absolute-form URL, connecting to multiple addresses with default LoadBalancer and DNS ServiceDiscoverer using the specified HttpClients.DiscoveryStrategy.

When a relative URL is passed in the StreamingHttpRequest.requestTarget(String) this client requires a HttpHeaderNames.HOST present in order to infer the remote address.

The returned builder can be customized using HttpProviders.MultiAddressHttpClientBuilderProvider.

Parameters:

id - a (unique) ID to identify the created MultiAddressHttpClientBuilder, like a name or a purpose of the future client that will be built. This helps HttpProviders.MultiAddressHttpClientBuilderProvider to distinguish this builder from others.

discoveryStrategy - HttpClients.DiscoveryStrategy to use

Returns:

new builder with default configuration

See Also:

• HttpProviders.MultiAddressHttpClientBuilderProvider

forMultiAddressUrl

public static MultiAddressHttpClientBuilder<HostAndPort,InetSocketAddress> forMultiAddressUrl(String id,
 ServiceDiscoverer<HostAndPort,InetSocketAddress,ServiceDiscovererEvent<InetSocketAddress>> serviceDiscoverer,
 HttpClients.DiscoveryStrategy discoveryStrategy)

Creates a MultiAddressHttpClientBuilder for clients capable of parsing an absolute-form URL, connecting to multiple addresses with default LoadBalancer, using the specified ServiceDiscoverer and HttpClients.DiscoveryStrategy.

When a relative URL is passed in the StreamingHttpRequest.requestTarget(String) this client requires a HttpHeaderNames.HOST present in order to infer the remote address.

The returned builder can be customized using HttpProviders.MultiAddressHttpClientBuilderProvider.

Parameters:

id - a (unique) ID to identify the created MultiAddressHttpClientBuilder, like a name or a purpose of the future client that will be built. This helps HttpProviders.MultiAddressHttpClientBuilderProvider to distinguish this builder from others.

serviceDiscoverer - The ServiceDiscoverer to resolve addresses of remote servers to connect to. The lifecycle of the provided ServiceDiscoverer should be managed by the caller.

discoveryStrategy - HttpClients.DiscoveryStrategy to use.

Returns:

new builder with default configuration.

See Also:

• HttpProviders.MultiAddressHttpClientBuilderProvider

forMultiAddressUrl

@Deprecated
public static MultiAddressHttpClientBuilder<HostAndPort,InetSocketAddress> forMultiAddressUrl(ServiceDiscoverer<HostAndPort,InetSocketAddress,ServiceDiscovererEvent<InetSocketAddress>> serviceDiscoverer)

Deprecated.

Use forMultiAddressUrl() to create MultiAddressHttpClientBuilder, then use MultiAddressHttpClientBuilder.initializer(SingleAddressInitializer) to override ServiceDiscoverer using SingleAddressHttpClientBuilder.serviceDiscoverer(ServiceDiscoverer) for all or some of the internal clients.

Creates a MultiAddressHttpClientBuilder for clients capable of parsing an absolute-form URL, connecting to multiple addresses with default LoadBalancer and user provided ServiceDiscoverer.

When a relative URL is passed in the StreamingHttpRequest.requestTarget(String) this client requires a HttpHeaderNames.HOST present in order to infer the remote address.

The returned builder can be customized using HttpProviders.MultiAddressHttpClientBuilderProvider.

Parameters:

serviceDiscoverer - The ServiceDiscoverer to resolve addresses of remote servers to connect to. The lifecycle of the provided ServiceDiscoverer should be managed by the caller.

Returns:

new builder with default configuration

See Also:

• HttpProviders.MultiAddressHttpClientBuilderProvider

forSingleAddress

public static SingleAddressHttpClientBuilder<HostAndPort,InetSocketAddress> forSingleAddress(String host,
 int port)

Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer using background discovery strategy.

The returned builder can be customized using HttpProviders.SingleAddressHttpClientBuilderProvider.

Parameters:

host - host to connect to, resolved by default using a DNS ServiceDiscoverer. This will also be used for the HttpHeaderNames.HOST together with the port. Use SingleAddressHttpClientBuilder.unresolvedAddressToHost(Function) if you want to override that value or SingleAddressHttpClientBuilder.hostHeaderFallback(boolean) if you want to disable this behavior.

port - port to connect to

Returns:

new builder for the address

See Also:

• HttpProviders.SingleAddressHttpClientBuilderProvider

forSingleAddress

public static SingleAddressHttpClientBuilder<HostAndPort,InetSocketAddress> forSingleAddress(HostAndPort address)

Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer using background discovery strategy.

The returned builder can be customized using HttpProviders.SingleAddressHttpClientBuilderProvider.

Parameters:

address - the UnresolvedAddress to connect to, resolved by default using a DNS ServiceDiscoverer. This address will also be used for the HttpHeaderNames.HOST. Use SingleAddressHttpClientBuilder.unresolvedAddressToHost(Function) if you want to override that value or SingleAddressHttpClientBuilder.hostHeaderFallback(boolean) if you want to disable this behavior.

Returns:

new builder for the address

See Also:

• HttpProviders.SingleAddressHttpClientBuilderProvider

forSingleAddress

public static SingleAddressHttpClientBuilder<HostAndPort,InetSocketAddress> forSingleAddress(String host,
 int port,
 HttpClients.DiscoveryStrategy discoveryStrategy)

Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer using the specified HttpClients.DiscoveryStrategy.

The returned builder can be customized using HttpProviders.SingleAddressHttpClientBuilderProvider.

Parameters:

host - host to connect to, resolved by default using a DNS ServiceDiscoverer. This will also be used for the HttpHeaderNames.HOST together with the port. Use SingleAddressHttpClientBuilder.unresolvedAddressToHost(Function) if you want to override that value or SingleAddressHttpClientBuilder.hostHeaderFallback(boolean) if you want to disable this behavior.

port - port to connect to

discoveryStrategy - HttpClients.DiscoveryStrategy to use

Returns:

new builder for the address

See Also:

• HttpProviders.SingleAddressHttpClientBuilderProvider

forSingleAddress

public static SingleAddressHttpClientBuilder<HostAndPort,InetSocketAddress> forSingleAddress(HostAndPort address,
 HttpClients.DiscoveryStrategy discoveryStrategy)

Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer using the specified HttpClients.DiscoveryStrategy.

The returned builder can be customized using HttpProviders.SingleAddressHttpClientBuilderProvider.

Parameters:

address - the UnresolvedAddress to connect to, resolved by default using a DNS ServiceDiscoverer. This address will also be used for the HttpHeaderNames.HOST. Use SingleAddressHttpClientBuilder.unresolvedAddressToHost(Function) if you want to override that value or SingleAddressHttpClientBuilder.hostHeaderFallback(boolean) if you want to disable this behavior.

discoveryStrategy - HttpClients.DiscoveryStrategy to use

Returns:

new builder for the address

See Also:

• HttpProviders.SingleAddressHttpClientBuilderProvider

forServiceAddress

public static SingleAddressHttpClientBuilder<String,InetSocketAddress> forServiceAddress(String serviceName)

Creates a SingleAddressHttpClientBuilder for the passed serviceName with default LoadBalancer and a DNS ServiceDiscoverer using SRV record lookups with background discovery strategy.

The returned builder can be customized using HttpProviders.SingleAddressHttpClientBuilderProvider.

Parameters:

serviceName - The service name to resolve with SRV DNS.

Returns:

new builder for the address

See Also:

• HttpProviders.SingleAddressHttpClientBuilderProvider

forResolvedAddress

public static SingleAddressHttpClientBuilder<HostAndPort,InetSocketAddress> forResolvedAddress(String host,
 int port)

Creates a SingleAddressHttpClientBuilder for a resolved address with default LoadBalancer.

Parameters:

host - resolved host address to connect. This will also be used for the HttpHeaderNames.HOST together with the port. Use SingleAddressHttpClientBuilder.unresolvedAddressToHost(Function) if you want to override that value or SingleAddressHttpClientBuilder.hostHeaderFallback(boolean) if you want to disable this behavior.

Note, if a proxy is configured for this client, the proxy address also needs to be already resolved. Otherwise, runtime exceptions will be thrown when the client is built.

The returned builder can be customized using HttpProviders.SingleAddressHttpClientBuilderProvider.

port - port to connect to

Returns:

new builder for the address

See Also:

• HttpProviders.SingleAddressHttpClientBuilderProvider

forResolvedAddress

public static SingleAddressHttpClientBuilder<HostAndPort,InetSocketAddress> forResolvedAddress(HostAndPort address)

Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer.

Parameters:

address - the ResolvedAddress to connect. This address will also be used for the HttpHeaderNames.HOST. Use SingleAddressHttpClientBuilder.unresolvedAddressToHost(Function) if you want to override that value or SingleAddressHttpClientBuilder.hostHeaderFallback(boolean) if you want to disable this behavior.

Note, if a proxy is configured for this client, the proxy address also needs to be already resolved. Otherwise, runtime exceptions will be thrown when the client is built.

The returned builder can be customized using HttpProviders.SingleAddressHttpClientBuilderProvider.

Returns:

new builder for the address

See Also:

• HttpProviders.SingleAddressHttpClientBuilderProvider

forResolvedAddress

public static <R extends SocketAddress>
SingleAddressHttpClientBuilder<R,R> forResolvedAddress(R address)

Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer.

The returned builder can be customized using HttpProviders.SingleAddressHttpClientBuilderProvider.

Type Parameters:

R - The type of resolved SocketAddress.

Parameters:

address - the ResolvedAddress to connect. This address will also be used for the HttpHeaderNames.HOST. Use SingleAddressHttpClientBuilder.unresolvedAddressToHost(Function) if you want to override that value or SingleAddressHttpClientBuilder.hostHeaderFallback(boolean) if you want to disable this behavior.

Returns:

new builder for the address

See Also:

• HttpProviders.SingleAddressHttpClientBuilderProvider

forSingleAddress

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

Creates a SingleAddressHttpClientBuilder for a custom address type with default LoadBalancer and user provided ServiceDiscoverer using background discovery strategy.

The returned builder can be customized using HttpProviders.SingleAddressHttpClientBuilderProvider.

Type Parameters:

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

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

Parameters:

serviceDiscoverer - The ServiceDiscoverer to resolve addresses of remote servers to connect to. The lifecycle of the provided ServiceDiscoverer should be managed by the caller.

address - the UnresolvedAddress to connect to resolved using the provided serviceDiscoverer. This address will also be used for the HttpHeaderNames.HOST using a best effort conversion. Use SingleAddressHttpClientBuilder.unresolvedAddressToHost(Function) if you want to override that value or SingleAddressHttpClientBuilder.hostHeaderFallback(boolean) if you want to disable this behavior.

Returns:

new builder with provided configuration

See Also:

• HttpProviders.SingleAddressHttpClientBuilderProvider

forSingleAddress

public static <U,
R>
SingleAddressHttpClientBuilder<U,R> forSingleAddress(ServiceDiscoverer<U,R,? extends ServiceDiscovererEvent<R>> serviceDiscoverer,
 U address,
 HttpClients.DiscoveryStrategy discoveryStrategy)

Creates a SingleAddressHttpClientBuilder for a custom address type with default LoadBalancer and user provided ServiceDiscoverer using the specified HttpClients.DiscoveryStrategy.

The returned builder can be customized using HttpProviders.SingleAddressHttpClientBuilderProvider.

Type Parameters:

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

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

Parameters:

serviceDiscoverer - The ServiceDiscoverer to resolve addresses of remote servers to connect to. The lifecycle of the provided ServiceDiscoverer should be managed by the caller.

address - the UnresolvedAddress to connect to resolved using the provided serviceDiscoverer. This address will also be used for the HttpHeaderNames.HOST using a best effort conversion. Use SingleAddressHttpClientBuilder.unresolvedAddressToHost(Function) if you want to override that value or SingleAddressHttpClientBuilder.hostHeaderFallback(boolean) if you want to disable this behavior.

discoveryStrategy - HttpClients.DiscoveryStrategy to use

Returns:

new builder with provided configuration

See Also:

• HttpProviders.SingleAddressHttpClientBuilderProvider

forPartitionedAddress

@Deprecated
public static <U,
R>
PartitionedHttpClientBuilder<U,R> forPartitionedAddress(ServiceDiscoverer<U,R,PartitionedServiceDiscovererEvent<R>> serviceDiscoverer,
 U address,
 Function<HttpRequestMetaData,PartitionAttributesBuilder> partitionAttributesBuilderFactory)

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.

Creates a PartitionedHttpClientBuilder for a custom address type with default LoadBalancer and user provided ServiceDiscoverer.

Type Parameters:

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

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

Parameters:

serviceDiscoverer - The ServiceDiscoverer to resolve addresses of remote servers to connect to. The lifecycle of the provided ServiceDiscoverer should be managed by the caller.

address - the UnresolvedAddress to resolve using the provided serviceDiscoverer. This address will also be used for the HttpHeaderNames.HOST using a best effort conversion. Use PartitionedHttpClientBuilder.initializer(PartitionedHttpClientBuilder.SingleAddressInitializer) and SingleAddressHttpClientBuilder.unresolvedAddressToHost(Function) if you want to override that value or SingleAddressHttpClientBuilder.hostHeaderFallback(boolean) if you want to disable this behavior.

partitionAttributesBuilderFactory - The factory Function used to build PartitionAttributes from HttpRequestMetaData.

Returns:

new builder with provided configuration