Package com.linecorp.armeria.client

Class FutureTransformingRequestPreparation<T>

java.lang.Object

com.linecorp.armeria.client.FutureTransformingRequestPreparation<T>

All Implemented Interfaces:

HttpRequestSetters

@UnstableApi
public final class FutureTransformingRequestPreparation<T>
extends Object

Prepares and executes a new HttpRequest for WebClient, and asynchronously transforms an HttpResponse into a T type object.

Method Summary

Modifier and Type	Method	Description
<U> FutureTransformingRequestPreparation<U>	as(ResponseAs<? super T,? extends U> responseAs)	Sets a ResponseAs that converts the T type object into another.
<V> FutureTransformingRequestPreparation<T>	attr(AttributeKey<V> key, V value)
FutureTransformingRequestPreparation<T>	content(MediaType contentType, byte[] content)	Sets the content for this request.
FutureTransformingRequestPreparation<T>	content(MediaType contentType, HttpData content)	Sets the content for this request.
FutureTransformingRequestPreparation<T>	content(MediaType contentType, CharSequence content)	Sets the content for this request.
FutureTransformingRequestPreparation<T>	content(MediaType contentType, String content)	Sets the content for this request.
FutureTransformingRequestPreparation<T>	content(MediaType contentType, String format, Object... content)	Sets the content for this request.
FutureTransformingRequestPreparation<T>	content(MediaType contentType, org.reactivestreams.Publisher<? extends HttpData> content)	Sets the Publisher for this request.
FutureTransformingRequestPreparation<T>	content(String content)	Sets the content as UTF_8 for this request.
FutureTransformingRequestPreparation<T>	content(String format, Object... content)	Sets the content as UTF_8 for this request.
FutureTransformingRequestPreparation<T>	contentJson(Object content)	Sets the content for this request.
FutureTransformingRequestPreparation<T>	cookie(Cookie cookie)	Sets a cookie for this request.
FutureTransformingRequestPreparation<T>	cookies(Iterable<? extends Cookie> cookies)	Sets multiple cookies for this request.
FutureTransformingRequestPreparation<T>	delete(String path)	Shortcut to set DELETE method and path.
FutureTransformingRequestPreparation<T>	disablePathParams()	Disables path parameters substitution.
CompletableFuture<T>	execute()
FutureTransformingRequestPreparation<T>	get(String path)	Shortcut to set GET method and path.
FutureTransformingRequestPreparation<T>	head(String path)	Shortcut to set HEAD method and path.
FutureTransformingRequestPreparation<T>	header(CharSequence name, Object value)	Adds a header for this request.
FutureTransformingRequestPreparation<T>	headers(Iterable<? extends Map.Entry<? extends CharSequence,String>> headers)	Adds multiple headers for this request.
FutureTransformingRequestPreparation<T>	mapError(Function<? super Throwable,? extends @Nullable Throwable> function)	Transforms a Throwable raised while receiving the response by applying the specified Function.
FutureTransformingRequestPreparation<T>	maxResponseLength(long maxResponseLength)
FutureTransformingRequestPreparation<T>	method(HttpMethod method)	Sets the method for this request.
FutureTransformingRequestPreparation<T>	options(String path)	Shortcut to set OPTIONS method and path.
FutureTransformingRequestPreparation<T>	patch(String path)	Shortcut to set PATCH method and path.
FutureTransformingRequestPreparation<T>	path(String path)	Sets the path for this request.
FutureTransformingRequestPreparation<T>	pathParam(String name, Object value)	Sets a path param for this request.
FutureTransformingRequestPreparation<T>	pathParams(Map<String,?> pathParams)	Sets multiple path params for this request.
FutureTransformingRequestPreparation<T>	post(String path)	Shortcut to set POST method and path.
FutureTransformingRequestPreparation<T>	put(String path)	Shortcut to set PUT method and path.
FutureTransformingRequestPreparation<T>	queryParam(String name, Object value)	Adds a query param for this request.
FutureTransformingRequestPreparation<T>	queryParams(Iterable<? extends Map.Entry<? extends String,String>> queryParams)	Adds multiple query params for this request.
FutureTransformingRequestPreparation<T>	recover(Function<? super Throwable,? extends @Nullable T> function)	Recovers a failed HttpResponse by switching to a returned fallback object returned by the function.
FutureTransformingRequestPreparation<T>	requestOptions(RequestOptions requestOptions)
FutureTransformingRequestPreparation<T>	responseTimeout(Duration responseTimeout)
FutureTransformingRequestPreparation<T>	responseTimeoutMillis(long responseTimeoutMillis)
FutureTransformingRequestPreparation<T>	trace(String path)	Shortcut to set TRACE method and path.
FutureTransformingRequestPreparation<T>	trailers(Iterable<? extends Map.Entry<? extends CharSequence,String>> trailers)	Sets HTTP trailers for this request.
FutureTransformingRequestPreparation<T>	writeTimeout(Duration writeTimeout)
FutureTransformingRequestPreparation<T>	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 CompletableFuture<T> execute()

as

@UnstableApi
public <U> FutureTransformingRequestPreparation<U> as(ResponseAs<? super T,? extends U> responseAs)

Sets a ResponseAs that converts the T type object into another.

recover

@UnstableApi
public FutureTransformingRequestPreparation<T> recover(Function<? super Throwable,? extends @Nullable T> function)

Recovers a failed HttpResponse by switching to a returned fallback object returned by the function. If a null value is returned, the cause will not be recovered.

mapError

@UnstableApi
public FutureTransformingRequestPreparation<T> mapError(Function<? super Throwable,? extends @Nullable Throwable> function)

Transforms a Throwable raised while receiving the response by applying the specified Function. If a null value is returned, the original cause will be used as is.

requestOptions

public FutureTransformingRequestPreparation<T> requestOptions(RequestOptions requestOptions)

get

public FutureTransformingRequestPreparation<T> get(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set GET method and path.

Specified by:

get in interface HttpRequestSetters

post

public FutureTransformingRequestPreparation<T> post(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set POST method and path.

Specified by:

post in interface HttpRequestSetters

put

public FutureTransformingRequestPreparation<T> put(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set PUT method and path.

Specified by:

put in interface HttpRequestSetters

delete

public FutureTransformingRequestPreparation<T> delete(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set DELETE method and path.

Specified by:

delete in interface HttpRequestSetters

patch

public FutureTransformingRequestPreparation<T> patch(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set PATCH method and path.

Specified by:

patch in interface HttpRequestSetters

options

public FutureTransformingRequestPreparation<T> options(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set OPTIONS method and path.

Specified by:

options in interface HttpRequestSetters

head

public FutureTransformingRequestPreparation<T> head(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set HEAD method and path.

Specified by:

head in interface HttpRequestSetters

trace

public FutureTransformingRequestPreparation<T> trace(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set TRACE method and path.

Specified by:

trace in interface HttpRequestSetters

method

public FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> path(String path)

Description copied from interface: HttpRequestSetters

Sets the path for this request.

Specified by:

path in interface HttpRequestSetters

content

public FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> content(MediaType contentType,
 CharSequence content)

Description copied from interface: HttpRequestSetters

Sets the content for this request.

Specified by:

content in interface HttpRequestSetters

content

public FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> content(MediaType contentType,
 HttpData content)

Description copied from interface: HttpRequestSetters

Sets the content for this request.

Specified by:

content in interface HttpRequestSetters

content

public FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> 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 FutureTransformingRequestPreparation<T> responseTimeout(Duration responseTimeout)

responseTimeoutMillis

public FutureTransformingRequestPreparation<T> responseTimeoutMillis(long responseTimeoutMillis)

writeTimeout

public FutureTransformingRequestPreparation<T> writeTimeout(Duration writeTimeout)

writeTimeoutMillis

public FutureTransformingRequestPreparation<T> writeTimeoutMillis(long writeTimeoutMillis)

maxResponseLength

public FutureTransformingRequestPreparation<T> maxResponseLength(long maxResponseLength)

attr

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