Package com.linecorp.armeria.client

Class AbstractWebClientBuilder

java.lang.Object

com.linecorp.armeria.client.AbstractClientOptionsBuilder

com.linecorp.armeria.client.AbstractWebClientBuilder

Direct Known Subclasses:

EurekaEndpointGroupBuilder, EurekaUpdatingListenerBuilder, RestClientBuilder, WebClientBuilder

public abstract class AbstractWebClientBuilder
extends AbstractClientOptionsBuilder

A skeletal builder implementation for WebClient.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractWebClientBuilder()	Creates a new instance.
protected	AbstractWebClientBuilder(SessionProtocol sessionProtocol, EndpointGroup endpointGroup, @Nullable String path)	Creates a new instance.
protected	AbstractWebClientBuilder(URI uri)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected final WebClient	buildWebClient()	Returns a newly-created web client based on the properties of this builder.
protected final ClientBuilderParams	clientBuilderParams(ClientOptions options)	Returns a newly-created ClientBuilderParams with the specified ClientOptions.
AbstractWebClientBuilder	rpcDecorator(DecoratingRpcClientFunction decorator)	Deprecated. RPC decorator cannot be added to the web client builder.
AbstractWebClientBuilder	rpcDecorator(Function<? super RpcClient,? extends RpcClient> decorator)	Deprecated. RPC decorator cannot be added to the web client builder.

Methods inherited from class com.linecorp.armeria.client.AbstractClientOptionsBuilder

addHeader, addHeaders, auth, auth, auth, auth, buildOptions, buildOptions, clearDecorators, contextCustomizer, decorator, decorator, endpointRemapper, factory, followRedirects, followRedirects, maxResponseLength, option, option, options, options, options, requestIdGenerator, responseTimeout, responseTimeoutMillis, setHeader, setHeaders, successFunction, writeTimeout, writeTimeoutMillis

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractWebClientBuilder

protected AbstractWebClientBuilder()

Creates a new instance.

AbstractWebClientBuilder

protected AbstractWebClientBuilder(URI uri)

Creates a new instance.

Throws:

IllegalArgumentException - if the scheme of the uri is not one of the fields in SessionProtocol

AbstractWebClientBuilder

protected AbstractWebClientBuilder(SessionProtocol sessionProtocol,
 EndpointGroup endpointGroup,
 @Nullable
 @Nullable String path)

Creates a new instance.

Throws:

IllegalArgumentException - if the sessionProtocol is not one of the fields in SessionProtocol

Method Details

buildWebClient

protected final WebClient buildWebClient()

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

clientBuilderParams

protected final ClientBuilderParams clientBuilderParams(ClientOptions options)

Returns a newly-created ClientBuilderParams with the specified ClientOptions.

Throws:

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

rpcDecorator

@Deprecated
public AbstractWebClientBuilder rpcDecorator(Function<? super RpcClient,? extends RpcClient> decorator)

Deprecated.

RPC decorator cannot be added to the web client builder.

Raises an UnsupportedOperationException because this builder doesn't support RPC-level but only HTTP-level decorators.

Overrides:

rpcDecorator in class AbstractClientOptionsBuilder

Parameters:

decorator - the Function that transforms an RpcClient to another

rpcDecorator

@Deprecated
public AbstractWebClientBuilder rpcDecorator(DecoratingRpcClientFunction decorator)

Deprecated.

RPC decorator cannot be added to the web client builder.

Raises an UnsupportedOperationException because this builder doesn't support RPC-level but only HTTP-level decorators.

Overrides:

rpcDecorator in class AbstractClientOptionsBuilder

Parameters:

decorator - the DecoratingRpcClientFunction that intercepts an invocation