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 and Description
static WebClientBuilder	builder() Returns a new WebClientBuilder created without a base URI.
static WebClientBuilder	builder(SessionProtocol sessionProtocol, EndpointGroup endpointGroup) Returns a new WebClientBuilder created with the specified SessionProtocol and base EndpointGroup.
static WebClientBuilder	builder(String uri) Returns a new WebClientBuilder created with the specified base uri.
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.
HttpResponse	execute(AggregatedHttpRequest aggregatedReq) Sends the specified HTTP request.
HttpResponse	execute(HttpRequest req) Sends the specified HTTP request.
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	head(String path) Sends an HTTP HEAD request.
static WebClient	of() Returns a WebClient without a base URI using the default ClientFactory and the default ClientOptions.
static WebClient	of(ClientFactory factory, SessionProtocol protocol, EndpointGroup endpointGroup, ClientOptions options) Deprecated. Use builder(SessionProtocol, EndpointGroup), WebClientBuilder.factory(ClientFactory) and WebClientBuilder.options(ClientOptions).
static WebClient	of(ClientFactory factory, SessionProtocol protocol, EndpointGroup endpointGroup, ClientOptionValue<?>... options) Deprecated. Use builder(SessionProtocol, EndpointGroup), WebClientBuilder.factory(ClientFactory) and WebClientBuilder.options(ClientOptionValue[]).
static WebClient	of(ClientFactory factory, String uri, ClientOptions options) Deprecated. Use builder(String), WebClientBuilder.factory(ClientFactory) and WebClientBuilder.options(ClientOptions).
static WebClient	of(ClientFactory factory, String uri, ClientOptionValue<?>... options) Deprecated. Use builder(String), WebClientBuilder.factory(ClientFactory) and WebClientBuilder.options(ClientOptionValue[]).
static WebClient	of(ClientFactory factory, URI uri, ClientOptions options) Deprecated. Use builder(URI), WebClientBuilder.factory(ClientFactory) and WebClientBuilder.options(ClientOptions).
static WebClient	of(ClientFactory factory, URI uri, ClientOptionValue<?>... options) Deprecated. Use builder(URI), WebClientBuilder.factory(ClientFactory) and WebClientBuilder.options(ClientOptionValue[]).
static WebClient	of(SessionProtocol protocol, EndpointGroup endpointGroup) Returns a new WebClient that connects to the specified EndpointGroup with the SessionProtocol using the default ClientFactory and the default ClientOptions.
static WebClient	of(SessionProtocol protocol, EndpointGroup endpointGroup, ClientOptions options) Deprecated. Use builder(SessionProtocol, EndpointGroup) and WebClientBuilder.options(ClientOptions).
static WebClient	of(SessionProtocol protocol, EndpointGroup endpointGroup, ClientOptionValue<?>... options) Deprecated. Use builder(SessionProtocol, EndpointGroup) and WebClientBuilder.options(ClientOptionValue[]).
static WebClient	of(String uri) Returns a new WebClient that connects to the specified uri using the default options.
static WebClient	of(String uri, ClientOptions options) Deprecated. Use builder(String) and WebClientBuilder.options(ClientOptions).
static WebClient	of(String uri, ClientOptionValue<?>... options) Deprecated. Use builder(String) and WebClientBuilder.option(ClientOptionValue).
static WebClient	of(URI uri) Returns a new WebClient that connects to the specified URI using the default options.
static WebClient	of(URI uri, ClientOptions options) Deprecated. Use builder(URI) and WebClientBuilder.options(ClientOptions).
static WebClient	of(URI uri, ClientOptionValue<?>... options) Deprecated. Use builder(URI) and WebClientBuilder.options(ClientOptionValue[]).
default HttpResponse	options(String path) Sends an HTTP OPTIONS request.
default HttpResponse	patch(String path, byte[] content) Sends an HTTP PATCH request with the specified content.
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, 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 HttpResponse	put(String path, byte[] content) Sends an HTTP PUT request with the specified content.
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.

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

absolutePathRef, clientType, endpointGroup, factory, of, of, options, scheme, uri

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

as

Method Detail

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 scheme of the specified uri is not an HTTP scheme

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 scheme of the specified URI is not an HTTP scheme

of

static WebClient of(SessionProtocol protocol,
                    EndpointGroup endpointGroup)

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

Parameters:

protocol - the SessionProtocol of the EndpointGroup

endpointGroup - the server EndpointGroup

of

@Deprecated
static WebClient of(String uri,
                                ClientOptionValue<?>... options)

Deprecated. Use builder(String) and WebClientBuilder.option(ClientOptionValue).

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

Parameters:

uri - the URI of the server endpoint

options - the ClientOptionValues

Throws:

IllegalArgumentException - if the scheme of the specified uri is not an HTTP scheme

of

@Deprecated
static WebClient of(String uri,
                                ClientOptions options)

Deprecated. Use builder(String) and WebClientBuilder.options(ClientOptions).

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

Parameters:

uri - the URI of the server endpoint

options - the ClientOptions

Throws:

IllegalArgumentException - if the scheme of the specified uri is not an HTTP scheme

of

@Deprecated
static WebClient of(ClientFactory factory,
                                String uri,
                                ClientOptionValue<?>... options)

Deprecated. Use builder(String), WebClientBuilder.factory(ClientFactory) and WebClientBuilder.options(ClientOptionValue[]).

Returns a new WebClient that connects to the specified uri using an alternative ClientFactory.

Parameters:

factory - an alternative ClientFactory

uri - the URI of the server endpoint

options - the ClientOptionValues

Throws:

IllegalArgumentException - if the scheme of the specified uri is not an HTTP scheme

of

@Deprecated
static WebClient of(ClientFactory factory,
                                String uri,
                                ClientOptions options)

Deprecated. Use builder(String), WebClientBuilder.factory(ClientFactory) and WebClientBuilder.options(ClientOptions).

Returns a new WebClient that connects to the specified uri using an alternative ClientFactory.

Parameters:

factory - an alternative ClientFactory

uri - the URI of the server endpoint

options - the ClientOptions

Throws:

IllegalArgumentException - if the scheme of the specified uri is not an HTTP scheme

of

@Deprecated
static WebClient of(URI uri,
                                ClientOptionValue<?>... options)

Deprecated. Use builder(URI) and WebClientBuilder.options(ClientOptionValue[]).

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

Parameters:

uri - the URI of the server endpoint

options - the ClientOptionValues

Throws:

IllegalArgumentException - if the scheme of the specified uri is not an HTTP scheme

of

@Deprecated
static WebClient of(URI uri,
                                ClientOptions options)

Deprecated. Use builder(URI) and WebClientBuilder.options(ClientOptions).

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

Parameters:

uri - the URI of the server endpoint

options - the ClientOptions

Throws:

IllegalArgumentException - if the scheme of the specified uri is not an HTTP scheme

of

@Deprecated
static WebClient of(ClientFactory factory,
                                URI uri,
                                ClientOptionValue<?>... options)

Deprecated. Use builder(URI), WebClientBuilder.factory(ClientFactory) and WebClientBuilder.options(ClientOptionValue[]).

Returns a new WebClient that connects to the specified URI using an alternative ClientFactory.

Parameters:

factory - an alternative ClientFactory

uri - the URI of the server endpoint

options - the ClientOptionValues

Throws:

IllegalArgumentException - if the scheme of the specified uri is not an HTTP scheme

of

@Deprecated
static WebClient of(ClientFactory factory,
                                URI uri,
                                ClientOptions options)

Deprecated. Use builder(URI), WebClientBuilder.factory(ClientFactory) and WebClientBuilder.options(ClientOptions).

Returns a new WebClient that connects to the specified URI using an alternative ClientFactory.

Parameters:

factory - an alternative ClientFactory

uri - the URI of the server endpoint

options - the ClientOptions

Throws:

IllegalArgumentException - if the scheme of the specified uri is not an HTTP scheme

of

@Deprecated
static WebClient of(SessionProtocol protocol,
                                EndpointGroup endpointGroup,
                                ClientOptionValue<?>... options)

Deprecated. Use builder(SessionProtocol, EndpointGroup) and WebClientBuilder.options(ClientOptionValue[]).

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

Parameters:

protocol - the SessionProtocol of the EndpointGroup

endpointGroup - the server EndpointGroup

options - the ClientOptionValues

of

@Deprecated
static WebClient of(SessionProtocol protocol,
                                EndpointGroup endpointGroup,
                                ClientOptions options)

Deprecated. Use builder(SessionProtocol, EndpointGroup) and WebClientBuilder.options(ClientOptions).

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

Parameters:

protocol - the SessionProtocol of the EndpointGroup

endpointGroup - the server EndpointGroup

options - the ClientOptions

of

@Deprecated
static WebClient of(ClientFactory factory,
                                SessionProtocol protocol,
                                EndpointGroup endpointGroup,
                                ClientOptionValue<?>... options)

Deprecated. Use builder(SessionProtocol, EndpointGroup), WebClientBuilder.factory(ClientFactory) and WebClientBuilder.options(ClientOptionValue[]).

Returns a new WebClient that connects to the specified EndpointGroup with the SessionProtocol using an alternative ClientFactory.

Parameters:

factory - an alternative ClientFactory

protocol - the SessionProtocol of the EndpointGroup

endpointGroup - the server EndpointGroup

options - the ClientOptionValues

of

@Deprecated
static WebClient of(ClientFactory factory,
                                SessionProtocol protocol,
                                EndpointGroup endpointGroup,
                                ClientOptions options)

Deprecated. Use builder(SessionProtocol, EndpointGroup), WebClientBuilder.factory(ClientFactory) and WebClientBuilder.options(ClientOptions).

Returns a new WebClient that connects to the specified EndpointGroup with the SessionProtocol using an alternative ClientFactory.

Parameters:

factory - an alternative ClientFactory

protocol - the SessionProtocol of the EndpointGroup

endpointGroup - the server EndpointGroup

options - the ClientOptions

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 scheme of the uri is not one of the fields in SessionProtocol or the uri violates RFC 2396

builder

static WebClientBuilder builder(URI uri)

Returns a new WebClientBuilder created with the specified base URI.

Throws:

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

builder

static WebClientBuilder builder(SessionProtocol sessionProtocol,
                                EndpointGroup endpointGroup)

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

Throws:

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

execute

HttpResponse execute(HttpRequest req)

Sends the specified HTTP request.

execute

HttpResponse execute(AggregatedHttpRequest aggregatedReq)

Sends the specified HTTP request.

execute

default HttpResponse execute(RequestHeaders headers)

Sends an empty HTTP request with the specified headers.

execute

default HttpResponse execute(RequestHeaders headers,
                             HttpData content)

Sends an HTTP request with the specified headers and content.

execute

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

Sends an HTTP request with the specified headers and content.

execute

default HttpResponse execute(RequestHeaders headers,
                             String content)

Sends an HTTP request with the specified headers and content.

execute

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

Sends an HTTP request with the specified headers and content.

options

default HttpResponse options(String path)

Sends an HTTP OPTIONS request.

get

default HttpResponse get(String path)

Sends an HTTP GET request.

head

default HttpResponse head(String path)

Sends an HTTP HEAD request.

post

default HttpResponse post(String path,
                          HttpData content)

Sends an HTTP POST request with the specified content.

post

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

Sends an HTTP POST request with the specified content.

post

default HttpResponse post(String path,
                          String content)

Sends an HTTP POST request with the specified content.

post

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

Sends an HTTP POST request with the specified content.

put

default HttpResponse put(String path,
                         HttpData content)

Sends an HTTP PUT request with the specified content.

put

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

Sends an HTTP PUT request with the specified content.

put

default HttpResponse put(String path,
                         String content)

Sends an HTTP PUT request with the specified content.

put

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

Sends an HTTP PUT request with the specified content.

patch

default HttpResponse patch(String path,
                           HttpData content)

Sends an HTTP PATCH request with the specified content.

patch

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

Sends an HTTP PATCH request with the specified content.

patch

default HttpResponse patch(String path,
                           String content)

Sends an HTTP PATCH request with the specified content.

patch

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

Sends an HTTP PATCH request with the specified content.

delete

default HttpResponse delete(String path)

Sends an HTTP DELETE request.

trace

default HttpResponse trace(String path)

Sends an HTTP TRACE request.