Package com.linecorp.armeria.client

Class RestClientPreparation

java.lang.Object

com.linecorp.armeria.client.RestClientPreparation

All Implemented Interfaces:

RequestOptionsSetters, RequestPreparationSetters, HttpMessageSetters, PathAndQueryParamSetters

@UnstableApi
public final class RestClientPreparation
extends Object
implements RequestPreparationSetters

Prepares and executes a new HttpRequest for RestClient.

Method Summary

Modifier and Type	Method	Description
<V> RestClientPreparation	attr(AttributeKey<V> key, V value)	Associates the specified value with the given AttributeKey in this request.
RestClientPreparation	content(MediaType contentType, byte[] content)	Sets the content for this message.
RestClientPreparation	content(MediaType contentType, HttpData content)	Sets the content for this message.
RestClientPreparation	content(MediaType contentType, CharSequence content)	Sets the content for this message.
RestClientPreparation	content(MediaType contentType, String content)	Sets the content for this message.
RestClientPreparation	content(MediaType contentType, String format, Object... content)	Sets the content for this message.
RestClientPreparation	content(MediaType contentType, org.reactivestreams.Publisher<? extends HttpData> content)	Sets the Publisher for this message.
RestClientPreparation	content(String content)	Sets the content as UTF-8 for this message.
RestClientPreparation	content(String format, Object... content)	Sets the content as UTF-8 for this message.
RestClientPreparation	content(org.reactivestreams.Publisher<? extends HttpData> content)	Sets the Publisher for this message.
RestClientPreparation	contentJson(Object content)	Sets the content for this message.
RestClientPreparation	cookie(Cookie cookie)	Sets a cookie for this message.
RestClientPreparation	cookies(Iterable<? extends Cookie> cookies)	Sets multiple cookies for this message.
RestClientPreparation	disablePathParams()	Disables path parameters substitution.
RestClientPreparation	exchangeType(ExchangeType exchangeType)	Sets the ExchangeType that determines whether to stream an HttpRequest or HttpResponse.
<T> CompletableFuture<ResponseEntity<T>>	execute(TypeReference<? extends T> typeRef)	Sends the HTTP request and converts the JSON response body as the T object using the default ObjectMapper.
<T> CompletableFuture<ResponseEntity<T>>	execute(TypeReference<? extends T> typeRef, ObjectMapper mapper)	Sends the HTTP request and converts the JSON response body as the T object using the specified ObjectMapper.
<T> T	execute(ResponseAs<HttpResponse,T> responseAs)	Sends the HTTP request and converts the HttpResponse using the ResponseAs.
<T> CompletableFuture<ResponseEntity<T>>	execute(Class<? extends T> clazz)	Sends the HTTP request and converts the JSON response body as the T object using the default ObjectMapper.
<T> CompletableFuture<ResponseEntity<T>>	execute(Class<? extends T> clazz, ObjectMapper mapper)	Sends the HTTP request and converts the JSON response body as the T object using the specified ObjectMapper.
RestClientPreparation	header(CharSequence name, Object value)	Adds a header for this message.
RestClientPreparation	headers(Iterable<? extends Map.Entry<? extends CharSequence,String>> headers)	Adds multiple headers for this message.
RestClientPreparation	maxResponseLength(long maxResponseLength)	Sets the maximum allowed length of a server response in bytes.
RestClientPreparation	pathParam(String name, Object value)	Sets a path param for this message.
RestClientPreparation	pathParams(Map<String,?> pathParams)	Sets multiple path params for this message.
RestClientPreparation	queryParam(String name, Object value)	Adds a query param for this message.
RestClientPreparation	queryParams(Iterable<? extends Map.Entry<? extends String,String>> queryParams)	Adds multiple query params for this message.
RestClientPreparation	requestAutoAbortDelay(Duration delay)	Sets the amount of time to wait before aborting an HttpRequest when its corresponding HttpResponse is complete.
RestClientPreparation	requestAutoAbortDelayMillis(long delayMillis)	Sets the amount of time in millis to wait before aborting an HttpRequest when its corresponding HttpResponse is complete.
RestClientPreparation	requestOptions(RequestOptions requestOptions)	Sets the specified RequestOptions that could overwrite the previously configured values such as RequestOptionsSetters.responseTimeout(Duration), RequestOptionsSetters.writeTimeout(Duration), RequestOptionsSetters.maxResponseLength(long) and RequestOptionsSetters.attr(AttributeKey, Object).
RestClientPreparation	responseTimeout(Duration responseTimeout)	Schedules the response timeout that is triggered when the Response is not fully received within the specified Duration since the Response started or Request was fully sent.
RestClientPreparation	responseTimeoutMillis(long responseTimeoutMillis)	Schedules the response timeout that is triggered when the Response is not fully received within the specified responseTimeoutMillis since the Response started or Request was fully sent.
RestClientPreparation	trailer(CharSequence name, Object value)	Adds an HTTP trailer for this message.
RestClientPreparation	trailers(Iterable<? extends Map.Entry<? extends CharSequence,String>> trailers)	Adds HTTP trailers for this message.
RestClientPreparation	writeTimeout(Duration writeTimeout)	Sets the amount of time allowed until the initial write attempt of the current Request succeeds.
RestClientPreparation	writeTimeoutMillis(long writeTimeoutMillis)	Sets the amount of time allowed until the initial write attempt of the current Request succeeds.

Methods inherited from class java.lang.Object

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

Method Details

execute

public <T> CompletableFuture<ResponseEntity<T>> execute(Class<? extends T> clazz)

Sends the HTTP request and converts the JSON response body as the T object using the default ObjectMapper.

See Also:

• JacksonObjectMapperProvider

execute

public <T> CompletableFuture<ResponseEntity<T>> execute(Class<? extends T> clazz,
 ObjectMapper mapper)

Sends the HTTP request and converts the JSON response body as the T object using the specified ObjectMapper.

execute

public <T> CompletableFuture<ResponseEntity<T>> execute(TypeReference<? extends T> typeRef)

Sends the HTTP request and converts the JSON response body as the T object using the default ObjectMapper.

See Also:

• JacksonObjectMapperProvider

execute

public <T> CompletableFuture<ResponseEntity<T>> execute(TypeReference<? extends T> typeRef,
 ObjectMapper mapper)

Sends the HTTP request and converts the JSON response body as the T object using the specified ObjectMapper.

execute

public <T> T execute(ResponseAs<HttpResponse,T> responseAs)

Sends the HTTP request and converts the HttpResponse using the ResponseAs.

pathParam

public RestClientPreparation pathParam(String name,
 Object value)

Description copied from interface: PathAndQueryParamSetters

Sets a path param for this message.

Specified by:

pathParam in interface PathAndQueryParamSetters

pathParams

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

Description copied from interface: PathAndQueryParamSetters

Sets multiple path params for this message.

Specified by:

pathParams in interface PathAndQueryParamSetters

disablePathParams

public RestClientPreparation disablePathParams()

Description copied from interface: PathAndQueryParamSetters

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

Specified by:

disablePathParams in interface PathAndQueryParamSetters

queryParam

public RestClientPreparation queryParam(String name,
 Object value)

Description copied from interface: PathAndQueryParamSetters

Adds a query param for this message.

Specified by:

queryParam in interface PathAndQueryParamSetters

queryParams

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

Description copied from interface: PathAndQueryParamSetters

Adds multiple query params for this message.

Specified by:

queryParams in interface PathAndQueryParamSetters

content

public RestClientPreparation content(String content)

Description copied from interface: HttpMessageSetters

Sets the content as UTF-8 for this message.

Specified by:

content in interface HttpMessageSetters

content

public RestClientPreparation content(MediaType contentType,
 CharSequence content)

Description copied from interface: HttpMessageSetters

Sets the content for this message.

Specified by:

content in interface HttpMessageSetters

content

public RestClientPreparation content(MediaType contentType,
 String content)

Description copied from interface: HttpMessageSetters

Sets the content for this message.

Specified by:

content in interface HttpMessageSetters

content

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

Description copied from interface: HttpMessageSetters

Sets the content as UTF-8 for this message. The content is formatted by String.format(Locale, String, Object...) with English locale.

Specified by:

content in interface HttpMessageSetters

content

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

Description copied from interface: HttpMessageSetters

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

Specified by:

content in interface HttpMessageSetters

content

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

Description copied from interface: HttpMessageSetters

Sets the content for this message. 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 HttpMessageSetters

content

public RestClientPreparation content(MediaType contentType,
 HttpData content)

Description copied from interface: HttpMessageSetters

Sets the content for this message.

Specified by:

content in interface HttpMessageSetters

content

public RestClientPreparation content(org.reactivestreams.Publisher<? extends HttpData> content)

Description copied from interface: HttpMessageSetters

Sets the Publisher for this message.

Specified by:

content in interface HttpMessageSetters

content

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

Description copied from interface: HttpMessageSetters

Sets the Publisher for this message.

Specified by:

content in interface HttpMessageSetters

contentJson

public RestClientPreparation contentJson(Object content)

Description copied from interface: HttpMessageSetters

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

Specified by:

contentJson in interface HttpMessageSetters

header

public RestClientPreparation header(CharSequence name,
 Object value)

Description copied from interface: HttpMessageSetters

Adds a header for this message.

Specified by:

header in interface HttpMessageSetters

headers

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

Description copied from interface: HttpMessageSetters

Adds multiple headers for this message.

Specified by:

headers in interface HttpMessageSetters

See Also:

• HttpHeaders

trailer

public RestClientPreparation trailer(CharSequence name,
 Object value)

Description copied from interface: HttpMessageSetters

Adds an HTTP trailer for this message.

Specified by:

trailer in interface HttpMessageSetters

trailers

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

Description copied from interface: HttpMessageSetters

Adds HTTP trailers for this message.

Specified by:

trailers in interface HttpMessageSetters

cookie

public RestClientPreparation cookie(Cookie cookie)

Description copied from interface: HttpMessageSetters

Sets a cookie for this message.

Specified by:

cookie in interface HttpMessageSetters

See Also:

• Cookie

cookies

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

Description copied from interface: HttpMessageSetters

Sets multiple cookies for this message.

Specified by:

cookies in interface HttpMessageSetters

See Also:

• Cookies

responseTimeout

public RestClientPreparation responseTimeout(Duration responseTimeout)

Description copied from interface: RequestOptionsSetters

Schedules the response timeout that is triggered when the Response is not fully received within the specified Duration since the Response started or Request was fully sent. Duration.ZERO disables the limit.

Specified by:

responseTimeout in interface RequestOptionsSetters

responseTimeoutMillis

public RestClientPreparation responseTimeoutMillis(long responseTimeoutMillis)

Description copied from interface: RequestOptionsSetters

Schedules the response timeout that is triggered when the Response is not fully received within the specified responseTimeoutMillis since the Response started or Request was fully sent. 0 disables the limit.

Specified by:

responseTimeoutMillis in interface RequestOptionsSetters

writeTimeout

public RestClientPreparation writeTimeout(Duration writeTimeout)

Description copied from interface: RequestOptionsSetters

Sets the amount of time allowed until the initial write attempt of the current Request succeeds. Duration.ZERO disables the limit.

Specified by:

writeTimeout in interface RequestOptionsSetters

writeTimeoutMillis

public RestClientPreparation writeTimeoutMillis(long writeTimeoutMillis)

Description copied from interface: RequestOptionsSetters

Sets the amount of time allowed until the initial write attempt of the current Request succeeds. 0 disables the limit.

Specified by:

writeTimeoutMillis in interface RequestOptionsSetters

maxResponseLength

public RestClientPreparation maxResponseLength(long maxResponseLength)

Description copied from interface: RequestOptionsSetters

Sets the maximum allowed length of a server response in bytes. 0 disables the limit.

Specified by:

maxResponseLength in interface RequestOptionsSetters

requestAutoAbortDelay

public RestClientPreparation requestAutoAbortDelay(Duration delay)

Description copied from interface: RequestOptionsSetters

Sets the amount of time to wait before aborting an HttpRequest when its corresponding HttpResponse is complete. This may be useful when you want to send additional data even after the response is complete. Specify Duration.ZERO to abort the HttpRequest immediately. Any negative value will not abort the request automatically. There is no delay by default.

Specified by:

requestAutoAbortDelay in interface RequestOptionsSetters

requestAutoAbortDelayMillis

public RestClientPreparation requestAutoAbortDelayMillis(long delayMillis)

Description copied from interface: RequestOptionsSetters

Sets the amount of time in millis to wait before aborting an HttpRequest when its corresponding HttpResponse is complete. This may be useful when you want to send additional data even after the response is complete. Specify 0 to abort the HttpRequest immediately. Any negative value will not abort the request automatically. There is no delay by default.

Specified by:

requestAutoAbortDelayMillis in interface RequestOptionsSetters

attr

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

Description copied from interface: RequestOptionsSetters

Associates the specified value with the given AttributeKey in this request. If this context previously contained a mapping for the AttributeKey, the old value is replaced by the specified value.

Specified by:

attr in interface RequestOptionsSetters

exchangeType

public RestClientPreparation exchangeType(ExchangeType exchangeType)

Description copied from interface: RequestOptionsSetters

Sets the ExchangeType that determines whether to stream an HttpRequest or HttpResponse. Note that an HttpRequest will be aggregated before being written if ExchangeType.UNARY or ExchangeType.RESPONSE_STREAMING is set. If unspecified, the Clients try to infer a proper ExchangeType depending on the content type of a request and a response. Here are examples:

WebClient

 WebClient client = WebClient.of("https://armeria.dev");

 try (ClientRequestContextCaptor captor = Clients.newContextCaptor()) {
     client.prepare()
           .post("/api/v1/items")
           .contentJson(new Item(...)) // A non-streaming request type.
           .asString()                 // A non-streaming response type.
           .execute();
     assert captor.get().exchangeType() == ExchangeType.UNARY;
 }

 try (ClientRequestContextCaptor captor = Clients.newContextCaptor()) {
     client.get("/api/v1/items")   // A non-streaming request type.
           .aggregate();           // A return type is not specified; Assuming that response streaming
                                   // is enabled.
     assert captor.get().exchangeType() == ExchangeType.RESPONSE_STREAMING;
 }

 try (ClientRequestContextCaptor captor = Clients.newContextCaptor()) {
     client.prepare()
           .post("/api/v1/items")
           .content(MediaType.JSON_LINES, StreamMessage.of(...)) // A streaming request type.
           .asFile(Path.get("/path/to/destination"))             // A streaming response type.
           .execute();
     assert captor.get().exchangeType() == ExchangeType.BIDI_STREAMING;
 }
 

BlockingWebClient

Since a request and a response of BlockingWebClient are fully aggregated, ExchangeType.UNARY is only supported.

 try (ClientRequestContextCaptor captor = Clients.newContextCaptor()) {
     AggregatedHttpResponse response = client.blocking().get("/api/v1/items");
     assert captor.get().exchangeType() == ExchangeType.UNARY;
 }
 

gRPC clients

An ExchangeType is automatically inferred from the io.grpc.MethodDescriptor.MethodType.

 try (ClientRequestContextCaptor captor = Clients.newContextCaptor()) {
     Response response = grpcClient.unaryCall(...);
     assert captor.get().exchangeType() == ExchangeType.UNARY;
 }
 

Thrift clients

Thrift protocols do not support streaming. ExchangeType.UNARY is only supported.

Specified by:

exchangeType in interface RequestOptionsSetters

requestOptions

public RestClientPreparation requestOptions(RequestOptions requestOptions)

Description copied from interface: RequestPreparationSetters

Sets the specified RequestOptions that could overwrite the previously configured values such as RequestOptionsSetters.responseTimeout(Duration), RequestOptionsSetters.writeTimeout(Duration), RequestOptionsSetters.maxResponseLength(long) and RequestOptionsSetters.attr(AttributeKey, Object).

Specified by:

requestOptions in interface RequestPreparationSetters