Package com.linecorp.armeria.common

Class HttpRequestBuilder

java.lang.Object

com.linecorp.armeria.common.AbstractHttpMessageBuilder

com.linecorp.armeria.common.AbstractHttpRequestBuilder

com.linecorp.armeria.common.HttpRequestBuilder

All Implemented Interfaces:

HttpMessageSetters, HttpRequestSetters, PathAndQueryParamSetters, RequestMethodSetters

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 message.
HttpRequestBuilder	content(MediaType contentType, HttpData content)	Sets the content for this message.
HttpRequestBuilder	content(MediaType contentType, CharSequence content)	Sets the content for this message.
HttpRequestBuilder	content(MediaType contentType, String content)	Sets the content for this message.
HttpRequestBuilder	content(MediaType contentType, String format, Object... content)	Sets the content for this message.
HttpRequestBuilder	content(MediaType contentType, org.reactivestreams.Publisher<? extends HttpData> publisher)	Sets the Publisher for this message.
HttpRequestBuilder	content(String content)	Sets the content as UTF-8 for this message.
HttpRequestBuilder	content(String format, Object... content)	Sets the content as UTF-8 for this message.
HttpRequestBuilder	content(org.reactivestreams.Publisher<? extends HttpData> publisher)	Sets the Publisher for this message.
HttpRequestBuilder	contentJson(Object content)	Sets the content for this message.
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)	Sets DELETE method and path.
HttpRequestBuilder	disablePathParams()	Disables path parameters substitution.
HttpRequestBuilder	get(String path)	Sets GET method and path.
HttpRequestBuilder	head(String path)	Sets HEAD method and path.
HttpRequestBuilder	header(CharSequence name, Object value)	Adds a header for this message.
HttpRequestBuilder	headers(Iterable<? extends Map.Entry<? extends CharSequence,String>> headers)	Adds multiple headers for this message.
HttpRequestBuilder	method(HttpMethod method)	Sets the method for this request.
HttpRequestBuilder	options(String path)	Sets OPTIONS method and path.
HttpRequestBuilder	patch(String path)	Sets 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)	Sets POST method and path.
HttpRequestBuilder	put(String path)	Sets PUT method and path.
HttpRequestBuilder	queryParam(String name, Object value)	Adds a query param for this request.
HttpRequestBuilder	queryParams(Iterable<? extends Map.Entry<? extends String,String>> queryParams)	Adds multiple query params for this request.
HttpRequestBuilder	trace(String path)	Sets TRACE method and path.
HttpRequestBuilder	trailer(CharSequence name, Object value)	Adds an HTTP trailer for this message.
HttpRequestBuilder	trailers(Iterable<? extends Map.Entry<? extends CharSequence,String>> trailers)	Adds HTTP trailers for this message.

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

buildRequest

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

publisher

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: RequestMethodSetters

Sets GET method and path.

Specified by:

get in interface RequestMethodSetters

Overrides:

get in class AbstractHttpRequestBuilder

post

public HttpRequestBuilder post(String path)

Description copied from interface: RequestMethodSetters

Sets POST method and path.

Specified by:

post in interface RequestMethodSetters

Overrides:

post in class AbstractHttpRequestBuilder

put

public HttpRequestBuilder put(String path)

Description copied from interface: RequestMethodSetters

Sets PUT method and path.

Specified by:

put in interface RequestMethodSetters

Overrides:

put in class AbstractHttpRequestBuilder

delete

public HttpRequestBuilder delete(String path)

Description copied from interface: RequestMethodSetters

Sets DELETE method and path.

Specified by:

delete in interface RequestMethodSetters

Overrides:

delete in class AbstractHttpRequestBuilder

patch

public HttpRequestBuilder patch(String path)

Description copied from interface: RequestMethodSetters

Sets PATCH method and path.

Specified by:

patch in interface RequestMethodSetters

Overrides:

patch in class AbstractHttpRequestBuilder

options

public HttpRequestBuilder options(String path)

Description copied from interface: RequestMethodSetters

Sets OPTIONS method and path.

Specified by:

options in interface RequestMethodSetters

Overrides:

options in class AbstractHttpRequestBuilder

head

public HttpRequestBuilder head(String path)

Description copied from interface: RequestMethodSetters

Sets HEAD method and path.

Specified by:

head in interface RequestMethodSetters

Overrides:

head in class AbstractHttpRequestBuilder

trace

public HttpRequestBuilder trace(String path)

Description copied from interface: RequestMethodSetters

Sets TRACE method and path.

Specified by:

trace in interface RequestMethodSetters

Overrides:

trace in class AbstractHttpRequestBuilder

method

public HttpRequestBuilder method(HttpMethod method)

Description copied from interface: RequestMethodSetters

Sets the method for this request.

Specified by:

method in interface RequestMethodSetters

Overrides:

method in class AbstractHttpRequestBuilder

See Also:

• HttpMethod

path

public HttpRequestBuilder path(String path)

Description copied from interface: RequestMethodSetters

Sets the path for this request.

Specified by:

path in interface RequestMethodSetters

Overrides:

path in class AbstractHttpRequestBuilder

content

public HttpRequestBuilder content(String content)

Description copied from interface: HttpMessageSetters

Sets the content as UTF-8 for this message.

Specified by:

content in interface HttpMessageSetters

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

content

public HttpRequestBuilder content(MediaType contentType,
 CharSequence content)

Description copied from interface: HttpMessageSetters

Sets the content for this message.

Specified by:

content in interface HttpMessageSetters

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

content

public HttpRequestBuilder content(MediaType contentType,
 String content)

Description copied from interface: HttpMessageSetters

Sets the content for this message.

Specified by:

content in interface HttpMessageSetters

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: 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

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: 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

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

content

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

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

content

public HttpRequestBuilder content(MediaType contentType,
 HttpData content)

Description copied from interface: HttpMessageSetters

Sets the content for this message.

Specified by:

content in interface HttpMessageSetters

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

content

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

Description copied from interface: HttpMessageSetters

Sets the Publisher for this message.

Specified by:

content in interface HttpMessageSetters

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: HttpMessageSetters

Sets the Publisher for this message.

Specified by:

content in interface HttpMessageSetters

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpRequestBuilder

contentJson

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

Specified by:

contentJson in interface HttpRequestSetters

Overrides:

contentJson in class AbstractHttpRequestBuilder

header

public HttpRequestBuilder header(CharSequence name,
 Object value)

Description copied from interface: HttpMessageSetters

Adds a header for this message.

Specified by:

header in interface HttpMessageSetters

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: HttpMessageSetters

Adds multiple headers for this message.

Specified by:

headers in interface HttpMessageSetters

Specified by:

headers in interface HttpRequestSetters

Overrides:

headers in class AbstractHttpRequestBuilder

See Also:

• HttpHeaders

trailer

public HttpRequestBuilder trailer(CharSequence name,
 Object value)

Description copied from interface: HttpMessageSetters

Adds an HTTP trailer for this message.

Specified by:

trailer in interface HttpMessageSetters

Overrides:

trailer in class AbstractHttpMessageBuilder

trailers

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

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

Specified by:

pathParam in interface PathAndQueryParamSetters

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

Specified by:

pathParams in interface PathAndQueryParamSetters

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

Specified by:

disablePathParams in interface PathAndQueryParamSetters

Overrides:

disablePathParams in class AbstractHttpRequestBuilder

queryParam

public HttpRequestBuilder queryParam(String name,
 Object value)

Description copied from interface: HttpRequestSetters

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 HttpRequestSetters

Specified by:

queryParam in interface PathAndQueryParamSetters

Overrides:

queryParam in class AbstractHttpRequestBuilder

queryParams

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

Description copied from interface: HttpRequestSetters

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 HttpRequestSetters

Specified by:

queryParams in interface PathAndQueryParamSetters

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 HttpMessageSetters

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 HttpMessageSetters

Specified by:

cookies in interface HttpRequestSetters

Overrides:

cookies in class AbstractHttpRequestBuilder

See Also:

• Cookies