com.linecorp.armeria.common

Interface HttpResponseWriter

All Superinterfaces:

StreamWriter<HttpObject>

All Known Implementing Classes:

DefaultHttpResponse

public interface HttpResponseWriter
extends StreamWriter<HttpObject>

A StreamWriter of an HttpResponse.

Method Summary

Modifier and Type	Method and Description
default void	respond(AggregatedHttpMessage res) Writes the specified HTTP response and closes the stream.
default void	respond(HttpStatus status) Writes the HTTP response of the specified HttpStatus and closes the stream if the HttpStatusClass is not informational (1xx).
default void	respond(HttpStatus status, MediaType mediaType, byte[] content) Writes the HTTP response of the specified HttpStatus and closes the stream.
default void	respond(HttpStatus status, MediaType mediaType, byte[] content, int offset, int length) Writes the HTTP response of the specified HttpStatus and closes the stream.
default void	respond(HttpStatus status, MediaType mediaType, HttpData content) Writes the HTTP response of the specified HttpStatus and closes the stream.
default void	respond(HttpStatus status, MediaType mediaType, HttpData content, HttpHeaders trailingHeaders) Writes the HTTP response of the specified HttpStatus and closes the stream.
default void	respond(HttpStatus status, MediaType mediaType, String content) Writes the HTTP response of the specified HttpStatus and closes the stream.
default void	respond(HttpStatus status, MediaType mediaType, String format, Object... args) Writes the HTTP response of the specified HttpStatus and closes the stream.
default void	respond(int statusCode) Writes the HTTP response of the specified statusCode and closes the stream if the HttpStatusClass is not informational (1xx).

Methods inherited from interface com.linecorp.armeria.common.stream.StreamWriter

close, close, isOpen, onDemand, write, write

Method Detail

respond

default void respond(int statusCode)

Writes the HTTP response of the specified statusCode and closes the stream if the HttpStatusClass is not informational (1xx).

respond

default void respond(HttpStatus status)

Writes the HTTP response of the specified HttpStatus and closes the stream if the HttpStatusClass is not informational (1xx).

respond

default void respond(HttpStatus status,
                     MediaType mediaType,
                     String content)

Writes the HTTP response of the specified HttpStatus and closes the stream.

Parameters:

mediaType - the MediaType of the response content

content - the content of the response

respond

default void respond(HttpStatus status,
                     MediaType mediaType,
                     String format,
                     Object... args)

Writes the HTTP response of the specified HttpStatus and closes the stream. 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

respond

default void respond(HttpStatus status,
                     MediaType mediaType,
                     byte[] content)

Writes the HTTP response of the specified HttpStatus and closes the stream.

Parameters:

mediaType - the MediaType of the response content

content - the content of the response

respond

default void respond(HttpStatus status,
                     MediaType mediaType,
                     byte[] content,
                     int offset,
                     int length)

Writes the HTTP response of the specified HttpStatus and closes the stream.

Parameters:

mediaType - the MediaType of the response content

content - the content of the response

offset - the start offset of content

length - the length of content

respond

default void respond(HttpStatus status,
                     MediaType mediaType,
                     HttpData content)

Writes the HTTP response of the specified HttpStatus and closes the stream.

Parameters:

mediaType - the MediaType of the response content

content - the content of the response

respond

default void respond(HttpStatus status,
                     MediaType mediaType,
                     HttpData content,
                     HttpHeaders trailingHeaders)

Writes the HTTP response of the specified HttpStatus and closes the stream.

Parameters:

mediaType - the MediaType of the response content

content - the content of the response

trailingHeaders - the trailing HTTP headers

respond

default void respond(AggregatedHttpMessage res)

Writes the specified HTTP response and closes the stream.