Package io.servicetalk.http.netty

Class HttpClients

java.lang.Object

io.servicetalk.http.netty.HttpClients

public final class HttpClients
extends java.lang.Object

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

Method Summary

Modifier and Type	Method	Description
static MultiAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress>	forMultiAddressUrl()	Creates a MultiAddressHttpClientBuilder for clients capable of parsing an absolute-form URL, connecting to multiple addresses with default LoadBalancer and DNS ServiceDiscoverer.
static MultiAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress>	forMultiAddressUrl(ServiceDiscoverer<HostAndPort,java.net.InetSocketAddress,ServiceDiscovererEvent<java.net.InetSocketAddress>> serviceDiscoverer)	Creates a MultiAddressHttpClientBuilder for clients capable of parsing an absolute-form URL, connecting to multiple addresses with default LoadBalancer and user provided ServiceDiscoverer.
static <U,R> PartitionedHttpClientBuilder<U,R>	forPartitionedAddress(ServiceDiscoverer<U,R,PartitionedServiceDiscovererEvent<R>> serviceDiscoverer, U address, java.util.function.Function<HttpRequestMetaData,PartitionAttributesBuilder> partitionAttributesBuilderFactory)	Creates a PartitionedHttpClientBuilder for a custom address type with default LoadBalancer and user provided ServiceDiscoverer.
static SingleAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress>	forResolvedAddress(HostAndPort address)	Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer.
static SingleAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress>	forResolvedAddress(java.lang.String host, int port)	Creates a SingleAddressHttpClientBuilder for a resolved address with default LoadBalancer.
static <T extends java.net.SocketAddress> SingleAddressHttpClientBuilder<T,T>	forResolvedAddress(T address)	Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer.
static SingleAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress>	forResolvedAddressViaProxy(HostAndPort address, HostAndPort proxyAddress)	Creates a SingleAddressHttpClientBuilder for an address via a proxy, with default LoadBalancer and DNS ServiceDiscoverer.
static SingleAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress>	forResolvedAddressViaProxy(java.lang.String host, int port, java.lang.String proxyHost, int proxyPort)	Creates a SingleAddressHttpClientBuilder for a resolved address via a proxy, with default LoadBalancer.
static SingleAddressHttpClientBuilder<java.net.InetSocketAddress,java.net.InetSocketAddress>	forResolvedAddressViaProxy(java.net.InetSocketAddress address, java.net.InetSocketAddress proxyAddress)	Creates a SingleAddressHttpClientBuilder for an address via a proxy, with default LoadBalancer and DNS ServiceDiscoverer.
static SingleAddressHttpClientBuilder<java.lang.String,java.net.InetSocketAddress>	forServiceAddress(java.lang.String serviceName)	Creates a SingleAddressHttpClientBuilder for the passed serviceName with default LoadBalancer and a DNS ServiceDiscoverer using SRV record lookups.
static <U,R> SingleAddressHttpClientBuilder<U,R>	forSingleAddress(ServiceDiscoverer<U,R,ServiceDiscovererEvent<R>> serviceDiscoverer, U address)	Creates a SingleAddressHttpClientBuilder for a custom address type with default LoadBalancer and user provided ServiceDiscoverer.
static SingleAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress>	forSingleAddress(HostAndPort address)	Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer.
static SingleAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress>	forSingleAddress(java.lang.String host, int port)	Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer.
static SingleAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress>	forSingleAddressViaProxy(HostAndPort address, HostAndPort proxyAddress)	Creates a SingleAddressHttpClientBuilder for an address via a proxy, with default LoadBalancer and DNS ServiceDiscoverer.
static SingleAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress>	forSingleAddressViaProxy(java.lang.String host, int port, java.lang.String proxyHost, int proxyPort)	Creates a SingleAddressHttpClientBuilder for an address via a proxy, with default LoadBalancer and DNS ServiceDiscoverer.

Methods inherited from class java.lang.Object

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

Method Detail

forMultiAddressUrl

public static MultiAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress> forMultiAddressUrl()

Creates a MultiAddressHttpClientBuilder for clients capable of parsing an absolute-form URL, connecting to multiple addresses with default LoadBalancer and DNS 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.

Returns:

new builder with default configuration

forMultiAddressUrl

public static MultiAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress> forMultiAddressUrl(ServiceDiscoverer<HostAndPort,java.net.InetSocketAddress,ServiceDiscovererEvent<java.net.InetSocketAddress>> serviceDiscoverer)

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.

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

forSingleAddress

public static SingleAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress> forSingleAddress(java.lang.String host,
                                                                                                            int port)

Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer.

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.disableHostHeaderFallback() if you want to disable this behavior.

port - port to connect to

Returns:

new builder for the address

forSingleAddressViaProxy

public static SingleAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress> forSingleAddressViaProxy(java.lang.String host,
                                                                                                                    int port,
                                                                                                                    java.lang.String proxyHost,
                                                                                                                    int proxyPort)

Creates a SingleAddressHttpClientBuilder for an address via a proxy, with default LoadBalancer and DNS ServiceDiscoverer.

Parameters:

host - host to connect to via the proxy. 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.disableHostHeaderFallback() if you want to disable this behavior.

port - port to connect to

proxyHost - the proxy host to connect to, resolved by default using a DNS ServiceDiscoverer.

proxyPort - The proxy port to connect.

Returns:

new builder for the address

forSingleAddress

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

Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer.

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.disableHostHeaderFallback() if you want to disable this behavior.

Returns:

new builder for the address

forServiceAddress

public static SingleAddressHttpClientBuilder<java.lang.String,java.net.InetSocketAddress> forServiceAddress(java.lang.String serviceName)

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

Parameters:

serviceName - The service name to resolve with SRV DNS.

Returns:

new builder for the address

forSingleAddressViaProxy

public static SingleAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress> forSingleAddressViaProxy(HostAndPort address,
                                                                                                                    HostAndPort proxyAddress)

Creates a SingleAddressHttpClientBuilder for an address via a proxy, with default LoadBalancer and DNS ServiceDiscoverer.

Parameters:

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

proxyAddress - the proxy UnresolvedAddress to connect to, resolved by default using a DNS ServiceDiscoverer.

Returns:

new builder for the address

forResolvedAddress

public static SingleAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress> forResolvedAddress(java.lang.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.disableHostHeaderFallback() if you want to disable this behavior.

port - port to connect to

Returns:

new builder for the address

forResolvedAddressViaProxy

public static SingleAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress> forResolvedAddressViaProxy(java.lang.String host,
                                                                                                                      int port,
                                                                                                                      java.lang.String proxyHost,
                                                                                                                      int proxyPort)

Creates a SingleAddressHttpClientBuilder for a resolved address via a proxy, with default LoadBalancer.

Parameters:

host - resolved host address to connect via the proxy. 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.disableHostHeaderFallback() if you want to disable this behavior.

port - port to connect to via the proxy

proxyHost - The proxy resolved host address to connect.

proxyPort - The proxy port to connect.

Returns:

new builder for the address

forResolvedAddress

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

Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer.

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.disableHostHeaderFallback() if you want to disable this behavior.

Returns:

new builder for the address

forResolvedAddressViaProxy

public static SingleAddressHttpClientBuilder<HostAndPort,java.net.InetSocketAddress> forResolvedAddressViaProxy(HostAndPort address,
                                                                                                                      HostAndPort proxyAddress)

Creates a SingleAddressHttpClientBuilder for an address via a proxy, with default LoadBalancer and DNS ServiceDiscoverer.

Parameters:

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

proxyAddress - The proxy ResolvedAddress to connect.

Returns:

new builder for the address

forResolvedAddress

public static <T extends java.net.SocketAddress> SingleAddressHttpClientBuilder<T,T> forResolvedAddress(T address)

Creates a SingleAddressHttpClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer.

Type Parameters:

T - The type of 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.disableHostHeaderFallback() if you want to disable this behavior.

Returns:

new builder for the address

forResolvedAddressViaProxy

public static SingleAddressHttpClientBuilder<java.net.InetSocketAddress,java.net.InetSocketAddress> forResolvedAddressViaProxy(java.net.InetSocketAddress address,
                                                                                                                                     java.net.InetSocketAddress proxyAddress)

Creates a SingleAddressHttpClientBuilder for an address via a proxy, with default LoadBalancer and DNS ServiceDiscoverer.

Parameters:

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

proxyAddress - The proxy ResolvedAddress to connect.

Returns:

new builder for the address

forSingleAddress

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

Creates a SingleAddressHttpClientBuilder 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 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.disableHostHeaderFallback() if you want to disable this behavior.

Returns:

new builder with provided configuration

forPartitionedAddress

public static <U,R> PartitionedHttpClientBuilder<U,R> forPartitionedAddress(ServiceDiscoverer<U,R,PartitionedServiceDiscovererEvent<R>> serviceDiscoverer,
                                                                                        U address,
                                                                                        java.util.function.Function<HttpRequestMetaData,PartitionAttributesBuilder> partitionAttributesBuilderFactory)

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.unresolvedAddressToHost(Function) if you want to override that value or PartitionedHttpClientBuilder.disableHostHeaderFallback() if you want to disable this behavior.

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

Returns:

new builder with provided configuration