Class ResponseLifecycle

java.lang.Object

io.micronaut.http.server.ResponseLifecycle

@Internal
public abstract class ResponseLifecycle
extends Object

This class handles encoding of the HTTP response in a server-agnostic way. Note that while this class is internal, it is used from servlet and must not be broken.

Since:

4.8.0

Author:

Jonas Konrad

Constructor Summary

Constructors

Constructor	Description
ResponseLifecycle(RouteExecutor routeExecutor, MessageBodyHandlerRegistry messageBodyHandlerRegistry, ConversionService conversionService, ByteBodyFactory byteBodyFactory)

Method Summary

Modifier and Type	Method	Description
protected CloseableByteBody	concatenate(Publisher<ByteBody> items)
protected CloseableByteBody	concatenateJson(Publisher<ByteBody> items)
final ExecutionFlow<? extends ByteBodyHttpResponse<?>>	encodeHttpResponseSafe(HttpRequest<?> httpRequest, HttpResponse<?> response)	Encode the response.
protected ExecutionFlow<? extends ByteBodyHttpResponse<?>>	encodeNoBody(HttpResponse<?> response)	Encode the given response without body, either because it has none or because this is a HEAD response.
protected final ExecutionFlow<? extends ByteBodyHttpResponse<?>>	handleStreamingError(HttpRequest<?> request, Throwable t)	Handle an error that happened before the first item of a streaming response.
protected abstract Executor	ioExecutor()	The IO executor for blocking writers.
protected <T> ResponseBodyWriter<T>	wrap(MessageBodyWriter<T> messageBodyWriter)	Transform the given writer into a ResponseBodyWriter.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ResponseLifecycle

public ResponseLifecycle(RouteExecutor routeExecutor,
 MessageBodyHandlerRegistry messageBodyHandlerRegistry,
 ConversionService conversionService,
 ByteBodyFactory byteBodyFactory)

Method Details

ioExecutor

protected abstract Executor ioExecutor()

The IO executor for blocking writers.

Returns:

The blocking executor

wrap

protected <T> ResponseBodyWriter<T> wrap(MessageBodyWriter<T> messageBodyWriter)

Transform the given writer into a ResponseBodyWriter.

Type Parameters:

T - The writer type

Parameters:

messageBodyWriter - The writer

Returns:

The response writer

encodeHttpResponseSafe

public final ExecutionFlow<? extends ByteBodyHttpResponse<?>> encodeHttpResponseSafe(HttpRequest<?> httpRequest,
 HttpResponse<?> response)

Encode the response.

Parameters:

httpRequest - The request that triggered this response

response - The unencoded response

Returns:

The encoded response

encodeNoBody

protected ExecutionFlow<? extends ByteBodyHttpResponse<?>> encodeNoBody(HttpResponse<?> response)

Encode the given response without body, either because it has none or because this is a HEAD response.

Parameters:

response - The response

Returns:

The encoded response

concatenate

protected CloseableByteBody concatenate(Publisher<ByteBody> items)

Parameters:

items - The items

Returns:

The concatenated body

See Also:

• ConcatenatingSubscriber.concatenate(ByteBodyFactory, Publisher, ConcatenatingSubscriber.Separators)

concatenateJson

protected CloseableByteBody concatenateJson(Publisher<ByteBody> items)

Parameters:

items - The items

Returns:

The concatenated body

See Also:

• ConcatenatingSubscriber.concatenate(ByteBodyFactory, Publisher, ConcatenatingSubscriber.Separators)

handleStreamingError

protected final ExecutionFlow<? extends ByteBodyHttpResponse<?>> handleStreamingError(HttpRequest<?> request,
 Throwable t)

Handle an error that happened before the first item of a streaming response.

Parameters:

request - The request

t - The error

Returns:

The encoded error response