Package com.linecorp.armeria.common

Interface HttpRequestSetters

All Superinterfaces:

HttpMessageSetters, PathAndQueryParamSetters, RequestMethodSetters

All Known Implementing Classes:

AbstractHttpRequestBuilder, HttpRequestBuilder, WebClientRequestPreparation

@UnstableApi
public interface HttpRequestSetters
extends RequestMethodSetters, PathAndQueryParamSetters, HttpMessageSetters

Sets properties for building an HttpRequest.

Method Summary

Modifier and Type	Method	Description
HttpRequestSetters	content(MediaType contentType, byte[] content)	Sets the content for this request.
HttpRequestSetters	content(MediaType contentType, HttpData content)	Sets the content for this request.
HttpRequestSetters	content(MediaType contentType, CharSequence content)	Sets the content for this request.
HttpRequestSetters	content(MediaType contentType, String content)	Sets the content for this request.
HttpRequestSetters	content(MediaType contentType, String format, Object... content)	Sets the content for this request.
HttpRequestSetters	content(MediaType contentType, org.reactivestreams.Publisher<? extends HttpData> content)	Sets the Publisher for this request.
HttpRequestSetters	content(String content)	Sets the content as UTF-8 for this request.
HttpRequestSetters	content(String format, Object... content)	Sets the content as UTF-8 for this request.
HttpRequestSetters	contentJson(Object content)	Sets the content for this request.
HttpRequestSetters	cookie(Cookie cookie)	Sets a cookie for this request.
HttpRequestSetters	cookies(Iterable<? extends Cookie> cookies)	Sets multiple cookies for this request.
HttpRequestSetters	disablePathParams()	Disables path parameters substitution.
HttpRequestSetters	header(CharSequence name, Object value)	Adds a header for this request.
HttpRequestSetters	headers(Iterable<? extends Map.Entry<? extends CharSequence,String>> headers)	Adds multiple headers for this request.
HttpRequestSetters	pathParam(String name, Object value)	Sets a path param for this request.
HttpRequestSetters	pathParams(Map<String,?> pathParams)	Sets multiple path params for this request.
HttpRequestSetters	queryParam(String name, Object value)	Adds a query param for this request.
HttpRequestSetters	queryParams(Iterable<? extends Map.Entry<? extends String,String>> queryParams)	Adds multiple query params for this request.
HttpRequestSetters	trailers(Iterable<? extends Map.Entry<? extends CharSequence,String>> trailers)	Sets HTTP trailers for this request.

Methods inherited from interface com.linecorp.armeria.common.HttpMessageSetters

trailer

Methods inherited from interface com.linecorp.armeria.common.RequestMethodSetters

delete, get, head, method, options, patch, path, post, put, trace

Method Details

content

HttpRequestSetters content(String content)

Sets the content as UTF-8 for this request.

Specified by:

content in interface HttpMessageSetters

content

HttpRequestSetters content(MediaType contentType,
 CharSequence content)

Sets the content for this request.

Specified by:

content in interface HttpMessageSetters

content

HttpRequestSetters content(MediaType contentType,
 String content)

Sets the content for this request.

Specified by:

content in interface HttpMessageSetters

content

@FormatMethod
HttpRequestSetters content(@FormatString
 String format,
 Object... content)

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 HttpMessageSetters

content

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

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

Specified by:

content in interface HttpMessageSetters

content

HttpRequestSetters content(MediaType contentType,
 byte[] content)

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 HttpMessageSetters

content

HttpRequestSetters content(MediaType contentType,
 HttpData content)

Sets the content for this request.

Specified by:

content in interface HttpMessageSetters

content

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

Sets the Publisher for this request.

Specified by:

content in interface HttpMessageSetters

contentJson

HttpRequestSetters contentJson(Object content)

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

Specified by:

contentJson in interface HttpMessageSetters

header

HttpRequestSetters header(CharSequence name,
 Object value)

Adds a header for this request. For example:

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

Specified by:

header in interface HttpMessageSetters

headers

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

Adds multiple headers for this request. For example:

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

Specified by:

headers in interface HttpMessageSetters

See Also:

• HttpHeaders

trailers

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

Sets HTTP trailers for this request.

Specified by:

trailers in interface HttpMessageSetters

pathParam

HttpRequestSetters pathParam(String name,
 Object value)

Sets a path param for this request. For example:

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

Specified by:

pathParam in interface PathAndQueryParamSetters

pathParams

HttpRequestSetters pathParams(Map<String,?> pathParams)

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 PathAndQueryParamSetters

disablePathParams

HttpRequestSetters disablePathParams()

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 PathAndQueryParamSetters

queryParam

HttpRequestSetters queryParam(String name,
 Object value)

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 PathAndQueryParamSetters

queryParams

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

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 PathAndQueryParamSetters

See Also:

• QueryParams

cookie

HttpRequestSetters cookie(Cookie cookie)

Sets a cookie for this request. For example:

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

Specified by:

cookie in interface HttpMessageSetters

See Also:

• Cookie

cookies

HttpRequestSetters cookies(Iterable<? extends Cookie> cookies)

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 HttpMessageSetters

See Also:

• Cookies