Package com.linecorp.armeria.common

Class AbstractHttpRequestBuilder

java.lang.Object

com.linecorp.armeria.common.AbstractHttpRequestBuilder

Direct Known Subclasses:

HttpRequestBuilder, WebClientRequestPreparation

public abstract class AbstractHttpRequestBuilder
extends Object

Builds a new HttpRequest.

Constructor Summary

Constructors

Constructor	Description
AbstractHttpRequestBuilder()

Method Summary

Modifier and Type	Method	Description
protected HttpRequest	buildRequest()	Creates a new HttpRequest.
AbstractHttpRequestBuilder	content(MediaType contentType, byte[] content)	Sets the content for this request.
AbstractHttpRequestBuilder	content(MediaType contentType, HttpData content)	Sets the content for this request.
AbstractHttpRequestBuilder	content(MediaType contentType, CharSequence content)	Sets the content for this request.
AbstractHttpRequestBuilder	content(MediaType contentType, String content)	Sets the content for this request.
AbstractHttpRequestBuilder	content(MediaType contentType, String format, Object... content)	Sets the content for this request.
AbstractHttpRequestBuilder	content(MediaType contentType, org.reactivestreams.Publisher<? extends HttpData> publisher)	Sets the Publisher for this request.
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)	Shortcut to set DELETE method and path.
AbstractHttpRequestBuilder	disablePathParams()	Disables path parameters substitution.
AbstractHttpRequestBuilder	get(String path)	Shortcut to set GET method and path.
AbstractHttpRequestBuilder	head(String path)	Shortcut to set HEAD method and path.
AbstractHttpRequestBuilder	header(CharSequence name, Object value)	Adds a header for this request.
AbstractHttpRequestBuilder	headers(Iterable<? extends Map.Entry<? extends CharSequence,String>> headers)	Adds multiple headers for this request.
AbstractHttpRequestBuilder	method(HttpMethod method)	Sets the method for this request.
AbstractHttpRequestBuilder	options(String path)	Shortcut to set OPTIONS method and path.
AbstractHttpRequestBuilder	patch(String path)	Shortcut to set 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)	Shortcut to set POST method and path.
AbstractHttpRequestBuilder	put(String path)	Shortcut to set PUT method and path.
AbstractHttpRequestBuilder	queryParam(String name, Object value)	Sets a query param for this request.
AbstractHttpRequestBuilder	queryParams(Iterable<? extends Map.Entry<? extends String,String>> queryParams)	Sets multiple query params for this request.
AbstractHttpRequestBuilder	trace(String path)	Shortcut to set TRACE method and path.
AbstractHttpRequestBuilder	trailers(Iterable<? extends Map.Entry<? extends CharSequence,String>> trailers)	Sets HTTP trailers for this request.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractHttpRequestBuilder

public AbstractHttpRequestBuilder()

Method Details

get

public AbstractHttpRequestBuilder get(String path)

Shortcut to set GET method and path.

post

public AbstractHttpRequestBuilder post(String path)

Shortcut to set POST method and path.

put

public AbstractHttpRequestBuilder put(String path)

Shortcut to set PUT method and path.

delete

public AbstractHttpRequestBuilder delete(String path)

Shortcut to set DELETE method and path.

patch

public AbstractHttpRequestBuilder patch(String path)

Shortcut to set PATCH method and path.

options

public AbstractHttpRequestBuilder options(String path)

Shortcut to set OPTIONS method and path.

head

public AbstractHttpRequestBuilder head(String path)

Shortcut to set HEAD method and path.

trace

public AbstractHttpRequestBuilder trace(String path)

Shortcut to set TRACE method and path.

method

public AbstractHttpRequestBuilder method(HttpMethod method)

Sets the method for this request.

See Also:

HttpMethod

path

public AbstractHttpRequestBuilder path(String path)

Sets the path for this request.

content

public AbstractHttpRequestBuilder content(MediaType contentType,
CharSequence content)

Sets the content for this request.

content

public AbstractHttpRequestBuilder content(MediaType contentType,
String content)

Sets the content for this request.

content

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

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

public AbstractHttpRequestBuilder content(MediaType contentType,
HttpData content)

Sets the content for this request.

content

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

Sets the Publisher for this request.

header

public AbstractHttpRequestBuilder header(CharSequence name,
Object value)

Adds a header for this request. For example:

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

headers

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

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

Sets HTTP trailers for this request.

pathParam

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

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

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

public AbstractHttpRequestBuilder queryParam(String name,
Object value)

Sets a query param for this request. For example:

 HttpRequest.builder()
            .get("/endpoint")
            .queryParam("foo", "bar")
            .build(); // GET `/endpoint?foo=bar`
 

queryParams

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

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`
 

See Also:

QueryParams

cookie

public AbstractHttpRequestBuilder cookie(Cookie cookie)

Sets a cookie for this request. For example:

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

See Also:

Cookie

cookies

public AbstractHttpRequestBuilder cookies(Iterable<? extends Cookie> cookies)

Sets multiple cookies for this request. For example:

 HttpRequest.builder()
            .get("/")
            .cookies(Cookies.of(Cookie.of("cookie1", "foo"),
                                Cookie.of("cookie2", "bar")))
            .build();
 

See Also:

Cookies

buildRequest

protected final HttpRequest buildRequest()

Creates a new HttpRequest.