Package com.linecorp.armeria.client

Class TransformingRequestPreparation<T,R>

java.lang.Object

com.linecorp.armeria.client.TransformingRequestPreparation<T,R>

All Implemented Interfaces:

HttpRequestSetters

@UnstableApi
public class TransformingRequestPreparation<T,R>
extends Object

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

Method Summary

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

requestOptions

public TransformingRequestPreparation<T,R> requestOptions(RequestOptions requestOptions)

as

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

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

get

public TransformingRequestPreparation<T,R> get(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set GET method and path.

Specified by:

get in interface HttpRequestSetters

post

public TransformingRequestPreparation<T,R> post(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set POST method and path.

Specified by:

post in interface HttpRequestSetters

put

public TransformingRequestPreparation<T,R> put(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set PUT method and path.

Specified by:

put in interface HttpRequestSetters

delete

public TransformingRequestPreparation<T,R> delete(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set DELETE method and path.

Specified by:

delete in interface HttpRequestSetters

patch

public TransformingRequestPreparation<T,R> patch(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set PATCH method and path.

Specified by:

patch in interface HttpRequestSetters

options

public TransformingRequestPreparation<T,R> options(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set OPTIONS method and path.

Specified by:

options in interface HttpRequestSetters

head

public TransformingRequestPreparation<T,R> head(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set HEAD method and path.

Specified by:

head in interface HttpRequestSetters

trace

public TransformingRequestPreparation<T,R> trace(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set TRACE method and path.

Specified by:

trace in interface HttpRequestSetters

method

public TransformingRequestPreparation<T,R> 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 TransformingRequestPreparation<T,R> path(String path)

Description copied from interface: HttpRequestSetters

Sets the path for this request.

Specified by:

path in interface HttpRequestSetters

content

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

Description copied from interface: HttpRequestSetters

Sets the content for this request.

Specified by:

content in interface HttpRequestSetters

content

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

Description copied from interface: HttpRequestSetters

Sets the content for this request.

Specified by:

content in interface HttpRequestSetters

content

public TransformingRequestPreparation<T,R> 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 TransformingRequestPreparation<T,R> 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 TransformingRequestPreparation<T,R> 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 TransformingRequestPreparation<T,R> 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 TransformingRequestPreparation<T,R> 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 TransformingRequestPreparation<T,R> 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 TransformingRequestPreparation<T,R> 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 TransformingRequestPreparation<T,R> 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 TransformingRequestPreparation<T,R> queryParam(String name,
 Object value)

Description copied from interface: HttpRequestSetters

Sets 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 TransformingRequestPreparation<T,R> queryParams(Iterable<? extends Map.Entry<? extends String,String>> queryParams)

Description copied from interface: HttpRequestSetters

Sets 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 TransformingRequestPreparation<T,R> 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 TransformingRequestPreparation<T,R> 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 TransformingRequestPreparation<T,R> responseTimeout(Duration responseTimeout)

responseTimeoutMillis

public TransformingRequestPreparation<T,R> responseTimeoutMillis(long responseTimeoutMillis)

writeTimeout

public TransformingRequestPreparation<T,R> writeTimeout(Duration writeTimeout)

writeTimeoutMillis

public TransformingRequestPreparation<T,R> writeTimeoutMillis(long writeTimeoutMillis)

maxResponseLength

public TransformingRequestPreparation<T,R> maxResponseLength(long maxResponseLength)

attr

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