Package com.linecorp.armeria.common

Interface AggregatedHttpResponse

public interface AggregatedHttpResponse

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

Method Summary

Modifier and Type	Method	Description
HttpData	content()	Returns the content of this message.
default String	content(Charset charset)	Returns the content of this message as a string encoded in the specified Charset.
default String	contentAscii()	Returns the content of this message as an ASCII string.
default MediaType	contentType()	Returns the value of the 'content-type' header.
default String	contentUtf8()	Returns the content of this message as a UTF-8 string.
ResponseHeaders	headers()	Returns the ResponseHeaders.
List<ResponseHeaders>	informationals()	Returns the informational class (1xx) HTTP headers.
static AggregatedHttpResponse	of(int statusCode)	Creates a new HTTP response.
static AggregatedHttpResponse	of(HttpStatus status)	Creates a new HTTP response.
static AggregatedHttpResponse	of(HttpStatus status, MediaType mediaType, byte[] content)	Creates a new HTTP response of the specified HttpStatus.
static AggregatedHttpResponse	of(HttpStatus status, MediaType mediaType, HttpData content)	Creates a new HTTP response of the specified HttpStatus.
static AggregatedHttpResponse	of(HttpStatus status, MediaType mediaType, HttpData content, HttpHeaders trailers)	Creates a new HTTP response of the specified HttpStatus.
static AggregatedHttpResponse	of(HttpStatus status, MediaType mediaType, CharSequence content)	Creates a new HTTP response of the specified HttpStatus.
static AggregatedHttpResponse	of(HttpStatus status, MediaType mediaType, String content)	Creates a new HTTP response of the specified HttpStatus.
static AggregatedHttpResponse	of(HttpStatus status, MediaType mediaType, String format, Object... args)	Creates a new HTTP response of the specified HttpStatus.
static AggregatedHttpResponse	of(ResponseHeaders headers)	Creates a new HTTP response with empty content.
static AggregatedHttpResponse	of(ResponseHeaders headers, HttpData content)	Creates a new HTTP response.
static AggregatedHttpResponse	of(ResponseHeaders headers, HttpData content, HttpHeaders trailers)	Creates a new HTTP response.
static AggregatedHttpResponse	of(Iterable<ResponseHeaders> informationals, ResponseHeaders headers, HttpData content, HttpHeaders trailers)	Creates a new HTTP response.
HttpStatus	status()	Returns the STATUS of this response.
default HttpResponse	toHttpResponse()	Converts this response into a new complete HttpResponse.
HttpHeaders	trailers()	Returns the HTTP trailers.

Method Details

of

static AggregatedHttpResponse of(int statusCode)

Creates a new HTTP response.

Parameters:

statusCode - the HTTP status code

Throws:

IllegalArgumentException - if the specified statusCode is informational.

of

static AggregatedHttpResponse of(HttpStatus status)

Creates a new HTTP response.

Parameters:

status - the HTTP status

Throws:

IllegalArgumentException - if the specified HttpStatus is informational.

of

static AggregatedHttpResponse of(HttpStatus status, MediaType mediaType, CharSequence content)

Creates a new HTTP response of the specified HttpStatus.

Parameters:

mediaType - the MediaType of the response content

content - the content of the response

Throws:

IllegalArgumentException - if the specified HttpStatus is informational.

of

static AggregatedHttpResponse of(HttpStatus status, MediaType mediaType, String content)

Creates a new HTTP response of the specified HttpStatus.

Parameters:

mediaType - the MediaType of the response content

content - the content of the response

Throws:

IllegalArgumentException - if the specified HttpStatus is informational.

of

@FormatMethod static AggregatedHttpResponse of(HttpStatus status, MediaType mediaType, @FormatString String format, Object... args)

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

Parameters:

mediaType - the MediaType of the response content

format - the format string of the response content

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

Throws:

IllegalArgumentException - if the specified HttpStatus is informational.

of

static AggregatedHttpResponse of(HttpStatus status, MediaType mediaType, byte[] content)

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

Parameters:

mediaType - the MediaType of the response content

content - the content of the response

Throws:

IllegalArgumentException - if the specified HttpStatus is informational.

of

static AggregatedHttpResponse of(HttpStatus status, MediaType mediaType, HttpData content)

Creates a new HTTP response of the specified HttpStatus.

Parameters:

mediaType - the MediaType of the response content

content - the content of the response

Throws:

IllegalArgumentException - if the specified HttpStatus is informational.

of

static AggregatedHttpResponse of(HttpStatus status, MediaType mediaType, HttpData content, HttpHeaders trailers)

Creates a new HTTP response of the specified HttpStatus.

Parameters:

mediaType - the MediaType of the response content

content - the content of the response

trailers - the HTTP trailers

Throws:

IllegalArgumentException - if the specified HttpStatus is informational.

of

static AggregatedHttpResponse of(ResponseHeaders headers)

Creates a new HTTP response with empty content.

Parameters:

headers - the HTTP headers

Throws:

IllegalArgumentException - if the status of the specified ResponseHeaders is informational.

of

static AggregatedHttpResponse of(ResponseHeaders headers, HttpData content)

Creates a new HTTP response.

Parameters:

headers - the HTTP headers

content - the content of the HTTP response

Throws:

IllegalArgumentException - if the status of the specified ResponseHeaders is informational.

of

static AggregatedHttpResponse of(ResponseHeaders headers, HttpData content, HttpHeaders trailers)

Creates a new HTTP response.

Parameters:

headers - the HTTP headers

content - the content of the HTTP response

trailers - the HTTP trailers

Throws:

IllegalArgumentException - if the status of the specified ResponseHeaders is informational.

of

static AggregatedHttpResponse of(Iterable<ResponseHeaders> informationals, ResponseHeaders headers, HttpData content, HttpHeaders trailers)

Creates a new HTTP response.

Parameters:

informationals - the informational class (1xx) HTTP headers

headers - the HTTP headers

content - the content of the HTTP response

trailers - the HTTP trailers

Throws:

IllegalArgumentException - if the status of the specified ResponseHeaders is informational.

headers

ResponseHeaders headers()

Returns the ResponseHeaders.

informationals

List<ResponseHeaders> informationals()

Returns the informational class (1xx) HTTP headers.

status

HttpStatus status()

Returns the STATUS of this response.

toHttpResponse

default HttpResponse toHttpResponse()

Converts this response into a new complete HttpResponse.

Returns:

the new HttpResponse converted from this response.

trailers

HttpHeaders trailers()

Returns the HTTP trailers.

content

HttpData content()

Returns the content of this message.

content

default String content(Charset charset)

Returns the content of this message as a string encoded in the specified Charset.

contentUtf8

default String contentUtf8()

Returns the content of this message as a UTF-8 string.

contentAscii

default String contentAscii()

Returns the content of this message as an ASCII string.

contentType

@Nullable default MediaType contentType()

Returns the value of the 'content-type' header.

Returns:

the valid header value if present, or null otherwise.