Package com.linecorp.armeria.common

Interface AggregatedHttpRequest

All Superinterfaces:

AggregatedHttpMessage, AggregatedHttpObject

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
default @Nullable List<Locale.LanguageRange>	acceptLanguages()	Returns a list of Locale.LanguageRanges that are specified in HttpHeaderNames.ACCEPT_LANGUAGE in the order of client-side preferences.
default @Nullable String	authority()	Returns the authority of this request.
RequestHeaders	headers()	Returns the RequestHeaders.
default 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.
default String	path()	Returns the path of this request.
default @Nullable String	scheme()	Returns the scheme of this request.
default @Nullable Locale	selectLocale(Iterable<Locale> supportedLocales)	Matches the Locales supported by the server to the HttpHeaderNames.ACCEPT_LANGUAGE and returning the best match according to client preference.
default @Nullable Locale	selectLocale(Locale... supportedLocales)	Matches the Locales supported by the server to the HttpHeaderNames.ACCEPT_LANGUAGE and returning the best match according to client preference.
default HttpRequest	toHttpRequest()	Converts this request into a new complete HttpRequest.
default HttpRequest	toHttpRequest(RequestHeaders headers)	Converts this request into a new complete HttpRequest replacing the headers() with the specified RequestHeaders.
default URI	uri()	Returns the URI of this request.

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

trailers

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

content, content, contentAscii, contentType, contentUtf8

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

@FormatMethod
static AggregatedHttpRequest of(HttpMethod method,
 String path,
 MediaType mediaType,
 @FormatString
 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 AggregatedHttpObject

uri

default URI uri()

Returns the URI of this request. This method is a shortcut for headers().uri().

scheme

@Nullable
default @Nullable String scheme()

Returns the scheme of this request. This method is a shortcut for headers().scheme().

method

default HttpMethod method()

Returns the method of this request. This method is a shortcut for headers().method().

path

default String path()

Returns the path of this request. This method is a shortcut for headers().path().

authority

@Nullable
default @Nullable String authority()

Returns the authority of this request. This method is a shortcut for headers().authority().

acceptLanguages

@Nullable
default @Nullable List<Locale.LanguageRange> acceptLanguages()

Returns a list of Locale.LanguageRanges that are specified in HttpHeaderNames.ACCEPT_LANGUAGE in the order of client-side preferences. If the client does not send the header, this will contain only a wild card Locale.LanguageRange.

selectLocale

@Nullable
default @Nullable Locale selectLocale(Iterable<Locale> supportedLocales)

Matches the Locales supported by the server to the HttpHeaderNames.ACCEPT_LANGUAGE and returning the best match according to client preference. It does this via Basic Filtering each Locale.LanguageRange and picking the first match. This is the "classic" algorithm described in RFC2616 Accept-Language (obsoleted) and also referenced in RFC7231 Accept-Language.

Parameters:

supportedLocales - an Iterable of Locales supported by the server.

Returns:

The best matching Locale or null if no Locale matches.

selectLocale

@Nullable
default @Nullable Locale selectLocale(Locale... supportedLocales)

Matches the Locales supported by the server to the HttpHeaderNames.ACCEPT_LANGUAGE and returning the best match according to client preference. It does this via Basic Filtering each Locale.LanguageRange and picking the first match. This is the "classic" algorithm described in RFC2616 Accept-Language (obsoleted) and also referenced in RFC7231 Accept-Language.

Parameters:

supportedLocales - Locales supported by the server.

Returns:

The best matching Locale or null if no Locale matches.

toHttpRequest

default HttpRequest toHttpRequest()

Converts this request into a new complete HttpRequest.

Returns:

the new HttpRequest converted from this request.

toHttpRequest

default HttpRequest toHttpRequest(RequestHeaders headers)

Converts this request into a new complete HttpRequest replacing the headers() with the specified RequestHeaders.

Returns:

the new HttpRequest converted from this request.