Package com.linecorp.armeria.client

Class RestClientPreparation

java.lang.Object

com.linecorp.armeria.client.RestClientPreparation

All Implemented Interfaces:

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)
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	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)
<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)
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	requestOptions(RequestOptions requestOptions)	Sets the specified RequestOptions that could overwrite the previously configured values such as responseTimeout(Duration), writeTimeout(Duration), maxResponseLength(long) and attr(AttributeKey, Object).
RestClientPreparation	responseTimeout(Duration responseTimeout)
RestClientPreparation	responseTimeoutMillis(long responseTimeoutMillis)
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)
RestClientPreparation	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 <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(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,
 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(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)

responseTimeoutMillis

public RestClientPreparation responseTimeoutMillis(long responseTimeoutMillis)

writeTimeout

public RestClientPreparation writeTimeout(Duration writeTimeout)

writeTimeoutMillis

public RestClientPreparation writeTimeoutMillis(long writeTimeoutMillis)

maxResponseLength

public RestClientPreparation maxResponseLength(long maxResponseLength)

attr

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

exchangeType

public RestClientPreparation exchangeType(ExchangeType exchangeType)

requestOptions

public RestClientPreparation requestOptions(RequestOptions requestOptions)

Description copied from interface: RequestPreparationSetters

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

Specified by:

requestOptions in interface RequestPreparationSetters