Package com.linecorp.armeria.common

Class AbstractHttpRequestBuilder

java.lang.Object

com.linecorp.armeria.common.AbstractHttpMessageBuilder

com.linecorp.armeria.common.AbstractHttpRequestBuilder

All Implemented Interfaces:

HttpMessageSetters, HttpRequestSetters, PathAndQueryParamSetters, RequestMethodSetters

Direct Known Subclasses:

HttpRequestBuilder, WebClientRequestPreparation

public abstract class AbstractHttpRequestBuilder
extends AbstractHttpMessageBuilder
implements HttpRequestSetters

Builds a new HttpRequest.

Constructor Summary

Constructors

Constructor	Description
AbstractHttpRequestBuilder()

Method Summary

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

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

publisher, trailer

Methods inherited from class java.lang.Object

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

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

trailer

Constructor Details

AbstractHttpRequestBuilder

public AbstractHttpRequestBuilder()

Method Details

get

public AbstractHttpRequestBuilder get(String path)

Description copied from interface: RequestMethodSetters

Sets GET method and path.

Specified by:

get in interface RequestMethodSetters

post

public AbstractHttpRequestBuilder post(String path)

Description copied from interface: RequestMethodSetters

Sets POST method and path.

Specified by:

post in interface RequestMethodSetters

put

public AbstractHttpRequestBuilder put(String path)

Description copied from interface: RequestMethodSetters

Sets PUT method and path.

Specified by:

put in interface RequestMethodSetters

delete

public AbstractHttpRequestBuilder delete(String path)

Description copied from interface: RequestMethodSetters

Sets DELETE method and path.

Specified by:

delete in interface RequestMethodSetters

patch

public AbstractHttpRequestBuilder patch(String path)

Description copied from interface: RequestMethodSetters

Sets PATCH method and path.

Specified by:

patch in interface RequestMethodSetters

options

public AbstractHttpRequestBuilder options(String path)

Description copied from interface: RequestMethodSetters

Sets OPTIONS method and path.

Specified by:

options in interface RequestMethodSetters

head

public AbstractHttpRequestBuilder head(String path)

Description copied from interface: RequestMethodSetters

Sets HEAD method and path.

Specified by:

head in interface RequestMethodSetters

trace

public AbstractHttpRequestBuilder trace(String path)

Description copied from interface: RequestMethodSetters

Sets TRACE method and path.

Specified by:

trace in interface RequestMethodSetters

method

public AbstractHttpRequestBuilder method(HttpMethod method)

Description copied from interface: RequestMethodSetters

Sets the method for this request.

Specified by:

method in interface RequestMethodSetters

See Also:

• HttpMethod

path

public AbstractHttpRequestBuilder path(String path)

Description copied from interface: RequestMethodSetters

Sets the path for this request.

Specified by:

path in interface RequestMethodSetters

content

public AbstractHttpRequestBuilder 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 AbstractHttpMessageBuilder

content

public AbstractHttpRequestBuilder 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 AbstractHttpMessageBuilder

content

public AbstractHttpRequestBuilder 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 AbstractHttpMessageBuilder

content

@FormatMethod
public AbstractHttpRequestBuilder 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 AbstractHttpMessageBuilder

content

@FormatMethod
public AbstractHttpRequestBuilder 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 AbstractHttpMessageBuilder

content

public AbstractHttpRequestBuilder 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 AbstractHttpMessageBuilder

content

public AbstractHttpRequestBuilder 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 AbstractHttpMessageBuilder

content

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

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 AbstractHttpMessageBuilder

content

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

Specified by:

content in interface HttpRequestSetters

Overrides:

content in class AbstractHttpMessageBuilder

contentJson

public AbstractHttpRequestBuilder 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 AbstractHttpMessageBuilder

header

public AbstractHttpRequestBuilder 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 AbstractHttpMessageBuilder

headers

public AbstractHttpRequestBuilder 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 AbstractHttpMessageBuilder

See Also:

• HttpHeaders

trailers

public AbstractHttpRequestBuilder 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 AbstractHttpMessageBuilder

pathParam

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

pathParams

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

disablePathParams

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

queryParam

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

queryParams

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

See Also:

• QueryParams

cookie

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

See Also:

• Cookie

cookies

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

See Also:

• Cookies

buildRequest

protected final HttpRequest buildRequest()

Creates a new HttpRequest.