Package com.linecorp.armeria.client

Interface BlockingWebClient

All Superinterfaces:

ClientBuilderParams, Unwrappable

@UnstableApi
public interface BlockingWebClient
extends ClientBuilderParams, Unwrappable

A blocking web client that waits for an HttpResponse to be fully aggregated. If you want to create a BlockingWebClient with various options, create a WebClient first and convert it into a BlockingWebClient via WebClient.blocking().

 BlockingWebClient client =
     WebClient.builder("https://api.example.com")
              .responseTimeout(Duration.ofSeconds(10))
              .decorator(LoggingClient.newDecorator())
              ...
              .build()
              .blocking();
 

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

Method Summary

Modifier and Type	Method	Description
default AggregatedHttpResponse	delete(String path)	Sends an HTTP DELETE request.
default AggregatedHttpResponse	delete(String path, @Nullable QueryParams params)	Sends an HTTP DELETE request, appending the given query parameters to the path.
default AggregatedHttpResponse	execute(AggregatedHttpRequest aggregatedReq)	Sends the specified HTTP request.
default AggregatedHttpResponse	execute(HttpRequest req)	Sends the specified HTTP request.
AggregatedHttpResponse	execute(HttpRequest req, RequestOptions options)	Sends the specified HTTP request with the specified RequestOptions.
default AggregatedHttpResponse	execute(RequestHeaders headers)	Sends an empty HTTP request with the specified headers.
default AggregatedHttpResponse	execute(RequestHeaders headers, byte[] content)	Sends an HTTP request with the specified headers and content.
default AggregatedHttpResponse	execute(RequestHeaders headers, HttpData content)	Sends an HTTP request with the specified headers and content.
default AggregatedHttpResponse	execute(RequestHeaders headers, String content)	Sends an HTTP request with the specified headers and content.
default AggregatedHttpResponse	execute(RequestHeaders headers, String content, Charset charset)	Sends an HTTP request with the specified headers and content.
default AggregatedHttpResponse	get(String path)	Sends an HTTP GET request.
default AggregatedHttpResponse	get(String path, @Nullable QueryParams params)	Sends an HTTP GET request, appending the given query parameters to the path.
default AggregatedHttpResponse	head(String path)	Sends an HTTP HEAD request.
default AggregatedHttpResponse	head(String path, @Nullable QueryParams params)	Sends an HTTP HEAD request, appending the given query parameters to the path.
static BlockingWebClient	of()	Returns a BlockingWebClient without a base URI using the default ClientFactory and the default ClientOptions.
static BlockingWebClient	of(String uri)	Returns a new BlockingWebClient that connects to the specified uri using the default options.
static BlockingWebClient	of(URI uri)	Returns a new BlockingWebClient that connects to the specified URI using the default options.
default AggregatedHttpResponse	options(String path)	Sends an HTTP OPTIONS request.
default AggregatedHttpResponse	options(String path, @Nullable QueryParams params)	Sends an HTTP OPTIONS request, appending the given query parameters to the path.
default AggregatedHttpResponse	patch(String path, byte[] content)	Sends an HTTP PATCH request with the specified content.
default AggregatedHttpResponse	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 AggregatedHttpResponse	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 AggregatedHttpResponse	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 AggregatedHttpResponse	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 AggregatedHttpResponse	patch(String path, HttpData content)	Sends an HTTP PATCH request with the specified content.
default AggregatedHttpResponse	patch(String path, String content)	Sends an HTTP PATCH request with the specified content.
default AggregatedHttpResponse	patch(String path, String content, Charset charset)	Sends an HTTP PATCH request with the specified content.
default AggregatedHttpResponse	post(String path, byte[] content)	Sends an HTTP POST request with the specified content.
default AggregatedHttpResponse	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 AggregatedHttpResponse	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 AggregatedHttpResponse	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 AggregatedHttpResponse	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 AggregatedHttpResponse	post(String path, HttpData content)	Sends an HTTP POST request with the specified content.
default AggregatedHttpResponse	post(String path, String content)	Sends an HTTP POST request with the specified content.
default AggregatedHttpResponse	post(String path, String content, Charset charset)	Sends an HTTP POST request with the specified content.
BlockingWebClientRequestPreparation	prepare()	Prepares to send an HttpRequest using fluent builder.
default AggregatedHttpResponse	put(String path, byte[] content)	Sends an HTTP PUT request with the specified content.
default AggregatedHttpResponse	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 AggregatedHttpResponse	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 AggregatedHttpResponse	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 AggregatedHttpResponse	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 AggregatedHttpResponse	put(String path, HttpData content)	Sends an HTTP PUT request with the specified content.
default AggregatedHttpResponse	put(String path, String content)	Sends an HTTP PUT request with the specified content.
default AggregatedHttpResponse	put(String path, String content, Charset charset)	Sends an HTTP PUT request with the specified content.
default AggregatedHttpResponse	trace(String path)	Sends an HTTP TRACE request.
default AggregatedHttpResponse	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, equalsIgnoreWrapper, unwrapAll

Method Details

of

@UnstableApi
static BlockingWebClient of()

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

of

@UnstableApi
static BlockingWebClient of(String uri)

Returns a new BlockingWebClient 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

@UnstableApi
static BlockingWebClient of(URI uri)

Returns a new BlockingWebClient 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().

execute

default AggregatedHttpResponse execute(HttpRequest req)

Sends the specified HTTP request.

execute

AggregatedHttpResponse execute(HttpRequest req,
 RequestOptions options)

Sends the specified HTTP request with the specified RequestOptions.

execute

default AggregatedHttpResponse execute(AggregatedHttpRequest aggregatedReq)

Sends the specified HTTP request.

execute

default AggregatedHttpResponse execute(RequestHeaders headers)

Sends an empty HTTP request with the specified headers.

execute

default AggregatedHttpResponse execute(RequestHeaders headers,
 HttpData content)

Sends an HTTP request with the specified headers and content.

execute

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

Sends an HTTP request with the specified headers and content.

execute

default AggregatedHttpResponse execute(RequestHeaders headers,
 String content)

Sends an HTTP request with the specified headers and content.

execute

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

Sends an HTTP request with the specified headers and content.

prepare

BlockingWebClientRequestPreparation prepare()

Prepares to send an HttpRequest using fluent builder.

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

options

default AggregatedHttpResponse options(String path)

Sends an HTTP OPTIONS request.

options

default AggregatedHttpResponse options(String path,
 @Nullable
 @Nullable QueryParams params)

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

get

default AggregatedHttpResponse get(String path)

Sends an HTTP GET request.

get

default AggregatedHttpResponse get(String path,
 @Nullable
 @Nullable QueryParams params)

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

head

default AggregatedHttpResponse head(String path)

Sends an HTTP HEAD request.

head

default AggregatedHttpResponse head(String path,
 @Nullable
 @Nullable QueryParams params)

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

post

default AggregatedHttpResponse post(String path,
 HttpData content)

Sends an HTTP POST request with the specified content.

post

default AggregatedHttpResponse 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

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

Sends an HTTP POST request with the specified content.

post

default AggregatedHttpResponse 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

default AggregatedHttpResponse post(String path,
 String content)

Sends an HTTP POST request with the specified content.

post

default AggregatedHttpResponse 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

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

Sends an HTTP POST request with the specified content.

post

default AggregatedHttpResponse 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

default AggregatedHttpResponse put(String path,
 HttpData content)

Sends an HTTP PUT request with the specified content.

put

default AggregatedHttpResponse 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

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

Sends an HTTP PUT request with the specified content.

put

default AggregatedHttpResponse 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

default AggregatedHttpResponse put(String path,
 String content)

Sends an HTTP PUT request with the specified content.

put

default AggregatedHttpResponse 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

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

Sends an HTTP PUT request with the specified content.

put

default AggregatedHttpResponse 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

default AggregatedHttpResponse patch(String path,
 HttpData content)

Sends an HTTP PATCH request with the specified content.

patch

default AggregatedHttpResponse 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

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

Sends an HTTP PATCH request with the specified content.

patch

default AggregatedHttpResponse 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

default AggregatedHttpResponse patch(String path,
 String content)

Sends an HTTP PATCH request with the specified content.

patch

default AggregatedHttpResponse 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

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

Sends an HTTP PATCH request with the specified content.

patch

default AggregatedHttpResponse 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

default AggregatedHttpResponse delete(String path)

Sends an HTTP DELETE request.

delete

default AggregatedHttpResponse delete(String path,
 @Nullable
 @Nullable QueryParams params)

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

trace

default AggregatedHttpResponse trace(String path)

Sends an HTTP TRACE request.

trace

default AggregatedHttpResponse trace(String path,
 @Nullable
 @Nullable QueryParams params)

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

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