com.linecorp.armeria.client

Class WebClientBuilder

java.lang.Object

com.linecorp.armeria.client.WebClientBuilder

public final class WebClientBuilder
extends Object

Creates a new web client that connects to the specified URI using the builder pattern. Use the factory methods in WebClient if you do not have many options to override. Please refer to ClientBuilder for how decorators and HTTP headers are configured

Method Summary

Modifier and Type	Method and Description
WebClientBuilder	addHttpHeader(CharSequence name, Object value) Adds the specified HTTP header.
WebClientBuilder	addHttpHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> httpHeaders) Adds the specified HTTP headers.
WebClient	build() Returns a newly-created web client based on the properties of this builder.
WebClientBuilder	decorator(DecoratingHttpClientFunction decorator) Adds the specified HTTP-level decorator.
WebClientBuilder	decorator(Function<? super HttpClient,? extends HttpClient> decorator) Adds the specified HTTP-level decorator.
WebClientBuilder	defaultMaxResponseLength(long maxResponseLength) Deprecated.
WebClientBuilder	defaultResponseTimeout(Duration responseTimeout) Deprecated.
WebClientBuilder	defaultResponseTimeoutMillis(long responseTimeoutMillis) Deprecated.
WebClientBuilder	defaultWriteTimeout(Duration writeTimeout) Deprecated.
WebClientBuilder	defaultWriteTimeoutMillis(long writeTimeoutMillis) Deprecated.
WebClientBuilder	endpointRemapper(Function<? super Endpoint,? extends EndpointGroup> endpointRemapper) Sets a Function that remaps an Endpoint into an EndpointGroup.
WebClientBuilder	factory(ClientFactory factory) Sets the ClientFactory used for creating a client.
WebClientBuilder	maxResponseLength(long maxResponseLength) Sets the maximum allowed length of a server response in bytes.
<T> WebClientBuilder	option(ClientOption<T> option, T value) Adds the specified ClientOption and its value.
<T> WebClientBuilder	option(ClientOptionValue<T> optionValue) Adds the specified ClientOptionValue.
WebClientBuilder	options(ClientOptions options) Adds the specified ClientOptions.
WebClientBuilder	options(ClientOptionValue<?>... options) Adds the specified ClientOptionValues.
WebClientBuilder	options(Iterable<ClientOptionValue<?>> options) Adds the specified ClientOptionValues.
WebClientBuilder	path(String path) Sets the path of the client.
WebClientBuilder	requestIdGenerator(Supplier<RequestId> requestIdGenerator) Sets the Supplier that generates a RequestId.
WebClientBuilder	responseTimeout(Duration responseTimeout) Sets the timeout of a response.
WebClientBuilder	responseTimeoutMillis(long responseTimeoutMillis) Sets the timeout of a response in milliseconds.
WebClientBuilder	rpcDecorator(DecoratingRpcClientFunction decorator) Adds the specified RPC-level decorator.
WebClientBuilder	rpcDecorator(Function<? super RpcClient,? extends RpcClient> decorator) Adds the specified RPC-level decorator.
WebClientBuilder	setHttpHeader(CharSequence name, Object value) Sets the specified HTTP header.
WebClientBuilder	setHttpHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> httpHeaders) Sets the specified HTTP headers.
WebClientBuilder	writeTimeout(Duration writeTimeout) Sets the timeout of a socket write attempt.
WebClientBuilder	writeTimeoutMillis(long writeTimeoutMillis) Sets the timeout of a socket write attempt in milliseconds.

Methods inherited from class java.lang.Object

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

Method Detail

path

public WebClientBuilder path(String path)

Sets the path of the client.

build

public WebClient build()

Returns a newly-created web client based on the properties of this builder.

Throws:

IllegalArgumentException - if the scheme of the uri specified in WebClient.builder(String) or WebClient.builder(URI) is not an HTTP scheme

rpcDecorator

public WebClientBuilder rpcDecorator(Function<? super RpcClient,? extends RpcClient> decorator)

Adds the specified RPC-level decorator.

Parameters:

decorator - the Function that transforms an RpcClient to another

rpcDecorator

public WebClientBuilder rpcDecorator(DecoratingRpcClientFunction decorator)

Adds the specified RPC-level decorator.

Parameters:

decorator - the DecoratingRpcClientFunction that intercepts an invocation

options

public WebClientBuilder options(ClientOptions options)

Adds the specified ClientOptions.

options

public WebClientBuilder options(ClientOptionValue<?>... options)

Adds the specified ClientOptionValues.

options

public WebClientBuilder options(Iterable<ClientOptionValue<?>> options)

Adds the specified ClientOptionValues.

option

public <T> WebClientBuilder option(ClientOption<T> option,
                                   T value)

Adds the specified ClientOption and its value.

option

public <T> WebClientBuilder option(ClientOptionValue<T> optionValue)

Adds the specified ClientOptionValue.

factory

public WebClientBuilder factory(ClientFactory factory)

Sets the ClientFactory used for creating a client. The default is ClientFactory.ofDefault().

defaultWriteTimeout

@Deprecated
public WebClientBuilder defaultWriteTimeout(Duration writeTimeout)

Deprecated.

Sets the timeout of a socket write attempt.

Parameters:

writeTimeout - the timeout. 0 disables the timeout.

defaultWriteTimeoutMillis

@Deprecated
public WebClientBuilder defaultWriteTimeoutMillis(long writeTimeoutMillis)

Deprecated.

Sets the timeout of a socket write attempt in milliseconds.

Parameters:

writeTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.

writeTimeout

public WebClientBuilder writeTimeout(Duration writeTimeout)

Sets the timeout of a socket write attempt.

Parameters:

writeTimeout - the timeout. 0 disables the timeout.

writeTimeoutMillis

public WebClientBuilder writeTimeoutMillis(long writeTimeoutMillis)

Sets the timeout of a socket write attempt in milliseconds.

Parameters:

writeTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.

defaultResponseTimeout

@Deprecated
public WebClientBuilder defaultResponseTimeout(Duration responseTimeout)

Deprecated.

Sets the timeout of a response.

Parameters:

responseTimeout - the timeout. 0 disables the timeout.

defaultResponseTimeoutMillis

@Deprecated
public WebClientBuilder defaultResponseTimeoutMillis(long responseTimeoutMillis)

Deprecated.

Sets the timeout of a response in milliseconds.

Parameters:

responseTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.

responseTimeout

public WebClientBuilder responseTimeout(Duration responseTimeout)

Sets the timeout of a response.

Parameters:

responseTimeout - the timeout. 0 disables the timeout.

responseTimeoutMillis

public WebClientBuilder responseTimeoutMillis(long responseTimeoutMillis)

Sets the timeout of a response in milliseconds.

Parameters:

responseTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.

defaultMaxResponseLength

@Deprecated
public WebClientBuilder defaultMaxResponseLength(long maxResponseLength)

Deprecated.

Sets the maximum allowed length of a server response in bytes.

Parameters:

maxResponseLength - the maximum length in bytes. 0 disables the limit.

maxResponseLength

public WebClientBuilder maxResponseLength(long maxResponseLength)

Sets the maximum allowed length of a server response in bytes.

Parameters:

maxResponseLength - the maximum length in bytes. 0 disables the limit.

requestIdGenerator

public WebClientBuilder requestIdGenerator(Supplier<RequestId> requestIdGenerator)

Sets the Supplier that generates a RequestId.

endpointRemapper

public WebClientBuilder endpointRemapper(Function<? super Endpoint,? extends EndpointGroup> endpointRemapper)

Sets a Function that remaps an Endpoint into an EndpointGroup. This ClientOption is useful when you need to override a single target host into a group of hosts to enable client-side load-balancing, e.g.

 MyService.Iface client =
     Clients.newClient("tbinary+http://example.com/api",
                       MyService.Iface.class);

 EndpointGroup myGroup = EndpointGroup.of(Endpoint.of("node-1.example.com")),
                                          Endpoint.of("node-2.example.com")));

 MyService.Iface derivedClient =
     Clients.newDerivedClient(client, options -> {
         return options.toBuilder()
                       .endpointRemapper(endpoint -> {
                           if (endpoint.host().equals("example.com")) {
                               return myGroup;
                           } else {
                               return endpoint;
                           }
                       })
                       .build();
     });

 // This request goes to 'node-1.example.com' or 'node-2.example.com'.
 derivedClient.call();
 

Note that the remapping does not occur recursively but only once.

See Also:

ClientOption.ENDPOINT_REMAPPER, ClientOptions.endpointRemapper()

decorator

public WebClientBuilder decorator(Function<? super HttpClient,? extends HttpClient> decorator)

Adds the specified HTTP-level decorator.

Parameters:

decorator - the Function that transforms an HttpClient to another

decorator

public WebClientBuilder decorator(DecoratingHttpClientFunction decorator)

Adds the specified HTTP-level decorator.

Parameters:

decorator - the DecoratingHttpClientFunction that intercepts an invocation

addHttpHeader

public WebClientBuilder addHttpHeader(CharSequence name,
                                      Object value)

Adds the specified HTTP header.

addHttpHeaders

public WebClientBuilder addHttpHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> httpHeaders)

Adds the specified HTTP headers.

setHttpHeader

public WebClientBuilder setHttpHeader(CharSequence name,
                                      Object value)

Sets the specified HTTP header.

setHttpHeaders

public WebClientBuilder setHttpHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> httpHeaders)

Sets the specified HTTP headers.