Package com.linecorp.armeria.client

Class BlockingWebClientRequestPreparation

java.lang.Object

com.linecorp.armeria.client.BlockingWebClientRequestPreparation

All Implemented Interfaces:

HttpRequestSetters

@UnstableApi
public final class BlockingWebClientRequestPreparation
extends Object

Prepares and executes a new HttpRequest for BlockingWebClient.

Method Summary

Modifier and Type	Method	Description
<U> TransformingRequestPreparation<AggregatedHttpResponse,U>	as(ResponseAs<AggregatedHttpResponse,U> responseAs)	Sets the specified ResponseAs that converts the AggregatedHttpResponse into another.
TransformingRequestPreparation<AggregatedHttpResponse,ResponseEntity<byte[]>>	asBytes()	Converts the response content into bytes.
<T> TransformingRequestPreparation<AggregatedHttpResponse,ResponseEntity<T>>	asJson(TypeReference<? extends T> typeRef)	Deserializes the JSON response content into the specified Java type using the default ObjectMapper.
<T> TransformingRequestPreparation<AggregatedHttpResponse,ResponseEntity<T>>	asJson(TypeReference<? extends T> typeRef, ObjectMapper mapper)	Deserializes the JSON response content into the specified Java type using the specified ObjectMapper.
<T> TransformingRequestPreparation<AggregatedHttpResponse,ResponseEntity<T>>	asJson(Class<? extends T> clazz)	Deserializes the JSON response content into the specified non-container type using the default ObjectMapper.
<T> TransformingRequestPreparation<AggregatedHttpResponse,ResponseEntity<T>>	asJson(Class<? extends T> clazz, ObjectMapper mapper)	Deserializes the JSON response content into the specified non-container type using the specified ObjectMapper.
TransformingRequestPreparation<AggregatedHttpResponse,ResponseEntity<String>>	asString()	Converts the response content into String.
<V> BlockingWebClientRequestPreparation	attr(AttributeKey<V> key, V value)
BlockingWebClientRequestPreparation	content(MediaType contentType, byte[] content)	Sets the content for this request.
BlockingWebClientRequestPreparation	content(MediaType contentType, HttpData content)	Sets the content for this request.
BlockingWebClientRequestPreparation	content(MediaType contentType, CharSequence content)	Sets the content for this request.
BlockingWebClientRequestPreparation	content(MediaType contentType, String content)	Sets the content for this request.
BlockingWebClientRequestPreparation	content(MediaType contentType, String format, Object... content)	Sets the content for this request.
BlockingWebClientRequestPreparation	content(MediaType contentType, org.reactivestreams.Publisher<? extends HttpData> content)	Sets the Publisher for this request.
BlockingWebClientRequestPreparation	content(String content)	Sets the content as UTF_8 for this request.
BlockingWebClientRequestPreparation	content(String format, Object... content)	Sets the content as UTF_8 for this request.
BlockingWebClientRequestPreparation	contentJson(Object content)	Sets the content for this request.
BlockingWebClientRequestPreparation	cookie(Cookie cookie)	Sets a cookie for this request.
BlockingWebClientRequestPreparation	cookies(Iterable<? extends Cookie> cookies)	Sets multiple cookies for this request.
BlockingWebClientRequestPreparation	delete(String path)	Shortcut to set DELETE method and path.
BlockingWebClientRequestPreparation	disablePathParams()	Disables path parameters substitution.
AggregatedHttpResponse	execute()	Builds and executes the blocking request.
BlockingWebClientRequestPreparation	get(String path)	Shortcut to set GET method and path.
BlockingWebClientRequestPreparation	head(String path)	Shortcut to set HEAD method and path.
BlockingWebClientRequestPreparation	header(CharSequence name, Object value)	Adds a header for this request.
BlockingWebClientRequestPreparation	headers(Iterable<? extends Map.Entry<? extends CharSequence,String>> headers)	Adds multiple headers for this request.
BlockingWebClientRequestPreparation	maxResponseLength(long maxResponseLength)
BlockingWebClientRequestPreparation	method(HttpMethod method)	Sets the method for this request.
BlockingWebClientRequestPreparation	options(String path)	Shortcut to set OPTIONS method and path.
BlockingWebClientRequestPreparation	patch(String path)	Shortcut to set PATCH method and path.
BlockingWebClientRequestPreparation	path(String path)	Sets the path for this request.
BlockingWebClientRequestPreparation	pathParam(String name, Object value)	Sets a path param for this request.
BlockingWebClientRequestPreparation	pathParams(Map<String,?> pathParams)	Sets multiple path params for this request.
BlockingWebClientRequestPreparation	post(String path)	Shortcut to set POST method and path.
BlockingWebClientRequestPreparation	put(String path)	Shortcut to set PUT method and path.
BlockingWebClientRequestPreparation	queryParam(String name, Object value)	Adds a query param for this request.
BlockingWebClientRequestPreparation	queryParams(Iterable<? extends Map.Entry<? extends String,String>> queryParams)	Adds multiple query params for this request.
BlockingWebClientRequestPreparation	requestOptions(RequestOptions requestOptions)
BlockingWebClientRequestPreparation	responseTimeout(Duration responseTimeout)
BlockingWebClientRequestPreparation	responseTimeoutMillis(long responseTimeoutMillis)
BlockingWebClientRequestPreparation	trace(String path)	Shortcut to set TRACE method and path.
BlockingWebClientRequestPreparation	trailers(Iterable<? extends Map.Entry<? extends CharSequence,String>> trailers)	Sets HTTP trailers for this request.
BlockingWebClientRequestPreparation	writeTimeout(Duration writeTimeout)
BlockingWebClientRequestPreparation	writeTimeoutMillis(long writeTimeoutMillis)

Methods inherited from class java.lang.Object

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

Method Details

execute

public AggregatedHttpResponse execute()

Builds and executes the blocking request.

as

@UnstableApi
public <U>
TransformingRequestPreparation<AggregatedHttpResponse,U> as(ResponseAs<AggregatedHttpResponse,U> responseAs)

Sets the specified ResponseAs that converts the AggregatedHttpResponse into another.

asBytes

@UnstableApi
public TransformingRequestPreparation<AggregatedHttpResponse,ResponseEntity<byte[]>> asBytes()

Converts the response content into bytes. For example:

 BlockingWebClient client = BlockingWebClient.of("https://api.example.com");
 ResponseEntity<byte[]> response = client.prepare()
                                         .get("/v1/items/1")
                                         .asBytes()
                                         .execute();
 

asString

@UnstableApi
public TransformingRequestPreparation<AggregatedHttpResponse,ResponseEntity<String>> asString()

Converts the response content into String. For example:

 BlockingWebClient client = BlockingWebClient.of("https://api.example.com");
 ResponseEntity<String> response = client.prepare()
                                         .get("/v1/items/1")
                                         .asString()
                                         .execute();
 

asJson

@UnstableApi
public <T>
TransformingRequestPreparation<AggregatedHttpResponse,ResponseEntity<T>> asJson(Class<? extends T> clazz)

Deserializes the JSON response content into the specified non-container type using the default ObjectMapper. For example:

 BlockingWebClient client = BlockingWebClient.of("https://api.example.com");
 ResponseEntity<MyObject> response = client.prepare()
                                           .get("/v1/items/1")
                                           .asJson(MyObject.class)
                                           .execute();
 

Note that this method should NOT be used if the result type is a container such as Collection or Map. Use asJson(TypeReference) for the container type.

Throws:

InvalidHttpResponseException - if the HttpStatus of the response is not success or fails to decode the response body into the result type.

See Also:

• JacksonObjectMapperProvider

asJson

@UnstableApi
public <T>
TransformingRequestPreparation<AggregatedHttpResponse,ResponseEntity<T>> asJson(Class<? extends T> clazz,
 ObjectMapper mapper)

Deserializes the JSON response content into the specified non-container type using the specified ObjectMapper. For example:

 ObjectMapper mapper = ...;
 BlockingWebClient client = BlockingWebClient.of("https://api.example.com");
 ResponseEntity<MyObject> response = client.prepare()
                                           .get("/v1/items/1")
                                           .asJson(MyObject.class, mapper)
                                           .execute();
 

Note that this method should NOT be used if the result type is a container such as Collection or Map. Use asJson(TypeReference, ObjectMapper) for the container type.

Throws:

InvalidHttpResponseException - if the HttpStatus of the response is not success or fails to decode the response body into the result type.

asJson

@UnstableApi
public <T>
TransformingRequestPreparation<AggregatedHttpResponse,ResponseEntity<T>> asJson(TypeReference<? extends T> typeRef)

Deserializes the JSON response content into the specified Java type using the default ObjectMapper. This method is useful when you want to deserialize the content into a container type such as List and Map. For example:

 BlockingWebClient client = BlockingWebClient.of("https://api.example.com");
 ResponseEntity<List<MyObject>> response =
     client.prepare()
           .get("/v1/items/1")
           .asJson(new TypeReference<List<MyObject>>() {})
           .execute();
 

Throws:

InvalidHttpResponseException - if the HttpStatus of the response is not success or fails to decode the response body into the result type.

See Also:

• JacksonObjectMapperProvider

asJson

@UnstableApi
public <T>
TransformingRequestPreparation<AggregatedHttpResponse,ResponseEntity<T>> asJson(TypeReference<? extends T> typeRef,
 ObjectMapper mapper)

Deserializes the JSON response content into the specified Java type using the specified ObjectMapper. For example:

 ObjectMapper mapper = ...;
 BlockingWebClient client = BlockingWebClient.of("https://api.example.com");
 ResponseEntity<List<MyObject>> response =
     client.prepare()
           .get("/v1/items/1")
           .asJson(new TypeReference<List<MyObject>>() {}, mapper)
           .execute();
 

Throws:

InvalidHttpResponseException - if the HttpStatus of the response is not success or fails to decode the response body into the result type.

requestOptions

public BlockingWebClientRequestPreparation requestOptions(RequestOptions requestOptions)

get

public BlockingWebClientRequestPreparation get(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set GET method and path.

Specified by:

get in interface HttpRequestSetters

post

public BlockingWebClientRequestPreparation post(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set POST method and path.

Specified by:

post in interface HttpRequestSetters

put

public BlockingWebClientRequestPreparation put(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set PUT method and path.

Specified by:

put in interface HttpRequestSetters

delete

public BlockingWebClientRequestPreparation delete(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set DELETE method and path.

Specified by:

delete in interface HttpRequestSetters

patch

public BlockingWebClientRequestPreparation patch(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set PATCH method and path.

Specified by:

patch in interface HttpRequestSetters

options

public BlockingWebClientRequestPreparation options(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set OPTIONS method and path.

Specified by:

options in interface HttpRequestSetters

head

public BlockingWebClientRequestPreparation head(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set HEAD method and path.

Specified by:

head in interface HttpRequestSetters

trace

public BlockingWebClientRequestPreparation trace(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set TRACE method and path.

Specified by:

trace in interface HttpRequestSetters

method

public BlockingWebClientRequestPreparation method(HttpMethod method)

Description copied from interface: HttpRequestSetters

Sets the method for this request.

Specified by:

method in interface HttpRequestSetters

See Also:

• HttpMethod

path

public BlockingWebClientRequestPreparation path(String path)

Description copied from interface: HttpRequestSetters

Sets the path for this request.

Specified by:

path in interface HttpRequestSetters

content

public BlockingWebClientRequestPreparation content(String content)

Description copied from interface: HttpRequestSetters

Sets the content as UTF_8 for this request.

Specified by:

content in interface HttpRequestSetters

content

public BlockingWebClientRequestPreparation content(MediaType contentType,
 CharSequence content)

Description copied from interface: HttpRequestSetters

Sets the content for this request.

Specified by:

content in interface HttpRequestSetters

content

public BlockingWebClientRequestPreparation content(MediaType contentType,
 String content)

Description copied from interface: HttpRequestSetters

Sets the content for this request.

Specified by:

content in interface HttpRequestSetters

content

@FormatMethod
public BlockingWebClientRequestPreparation content(@FormatString
 String format,
 Object... content)

Description copied from interface: HttpRequestSetters

Sets the content as UTF_8 for this request. The content is formatted by String.format(Locale, String, Object...) with English locale.

Specified by:

content in interface HttpRequestSetters

content

@FormatMethod
public BlockingWebClientRequestPreparation content(MediaType contentType,
 @FormatString
 String format,
 Object... content)

Description copied from interface: HttpRequestSetters

Sets the content for this request. The content is formatted by String.format(Locale, String, Object...) with English locale.

Specified by:

content in interface HttpRequestSetters

content

public BlockingWebClientRequestPreparation content(MediaType contentType,
 byte[] content)

Description copied from interface: HttpRequestSetters

Sets the content for this request. The content will be wrapped using HttpData.wrap(byte[]), so any changes made to content will be reflected in the request.

Specified by:

content in interface HttpRequestSetters

content

public BlockingWebClientRequestPreparation content(MediaType contentType,
 HttpData content)

Description copied from interface: HttpRequestSetters

Sets the content for this request.

Specified by:

content in interface HttpRequestSetters

content

public BlockingWebClientRequestPreparation content(MediaType contentType,
 org.reactivestreams.Publisher<? extends HttpData> content)

Description copied from interface: HttpRequestSetters

Sets the Publisher for this request.

Specified by:

content in interface HttpRequestSetters

contentJson

public BlockingWebClientRequestPreparation contentJson(Object content)

Description copied from interface: HttpRequestSetters

Sets the content for this request. The content is converted into JSON format using the default ObjectMapper.

Specified by:

contentJson in interface HttpRequestSetters

header

public BlockingWebClientRequestPreparation header(CharSequence name,
 Object value)

Description copied from interface: HttpRequestSetters

Adds a header for this request. For example:

 HttpRequest.builder()
            .get("/")
            .header("authorization", "foo")
            .build();
 

Specified by:

header in interface HttpRequestSetters

headers

public BlockingWebClientRequestPreparation headers(Iterable<? extends Map.Entry<? extends CharSequence,String>> headers)

Description copied from interface: HttpRequestSetters

Adds multiple headers for this request. For example:

 HttpRequest.builder()
            .get("/")
            .headers(HttpHeaders.of("authorization", "foo", "bar", "baz"))
            .build();
 

Specified by:

headers in interface HttpRequestSetters

See Also:

• HttpHeaders

trailers

public BlockingWebClientRequestPreparation trailers(Iterable<? extends Map.Entry<? extends CharSequence,String>> trailers)

Description copied from interface: HttpRequestSetters

Sets HTTP trailers for this request.

Specified by:

trailers in interface HttpRequestSetters

pathParam

public BlockingWebClientRequestPreparation pathParam(String name,
 Object value)

Description copied from interface: HttpRequestSetters

Sets a path param for this request. For example:

 HttpRequest.builder()
            .get("/{foo}")
            .pathParam("foo", "bar")
            .build(); // GET `/bar`
 

Specified by:

pathParam in interface HttpRequestSetters

pathParams

public BlockingWebClientRequestPreparation pathParams(Map<String,?> pathParams)

Description copied from interface: HttpRequestSetters

Sets multiple path params for this request. For example:

 HttpRequest.builder()
            .get("/{foo}/:bar")
            .pathParams(Map.of("foo", 1, "bar", 2))
            .build(); // GET `/1/2`
 

Specified by:

pathParams in interface HttpRequestSetters

disablePathParams

public BlockingWebClientRequestPreparation disablePathParams()

Description copied from interface: HttpRequestSetters

Disables path parameters substitution. If path parameter is not disabled and a parameter's, specified using {} or :, value is not found, an IllegalStateException is thrown.

Specified by:

disablePathParams in interface HttpRequestSetters

queryParam

public BlockingWebClientRequestPreparation queryParam(String name,
 Object value)

Description copied from interface: HttpRequestSetters

Adds a query param for this request. For example:

 HttpRequest.builder()
            .get("/endpoint")
            .queryParam("foo", "bar")
            .build(); // GET `/endpoint?foo=bar`
 

Specified by:

queryParam in interface HttpRequestSetters

queryParams

public BlockingWebClientRequestPreparation queryParams(Iterable<? extends Map.Entry<? extends String,String>> queryParams)

Description copied from interface: HttpRequestSetters

Adds multiple query params for this request. For example:

 HttpRequest.builder()
            .get("/endpoint")
            .queryParams(QueryParams.of("from", "foo", "limit", 10))
            .build(); // GET `/endpoint?from=foo&limit=10`
 

Specified by:

queryParams in interface HttpRequestSetters

See Also:

• QueryParams

cookie

public BlockingWebClientRequestPreparation cookie(Cookie cookie)

Description copied from interface: HttpRequestSetters

Sets a cookie for this request. For example:

 HttpRequest.builder()
            .get("/")
            .cookie(Cookie.ofSecure("cookie", "foo"))
            .build();
 

Specified by:

cookie in interface HttpRequestSetters

See Also:

• Cookie

cookies

public BlockingWebClientRequestPreparation cookies(Iterable<? extends Cookie> cookies)

Description copied from interface: HttpRequestSetters

Sets multiple cookies for this request. For example:

 HttpRequest.builder()
            .get("/")
            .cookies(Cookies.ofSecure(Cookie.ofSecure("cookie1", "foo"),
                                      Cookie.ofSecure("cookie2", "bar")))
            .build();
 

Specified by:

cookies in interface HttpRequestSetters

See Also:

• Cookies

responseTimeout

public BlockingWebClientRequestPreparation responseTimeout(Duration responseTimeout)

responseTimeoutMillis

public BlockingWebClientRequestPreparation responseTimeoutMillis(long responseTimeoutMillis)

writeTimeout

public BlockingWebClientRequestPreparation writeTimeout(Duration writeTimeout)

writeTimeoutMillis

public BlockingWebClientRequestPreparation writeTimeoutMillis(long writeTimeoutMillis)

maxResponseLength

public BlockingWebClientRequestPreparation maxResponseLength(long maxResponseLength)

attr

public <V> BlockingWebClientRequestPreparation attr(AttributeKey<V> key,
 @Nullable
 V value)