com.linecorp.armeria.common

Interface HttpResponseWriter

All Superinterfaces:

HttpResponse, org.reactivestreams.Publisher<HttpObject>, Response, StreamMessage<HttpObject>, StreamWriter<HttpObject>

All Known Implementing Classes:

DefaultHttpResponse

public interface HttpResponseWriter
extends HttpResponse, StreamWriter<HttpObject>

An HttpResponse that can have HttpObjects written to it.

Method Summary

Modifier and Type	Method and Description
default void	close(AggregatedHttpResponse res) Writes the specified HTTP response and closes the stream.
default void	respond(HttpStatus status) Deprecated. Use HttpResponse.of(HttpStatus).
default void	respond(HttpStatus status, MediaType mediaType, byte[] content) Deprecated. Use HttpResponse.of(HttpStatus, MediaType, byte[]).
default void	respond(HttpStatus status, MediaType mediaType, HttpData content) Deprecated. Use HttpResponse.of(HttpStatus, MediaType, HttpData).
default void	respond(HttpStatus status, MediaType mediaType, HttpData content, HttpHeaders trailers) Deprecated. Use HttpResponse.of(HttpStatus, MediaType, HttpData, HttpHeaders).
default void	respond(HttpStatus status, MediaType mediaType, String content) Deprecated. Use HttpResponse.of(HttpStatus, MediaType, String).
default void	respond(HttpStatus status, MediaType mediaType, String format, Object... args) Deprecated. Use HttpResponse.of(HttpStatus, MediaType, String, Object...).
default void	respond(int statusCode) Deprecated. Use HttpResponse.of(int).

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

aggregate, aggregate, aggregateWithPooledObjects, aggregateWithPooledObjects, closeFuture, completionFuture, delayed, delayed, delayed, delayed, from, from, of, of, of, of, of, of, of, of, of, of, of, of, of, of, of, of, of, of, ofFailed, ofFailure, streaming, toDuplicator, toDuplicator, toDuplicator, toDuplicator, whenComplete

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

abort, abort, defaultSubscriberExecutor, drainAll, drainAll, drainAll, drainAll, isComplete, isEmpty, isOpen, of, subscribe, subscribe, subscribe, subscribe

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

close, close, close, isOpen, onDemand, tryWrite, tryWrite, whenConsumed, write, write

Method Detail

respond

@Deprecated
default void respond(int statusCode)

Deprecated. Use HttpResponse.of(int).

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

respond

@Deprecated
default void respond(HttpStatus status)

Deprecated. Use HttpResponse.of(HttpStatus).

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

respond

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

Deprecated. Use HttpResponse.of(HttpStatus, MediaType, String).

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

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

Deprecated. Use HttpResponse.of(HttpStatus, MediaType, String, Object...).

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

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

Deprecated. Use HttpResponse.of(HttpStatus, MediaType, byte[]).

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

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

Deprecated. Use HttpResponse.of(HttpStatus, MediaType, HttpData).

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

@Deprecated
default void respond(HttpStatus status,
                                 MediaType mediaType,
                                 HttpData content,
                                 HttpHeaders trailers)

Deprecated. Use HttpResponse.of(HttpStatus, MediaType, HttpData, HttpHeaders).

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

trailers - the HTTP trailers

close

default void close(AggregatedHttpResponse res)

Writes the specified HTTP response and closes the stream.