Package com.linecorp.armeria.common

Interface AggregatedHttpRequest

All Superinterfaces:

AggregatedHttpMessage

All Known Subinterfaces:

PooledAggregatedHttpRequest

public interface AggregatedHttpRequest
extends AggregatedHttpMessage

A complete HTTP request whose content is readily available as a single HttpData.

Method Summary

Modifier and Type	Method	Description
String	authority()	Returns the AUTHORITY of this request, in the form of "hostname:port".
RequestHeaders	headers()	Returns the RequestHeaders.
HttpMethod	method()	Returns the METHOD of this request.
static AggregatedHttpRequest	of(HttpMethod method, String path)	Creates a new HTTP request with empty content.
static AggregatedHttpRequest	of(HttpMethod method, String path, MediaType mediaType, byte[] content)	Creates a new HTTP request.
static AggregatedHttpRequest	of(HttpMethod method, String path, MediaType mediaType, HttpData content)	Creates a new HTTP request.
static AggregatedHttpRequest	of(HttpMethod method, String path, MediaType mediaType, HttpData content, HttpHeaders trailers)	Creates a new HTTP request.
static AggregatedHttpRequest	of(HttpMethod method, String path, MediaType mediaType, CharSequence content)	Creates a new HTTP request.
static AggregatedHttpRequest	of(HttpMethod method, String path, MediaType mediaType, String content)	Creates a new HTTP request.
static AggregatedHttpRequest	of(HttpMethod method, String path, MediaType mediaType, String format, Object... args)	Creates a new HTTP request.
static AggregatedHttpRequest	of(RequestHeaders headers)	Creates a new HTTP request with empty content.
static AggregatedHttpRequest	of(RequestHeaders headers, HttpData content)	Creates a new HTTP request.
static AggregatedHttpRequest	of(RequestHeaders headers, HttpData content, HttpHeaders trailers)	Creates a new HTTP request.
String	path()	Returns the PATH of this request.
String	scheme()	Returns the SCHEME of this request.
default HttpRequest	toHttpRequest()	Converts this request into a new complete HttpRequest.

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

content, content, contentAscii, contentType, contentUtf8, trailers

Method Details

of

static AggregatedHttpRequest of(HttpMethod method, String path)

Creates a new HTTP request with empty content.

Parameters:

method - the HTTP method of the request

path - the path of the request

of

static AggregatedHttpRequest of(HttpMethod method, String path, MediaType mediaType, CharSequence content)

Creates a new HTTP request.

Parameters:

method - the HTTP method of the request

path - the path of the request

mediaType - the MediaType of the request content

content - the content of the request

of

static AggregatedHttpRequest of(HttpMethod method, String path, MediaType mediaType, String content)

Creates a new HTTP request.

Parameters:

method - the HTTP method of the request

path - the path of the request

mediaType - the MediaType of the request content

content - the content of the request

of

static AggregatedHttpRequest of(HttpMethod method, String path, MediaType mediaType, String format, Object... args)

Creates a new HTTP request. The content of the request is formatted by String.format(Locale, String, Object...) with English locale.

Parameters:

method - the HTTP method of the request

path - the path of the request

mediaType - the MediaType of the request content

format - the format string of the request content

args - the arguments referenced by the format specifiers in the format string

of

static AggregatedHttpRequest of(HttpMethod method, String path, MediaType mediaType, byte[] content)

Creates a new HTTP request. The content will be wrapped using HttpData.wrap(byte[]), so any changes made to content will be reflected in the request.

Parameters:

method - the HTTP method of the request

path - the path of the request

mediaType - the MediaType of the request content

content - the content of the request

of

static AggregatedHttpRequest of(HttpMethod method, String path, MediaType mediaType, HttpData content)

Creates a new HTTP request.

Parameters:

method - the HTTP method of the request

path - the path of the request

mediaType - the MediaType of the request content

content - the content of the request

of

static AggregatedHttpRequest of(HttpMethod method, String path, MediaType mediaType, HttpData content, HttpHeaders trailers)

Creates a new HTTP request.

Parameters:

method - the HTTP method of the request

path - the path of the request

mediaType - the MediaType of the request content

content - the content of the request

trailers - the HTTP trailers

of

static AggregatedHttpRequest of(RequestHeaders headers)

Creates a new HTTP request with empty content.

Parameters:

headers - the HTTP request headers

of

static AggregatedHttpRequest of(RequestHeaders headers, HttpData content)

Creates a new HTTP request.

Parameters:

headers - the HTTP request headers

content - the content of the request

of

static AggregatedHttpRequest of(RequestHeaders headers, HttpData content, HttpHeaders trailers)

Creates a new HTTP request.

Parameters:

headers - the HTTP request headers

content - the content of the request

trailers - the HTTP trailers

headers

RequestHeaders headers()

Returns the RequestHeaders.

Specified by:

headers in interface AggregatedHttpMessage

method

HttpMethod method()

Returns the METHOD of this request.

path

String path()

Returns the PATH of this request.

scheme

@Nullable String scheme()

Returns the SCHEME of this request.

Returns:

the scheme, or null if there's no such header

authority

@Nullable String authority()

Returns the AUTHORITY of this request, in the form of "hostname:port".

Returns:

the authority, or null if there's no such header

toHttpRequest

default HttpRequest toHttpRequest()

Converts this request into a new complete HttpRequest.

Returns:

the new HttpRequest converted from this request.