Package com.linecorp.armeria.common

Class HttpRequestBuilder

java.lang.Object

com.linecorp.armeria.common.AbstractHttpRequestBuilder

com.linecorp.armeria.common.HttpRequestBuilder

All Implemented Interfaces:

HttpRequestSetters

public final class HttpRequestBuilder
extends AbstractHttpRequestBuilder

Builds a new HttpRequest.

Method Summary

Modifier and Type	Method	Description
HttpRequest	build()	Builds the request.
HttpRequestBuilder	content(MediaType contentType, byte[] content)	Sets the content for this request.
HttpRequestBuilder	content(MediaType contentType, HttpData content)	Sets the content for this request.
HttpRequestBuilder	content(MediaType contentType, CharSequence content)	Sets the content for this request.
HttpRequestBuilder	content(MediaType contentType, String content)	Sets the content for this request.
HttpRequestBuilder	content(MediaType contentType, String format, Object... content)	Sets the content for this request.
HttpRequestBuilder	content(MediaType contentType, org.reactivestreams.Publisher<? extends HttpData> publisher)	Sets the Publisher for this request.
HttpRequestBuilder	content(String content)	Sets the content as UTF_8 for this request.
HttpRequestBuilder	content(String format, Object... content)	Sets the content as UTF_8 for this request.
HttpRequestBuilder	contentJson(Object content)	Sets the content for this request.
HttpRequestBuilder	cookie(Cookie cookie)	Sets a cookie for this request.
HttpRequestBuilder	cookies(Iterable<? extends Cookie> cookies)	Sets multiple cookies for this request.
HttpRequestBuilder	delete(String path)	Shortcut to set DELETE method and path.
HttpRequestBuilder	disablePathParams()	Disables path parameters substitution.
HttpRequestBuilder	get(String path)	Shortcut to set GET method and path.
HttpRequestBuilder	head(String path)	Shortcut to set HEAD method and path.
HttpRequestBuilder	header(CharSequence name, Object value)	Adds a header for this request.
HttpRequestBuilder	headers(Iterable<? extends Map.Entry<? extends CharSequence,String>> headers)	Adds multiple headers for this request.
HttpRequestBuilder	method(HttpMethod method)	Sets the method for this request.
HttpRequestBuilder	options(String path)	Shortcut to set OPTIONS method and path.
HttpRequestBuilder	patch(String path)	Shortcut to set PATCH method and path.
HttpRequestBuilder	path(String path)	Sets the path for this request.
HttpRequestBuilder	pathParam(String name, Object value)	Sets a path param for this request.
HttpRequestBuilder	pathParams(Map<String,?> pathParams)	Sets multiple path params for this request.
HttpRequestBuilder	post(String path)	Shortcut to set POST method and path.
HttpRequestBuilder	put(String path)	Shortcut to set PUT method and path.
HttpRequestBuilder	queryParam(String name, Object value)	Sets a query param for this request.
HttpRequestBuilder	queryParams(Iterable<? extends Map.Entry<? extends String,String>> queryParams)	Sets multiple query params for this request.
HttpRequestBuilder	trace(String path)	Shortcut to set TRACE method and path.
HttpRequestBuilder	trailers(Iterable<? extends Map.Entry<? extends CharSequence,String>> trailers)	Sets HTTP trailers for this request.

Methods inherited from class com.linecorp.armeria.common.AbstractHttpRequestBuilder

buildRequest

Methods inherited from class java.lang.Object

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

Method Details

build

public HttpRequest build()

Builds the request.

get

public HttpRequestBuilder get(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set GET method and path.

Specified by:

get in interface HttpRequestSetters

Overrides:

get in class AbstractHttpRequestBuilder

post

public HttpRequestBuilder post(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set POST method and path.

Specified by:

post in interface HttpRequestSetters

Overrides:

post in class AbstractHttpRequestBuilder

put

public HttpRequestBuilder put(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set PUT method and path.

Specified by:

put in interface HttpRequestSetters

Overrides:

put in class AbstractHttpRequestBuilder

delete

public HttpRequestBuilder delete(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set DELETE method and path.

Specified by:

delete in interface HttpRequestSetters

Overrides:

delete in class AbstractHttpRequestBuilder

patch

public HttpRequestBuilder patch(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set PATCH method and path.

Specified by:

patch in interface HttpRequestSetters

Overrides:

patch in class AbstractHttpRequestBuilder

options

public HttpRequestBuilder options(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set OPTIONS method and path.

Specified by:

options in interface HttpRequestSetters

Overrides:

options in class AbstractHttpRequestBuilder

head

public HttpRequestBuilder head(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set HEAD method and path.

Specified by:

head in interface HttpRequestSetters

Overrides:

head in class AbstractHttpRequestBuilder

trace

public HttpRequestBuilder trace(String path)

Description copied from interface: HttpRequestSetters

Shortcut to set TRACE method and path.

Specified by:

trace in interface HttpRequestSetters

Overrides:

trace in class AbstractHttpRequestBuilder

method

public HttpRequestBuilder method(HttpMethod method)

Description copied from interface: HttpRequestSetters

Sets the method for this request.

Specified by:

method in interface HttpRequestSetters

Overrides:

method in class AbstractHttpRequestBuilder

See Also:

• HttpMethod

path

public HttpRequestBuilder path(String path)

Description copied from interface: HttpRequestSetters

Sets the path for this request.

Specified by:

path in interface HttpRequestSetters

Overrides:

path in class AbstractHttpRequestBuilder

content

public HttpRequestBuilder content(String content)

Description copied from interface: HttpRequestSetters

Sets the content as UTF_8 for this request.

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

content

public HttpRequestBuilder content(MediaType contentType,
 CharSequence content)

Description copied from interface: HttpRequestSetters

Sets the content for this request.

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

content

public HttpRequestBuilder content(MediaType contentType,
 String content)

Description copied from interface: HttpRequestSetters

Sets the content for this request.

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

content

@FormatMethod
public HttpRequestBuilder content(@FormatString
 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

Overrides:

content in class AbstractHttpRequestBuilder

content

@FormatMethod
public HttpRequestBuilder content(MediaType contentType,
 @FormatString
 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

Overrides:

content in class AbstractHttpRequestBuilder

content

public HttpRequestBuilder 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

Overrides:

content in class AbstractHttpRequestBuilder

content

public HttpRequestBuilder content(MediaType contentType,
 HttpData content)

Description copied from interface: HttpRequestSetters

Sets the content for this request.

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

content

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

Description copied from interface: HttpRequestSetters

Sets the Publisher for this request.

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

contentJson

public HttpRequestBuilder 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

Overrides:

contentJson in class AbstractHttpRequestBuilder

header

public HttpRequestBuilder 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

Overrides:

header in class AbstractHttpRequestBuilder

headers

public HttpRequestBuilder 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

Overrides:

headers in class AbstractHttpRequestBuilder

See Also:

• HttpHeaders

trailers

public HttpRequestBuilder 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

Overrides:

trailers in class AbstractHttpRequestBuilder

pathParam

public HttpRequestBuilder 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

Overrides:

pathParam in class AbstractHttpRequestBuilder

pathParams

public HttpRequestBuilder 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

Overrides:

pathParams in class AbstractHttpRequestBuilder

disablePathParams

public HttpRequestBuilder 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

Overrides:

disablePathParams in class AbstractHttpRequestBuilder

queryParam

public HttpRequestBuilder 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

Overrides:

queryParam in class AbstractHttpRequestBuilder

queryParams

public HttpRequestBuilder 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

Overrides:

queryParams in class AbstractHttpRequestBuilder

See Also:

• QueryParams

cookie

public HttpRequestBuilder 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

Overrides:

cookie in class AbstractHttpRequestBuilder

See Also:

• Cookie

cookies

public HttpRequestBuilder 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

Overrides:

cookies in class AbstractHttpRequestBuilder

See Also:

• Cookies