Package com.linecorp.armeria.client

Interface WebClient

All Superinterfaces:

ClientBuilderParams, Unwrappable

public interface WebClient
extends ClientBuilderParams, Unwrappable

An asynchronous web client.

Method Summary

Modifier and Type	Method	Description
BlockingWebClient	blocking()	Returns a BlockingWebClient that connects to the same URI with this WebClient.
static WebClientBuilder	builder()	Returns a new WebClientBuilder created without a base URI.
static WebClientBuilder	builder(SessionProtocol protocol, EndpointGroup endpointGroup)	Returns a new WebClientBuilder created with the specified SessionProtocol and base EndpointGroup.
static WebClientBuilder	builder(SessionProtocol protocol, EndpointGroup endpointGroup, String path)	Returns a new WebClientBuilder created with the specified SessionProtocol, base EndpointGroup and path.
static WebClientBuilder	builder(String uri)	Returns a new WebClientBuilder created with the specified base uri.
static WebClientBuilder	builder(String protocol, EndpointGroup endpointGroup)	Returns a new WebClientBuilder created with the specified protocol and base EndpointGroup.
static WebClientBuilder	builder(String protocol, EndpointGroup endpointGroup, String path)	Returns a new WebClientBuilder created with the specified protocol.
static WebClientBuilder	builder(URI uri)	Returns a new WebClientBuilder created with the specified base URI.
default HttpResponse	delete(String path)	Sends an HTTP DELETE request.
default HttpResponse	delete(String path, @Nullable QueryParams params)	Sends an HTTP DELETE request, appending the given query parameters to the path.
default HttpResponse	execute(AggregatedHttpRequest aggregatedReq)	Sends the specified HTTP request.
default HttpResponse	execute(HttpRequest req)	Sends the specified HTTP request.
HttpResponse	execute(HttpRequest req, RequestOptions options)	Sends the specified HTTP request with the specified RequestOptions.
default HttpResponse	execute(RequestHeaders headers)	Sends an empty HTTP request with the specified headers.
default HttpResponse	execute(RequestHeaders headers, byte[] content)	Sends an HTTP request with the specified headers and content.
default HttpResponse	execute(RequestHeaders headers, HttpData content)	Sends an HTTP request with the specified headers and content.
default HttpResponse	execute(RequestHeaders headers, String content)	Sends an HTTP request with the specified headers and content.
default HttpResponse	execute(RequestHeaders headers, String content, Charset charset)	Sends an HTTP request with the specified headers and content.
default HttpResponse	get(String path)	Sends an HTTP GET request.
default HttpResponse	get(String path, @Nullable QueryParams params)	Sends an HTTP GET request, appending the given query parameters to the path.
default HttpResponse	head(String path)	Sends an HTTP HEAD request.
default HttpResponse	head(String path, @Nullable QueryParams params)	Sends an HTTP HEAD request, appending the given query parameters to the path.
static WebClient	of()	Returns a WebClient without a base URI using the default ClientFactory and the default ClientOptions.
static WebClient	of(SessionProtocol protocol, EndpointGroup endpointGroup)	Returns a new WebClient that connects to the specified EndpointGroup with the specified SessionProtocol using the default ClientFactory and the default ClientOptions.
static WebClient	of(SessionProtocol protocol, EndpointGroup endpointGroup, String path)	Returns a new WebClient that connects to the specified EndpointGroup with the specified SessionProtocol and path using the default ClientFactory and the default ClientOptions.
static WebClient	of(String uri)	Returns a new WebClient that connects to the specified uri using the default options.
static WebClient	of(String protocol, EndpointGroup endpointGroup)	Returns a new WebClient that connects to the specified EndpointGroup with the specified protocol using the default ClientFactory and the default ClientOptions.
static WebClient	of(String protocol, EndpointGroup endpointGroup, String path)	Returns a new WebClient that connects to the specified EndpointGroup with the specified protocol and path using the default ClientFactory and the default ClientOptions.
static WebClient	of(URI uri)	Returns a new WebClient that connects to the specified URI using the default options.
default HttpResponse	options(String path)	Sends an HTTP OPTIONS request.
default HttpResponse	options(String path, @Nullable QueryParams params)	Sends an HTTP OPTIONS request, appending the given query parameters to the path.
default HttpResponse	patch(String path, byte[] content)	Sends an HTTP PATCH request with the specified content.
default HttpResponse	patch(String path, @Nullable QueryParams params, byte[] content)	Sends an HTTP PATCH request with the specified content, appending the given query parameters to the path.
default HttpResponse	patch(String path, @Nullable QueryParams params, HttpData content)	Sends an HTTP PATCH request with the specified content by appending the provided query params to the path.
default HttpResponse	patch(String path, @Nullable QueryParams params, String content)	Sends an HTTP PATCH request with the specified content, appending the given query parameters to the path.
default HttpResponse	patch(String path, @Nullable QueryParams params, String content, Charset charset)	Sends an HTTP PATCH request with the specified content, appending the given query parameters to the path.
default HttpResponse	patch(String path, HttpData content)	Sends an HTTP PATCH request with the specified content.
default HttpResponse	patch(String path, String content)	Sends an HTTP PATCH request with the specified content.
default HttpResponse	patch(String path, String content, Charset charset)	Sends an HTTP PATCH request with the specified content.
default HttpResponse	post(String path, byte[] content)	Sends an HTTP POST request with the specified content.
default HttpResponse	post(String path, @Nullable QueryParams params, byte[] content)	Sends an HTTP POST request with the specified content, appending the given query parameters to the path.
default HttpResponse	post(String path, @Nullable QueryParams params, HttpData content)	Sends an HTTP POST request with the specified content, appending the given query parameters to the path.
default HttpResponse	post(String path, @Nullable QueryParams params, String content)	Sends an HTTP POST request with the specified content, appending the given query parameters to the path.
default HttpResponse	post(String path, @Nullable QueryParams params, String content, Charset charset)	Sends an HTTP POST request with the specified content, appending the given query parameters to the path.
default HttpResponse	post(String path, HttpData content)	Sends an HTTP POST request with the specified content.
default HttpResponse	post(String path, String content)	Sends an HTTP POST request with the specified content.
default HttpResponse	post(String path, String content, Charset charset)	Sends an HTTP POST request with the specified content.
default WebClientRequestPreparation	prepare()	Prepares to send an HttpRequest using fluent builder.
default HttpResponse	put(String path, byte[] content)	Sends an HTTP PUT request with the specified content.
default HttpResponse	put(String path, @Nullable QueryParams params, byte[] content)	Sends an HTTP PUT request with the specified content, appending the given query parameters to the path.
default HttpResponse	put(String path, @Nullable QueryParams params, HttpData content)	Sends an HTTP PUT request with the specified content, appending the given query parameters to the path.
default HttpResponse	put(String path, @Nullable QueryParams params, String content)	Sends an HTTP PUT request with the specified content, appending the given query parameters to the path.
default HttpResponse	put(String path, @Nullable QueryParams params, String content, Charset charset)	Sends an HTTP PUT request with the specified content, appending the given query parameters to the path.
default HttpResponse	put(String path, HttpData content)	Sends an HTTP PUT request with the specified content.
default HttpResponse	put(String path, String content)	Sends an HTTP PUT request with the specified content.
default HttpResponse	put(String path, String content, Charset charset)	Sends an HTTP PUT request with the specified content.
default HttpResponse	trace(String path)	Sends an HTTP TRACE request.
default HttpResponse	trace(String path, @Nullable QueryParams params)	Sends an HTTP TRACE request, appending the given query parameters to the path.
HttpClient	unwrap()	Unwraps this object and returns the object being decorated.

Methods inherited from interface com.linecorp.armeria.client.ClientBuilderParams

absolutePathRef, clientType, endpointGroup, options, scheme, uri

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

as

Method Details

of

static WebClient of()

Returns a WebClient without a base URI using the default ClientFactory and the default ClientOptions.

of

static WebClient of(String uri)

Returns a new WebClient that connects to the specified uri using the default options.

Parameters:

uri - the URI of the server endpoint

Throws:

IllegalArgumentException - if the uri is not valid or its scheme is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

of

static WebClient of(URI uri)

Returns a new WebClient that connects to the specified URI using the default options.

Parameters:

uri - the URI of the server endpoint

Throws:

IllegalArgumentException - if the uri is not valid or its scheme is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

of

static WebClient of(String protocol,
 EndpointGroup endpointGroup)

Returns a new WebClient that connects to the specified EndpointGroup with the specified protocol using the default ClientFactory and the default ClientOptions.

Parameters:

protocol - the session protocol of the EndpointGroup

endpointGroup - the server EndpointGroup

Throws:

IllegalArgumentException - if the protocol is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

of

static WebClient of(SessionProtocol protocol,
 EndpointGroup endpointGroup)

Returns a new WebClient that connects to the specified EndpointGroup with the specified SessionProtocol using the default ClientFactory and the default ClientOptions.

Parameters:

protocol - the SessionProtocol of the EndpointGroup

endpointGroup - the server EndpointGroup

Throws:

IllegalArgumentException - if the protocol is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

of

static WebClient of(String protocol,
 EndpointGroup endpointGroup,
 String path)

Returns a new WebClient that connects to the specified EndpointGroup with the specified protocol and path using the default ClientFactory and the default ClientOptions.

Parameters:

protocol - the session protocol of the EndpointGroup

endpointGroup - the server EndpointGroup

path - the path to the endpoint

Throws:

IllegalArgumentException - if the protocol is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

of

static WebClient of(SessionProtocol protocol,
 EndpointGroup endpointGroup,
 String path)

Returns a new WebClient that connects to the specified EndpointGroup with the specified SessionProtocol and path using the default ClientFactory and the default ClientOptions.

Parameters:

protocol - the SessionProtocol of the EndpointGroup

endpointGroup - the server EndpointGroup

path - the path to the endpoint

Throws:

IllegalArgumentException - if the protocol is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

builder

static WebClientBuilder builder()

Returns a new WebClientBuilder created without a base URI.

builder

static WebClientBuilder builder(String uri)

Returns a new WebClientBuilder created with the specified base uri.

Throws:

IllegalArgumentException - if the uri is not valid or its scheme is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

builder

static WebClientBuilder builder(URI uri)

Returns a new WebClientBuilder created with the specified base URI.

Throws:

IllegalArgumentException - if the uri is not valid or its scheme is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

builder

static WebClientBuilder builder(String protocol,
 EndpointGroup endpointGroup)

Returns a new WebClientBuilder created with the specified protocol and base EndpointGroup.

Throws:

IllegalArgumentException - if the protocol is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

builder

static WebClientBuilder builder(SessionProtocol protocol,
 EndpointGroup endpointGroup)

Returns a new WebClientBuilder created with the specified SessionProtocol and base EndpointGroup.

Throws:

IllegalArgumentException - if the protocol is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

builder

static WebClientBuilder builder(String protocol,
 EndpointGroup endpointGroup,
 String path)

Returns a new WebClientBuilder created with the specified protocol. base EndpointGroup and path.

Throws:

IllegalArgumentException - if the protocol is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

builder

static WebClientBuilder builder(SessionProtocol protocol,
 EndpointGroup endpointGroup,
 String path)

Returns a new WebClientBuilder created with the specified SessionProtocol, base EndpointGroup and path.

Throws:

IllegalArgumentException - if the protocol is not one of the values in SessionProtocol.httpValues() or SessionProtocol.httpsValues().

execute

@CheckReturnValue
default HttpResponse execute(HttpRequest req)

Sends the specified HTTP request.

execute

@CheckReturnValue
HttpResponse execute(HttpRequest req,
 RequestOptions options)

Sends the specified HTTP request with the specified RequestOptions.

execute

@CheckReturnValue
default HttpResponse execute(AggregatedHttpRequest aggregatedReq)

Sends the specified HTTP request.

execute

@CheckReturnValue
default HttpResponse execute(RequestHeaders headers)

Sends an empty HTTP request with the specified headers.

execute

@CheckReturnValue
default HttpResponse execute(RequestHeaders headers,
 HttpData content)

Sends an HTTP request with the specified headers and content.

execute

@CheckReturnValue
default HttpResponse execute(RequestHeaders headers,
 byte[] content)

Sends an HTTP request with the specified headers and content.

execute

@CheckReturnValue
default HttpResponse execute(RequestHeaders headers,
 String content)

Sends an HTTP request with the specified headers and content.

execute

@CheckReturnValue
default HttpResponse execute(RequestHeaders headers,
 String content,
 Charset charset)

Sends an HTTP request with the specified headers and content.

prepare

default WebClientRequestPreparation prepare()

Prepares to send an HttpRequest using fluent builder.

 WebClient client = WebClient.of(...);
 HttpResponse response = client.prepare()
                               .post("/foo")
                               .header(HttpHeaderNames.AUTHORIZATION, ...)
                               .content(MediaType.JSON, ...)
                               .execute();
 

options

@CheckReturnValue
default HttpResponse options(String path)

Sends an HTTP OPTIONS request.

options

@CheckReturnValue
default HttpResponse options(String path,
 @Nullable
 @Nullable QueryParams params)

Sends an HTTP OPTIONS request, appending the given query parameters to the path.

get

@CheckReturnValue
default HttpResponse get(String path)

Sends an HTTP GET request.

get

@CheckReturnValue
default HttpResponse get(String path,
 @Nullable
 @Nullable QueryParams params)

Sends an HTTP GET request, appending the given query parameters to the path.

head

@CheckReturnValue
default HttpResponse head(String path)

Sends an HTTP HEAD request.

head

@CheckReturnValue
default HttpResponse head(String path,
 @Nullable
 @Nullable QueryParams params)

Sends an HTTP HEAD request, appending the given query parameters to the path.

post

@CheckReturnValue
default HttpResponse post(String path,
 HttpData content)

Sends an HTTP POST request with the specified content.

post

@CheckReturnValue
default HttpResponse post(String path,
 @Nullable
 @Nullable QueryParams params,
 HttpData content)

Sends an HTTP POST request with the specified content, appending the given query parameters to the path.

post

@CheckReturnValue
default HttpResponse post(String path,
 byte[] content)

Sends an HTTP POST request with the specified content.

post

@CheckReturnValue
default HttpResponse post(String path,
 @Nullable
 @Nullable QueryParams params,
 byte[] content)

Sends an HTTP POST request with the specified content, appending the given query parameters to the path.

post

@CheckReturnValue
default HttpResponse post(String path,
 String content)

Sends an HTTP POST request with the specified content.

post

@CheckReturnValue
default HttpResponse post(String path,
 @Nullable
 @Nullable QueryParams params,
 String content)

Sends an HTTP POST request with the specified content, appending the given query parameters to the path.

post

@CheckReturnValue
default HttpResponse post(String path,
 String content,
 Charset charset)

Sends an HTTP POST request with the specified content.

post

@CheckReturnValue
default HttpResponse post(String path,
 @Nullable
 @Nullable QueryParams params,
 String content,
 Charset charset)

Sends an HTTP POST request with the specified content, appending the given query parameters to the path.

put

@CheckReturnValue
default HttpResponse put(String path,
 HttpData content)

Sends an HTTP PUT request with the specified content.

put

@CheckReturnValue
default HttpResponse put(String path,
 @Nullable
 @Nullable QueryParams params,
 HttpData content)

Sends an HTTP PUT request with the specified content, appending the given query parameters to the path.

put

@CheckReturnValue
default HttpResponse put(String path,
 byte[] content)

Sends an HTTP PUT request with the specified content.

put

@CheckReturnValue
default HttpResponse put(String path,
 @Nullable
 @Nullable QueryParams params,
 byte[] content)

Sends an HTTP PUT request with the specified content, appending the given query parameters to the path.

put

@CheckReturnValue
default HttpResponse put(String path,
 String content)

Sends an HTTP PUT request with the specified content.

put

@CheckReturnValue
default HttpResponse put(String path,
 @Nullable
 @Nullable QueryParams params,
 String content)

Sends an HTTP PUT request with the specified content, appending the given query parameters to the path.

put

@CheckReturnValue
default HttpResponse put(String path,
 String content,
 Charset charset)

Sends an HTTP PUT request with the specified content.

put

@CheckReturnValue
default HttpResponse put(String path,
 @Nullable
 @Nullable QueryParams params,
 String content,
 Charset charset)

Sends an HTTP PUT request with the specified content, appending the given query parameters to the path.

patch

@CheckReturnValue
default HttpResponse patch(String path,
 HttpData content)

Sends an HTTP PATCH request with the specified content.

patch

@CheckReturnValue
default HttpResponse patch(String path,
 @Nullable
 @Nullable QueryParams params,
 HttpData content)

Sends an HTTP PATCH request with the specified content by appending the provided query params to the path.

patch

@CheckReturnValue
default HttpResponse patch(String path,
 byte[] content)

Sends an HTTP PATCH request with the specified content.

patch

@CheckReturnValue
default HttpResponse patch(String path,
 @Nullable
 @Nullable QueryParams params,
 byte[] content)

Sends an HTTP PATCH request with the specified content, appending the given query parameters to the path.

patch

@CheckReturnValue
default HttpResponse patch(String path,
 String content)

Sends an HTTP PATCH request with the specified content.

patch

@CheckReturnValue
default HttpResponse patch(String path,
 @Nullable
 @Nullable QueryParams params,
 String content)

Sends an HTTP PATCH request with the specified content, appending the given query parameters to the path.

patch

@CheckReturnValue
default HttpResponse patch(String path,
 String content,
 Charset charset)

Sends an HTTP PATCH request with the specified content.

patch

@CheckReturnValue
default HttpResponse patch(String path,
 @Nullable
 @Nullable QueryParams params,
 String content,
 Charset charset)

Sends an HTTP PATCH request with the specified content, appending the given query parameters to the path.

delete

@CheckReturnValue
default HttpResponse delete(String path)

Sends an HTTP DELETE request.

delete

@CheckReturnValue
default HttpResponse delete(String path,
 @Nullable
 @Nullable QueryParams params)

Sends an HTTP DELETE request, appending the given query parameters to the path.

trace

@CheckReturnValue
default HttpResponse trace(String path)

Sends an HTTP TRACE request.

trace

@CheckReturnValue
default HttpResponse trace(String path,
 @Nullable
 @Nullable QueryParams params)

Sends an HTTP TRACE request, appending the given query parameters to the path.

blocking

@UnstableApi
BlockingWebClient blocking()

Returns a BlockingWebClient that connects to the same URI with this WebClient.

Note that you should never use the BlockingWebClient in an EventLoop thread. Use it from a non-EventLoop thread such as BlockingTaskExecutor.

unwrap

HttpClient unwrap()

Description copied from interface: Unwrappable

Unwraps this object and returns the object being decorated. If this Unwrappable is the innermost object, this method returns itself. For example:

 class Foo implements Unwrappable {}

 class Bar<T extends Unwrappable> extends AbstractUnwrappable<T> {
     Bar(T delegate) {
         super(delegate);
     }
 }

 class Qux<T extends Unwrappable> extends AbstractUnwrappable<T> {
     Qux(T delegate) {
         super(delegate);
     }
 }

 Foo foo = new Foo();
 assert foo.unwrap() == foo;

 Bar<Foo> bar = new Bar<>(foo);
 assert bar.unwrap() == foo;

 Qux<Bar<Foo>> qux = new Qux<>(bar);
 assert qux.unwrap() == bar;
 assert qux.unwrap().unwrap() == foo;
 

Specified by:

unwrap in interface Unwrappable