Package com.linecorp.armeria.common

Interface HttpRequestSetters

All Known Implementing Classes:

AbstractHttpRequestBuilder, BlockingWebClientRequestPreparation, FutureTransformingRequestPreparation, HttpRequestBuilder, TransformingRequestPreparation, WebClientRequestPreparation

public interface HttpRequestSetters

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	delete(String path)	Shortcut to set DELETE method and path.
HttpRequestSetters	disablePathParams()	Disables path parameters substitution.
HttpRequestSetters	get(String path)	Shortcut to set GET method and path.
HttpRequestSetters	head(String path)	Shortcut to set HEAD method and path.
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	method(HttpMethod method)	Sets the method for this request.
HttpRequestSetters	options(String path)	Shortcut to set OPTIONS method and path.
HttpRequestSetters	patch(String path)	Shortcut to set PATCH method and path.
HttpRequestSetters	path(String path)	Sets the path 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	post(String path)	Shortcut to set POST method and path.
HttpRequestSetters	put(String path)	Shortcut to set PUT method and path.
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	trace(String path)	Shortcut to set TRACE method and path.
HttpRequestSetters	trailers(Iterable<? extends Map.Entry<? extends CharSequence,String>> trailers)	Sets HTTP trailers for this request.

Method Details

get

HttpRequestSetters get(String path)

Shortcut to set GET method and path.

post

HttpRequestSetters post(String path)

Shortcut to set POST method and path.

put

HttpRequestSetters put(String path)

Shortcut to set PUT method and path.

delete

HttpRequestSetters delete(String path)

Shortcut to set DELETE method and path.

patch

HttpRequestSetters patch(String path)

Shortcut to set PATCH method and path.

options

HttpRequestSetters options(String path)

Shortcut to set OPTIONS method and path.

head

HttpRequestSetters head(String path)

Shortcut to set HEAD method and path.

trace

HttpRequestSetters trace(String path)

Shortcut to set TRACE method and path.

method

HttpRequestSetters method(HttpMethod method)

Sets the method for this request.

See Also:

• HttpMethod

path

HttpRequestSetters path(String path)

Sets the path for this request.

content

HttpRequestSetters content(String content)

Sets the content as UTF_8 for this request.

content

HttpRequestSetters content(MediaType contentType,
 CharSequence content)

Sets the content for this request.

content

HttpRequestSetters content(MediaType contentType,
 String content)

Sets the content for this request.

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.

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.

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.

content

HttpRequestSetters content(MediaType contentType,
 HttpData content)

Sets the content for this request.

content

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

Sets the Publisher for this request.

contentJson

HttpRequestSetters contentJson(Object content)

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

header

HttpRequestSetters header(CharSequence name,
 Object value)

Adds a header for this request. For example:

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

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();
 

See Also:

• HttpHeaders

trailers

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

Sets HTTP trailers for this request.

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`
 

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`
 

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.

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`
 

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`
 

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();
 

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();
 

See Also:

• Cookies