Class AbstractMessageWriterResultHandler

java.lang.Object

org.springframework.web.reactive.result.HandlerResultHandlerSupport

org.springframework.web.reactive.result.method.annotation.AbstractMessageWriterResultHandler

All Implemented Interfaces:

Ordered

Direct Known Subclasses:

ResponseBodyResultHandler, ResponseEntityResultHandler

public abstract class AbstractMessageWriterResultHandler
extends HandlerResultHandlerSupport

Abstract base class for result handlers that handle return values by writing to the response with HttpMessageWriter.

Since:

5.0

Author:

Rossen Stoyanchev, Sebastien Deleuze

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	COROUTINES_FLOW_CLASS_NAME

Fields inherited from class HandlerResultHandlerSupport

logger

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMessageWriterResultHandler(List<HttpMessageWriter<?>> messageWriters, RequestedContentTypeResolver contentTypeResolver)	Constructor with HttpMessageWriters and a RequestedContentTypeResolver.
protected	AbstractMessageWriterResultHandler(List<HttpMessageWriter<?>> messageWriters, RequestedContentTypeResolver contentTypeResolver, ReactiveAdapterRegistry adapterRegistry)	Constructor with an additional ReactiveAdapterRegistry.
protected	AbstractMessageWriterResultHandler(List<HttpMessageWriter<?>> messageWriters, RequestedContentTypeResolver contentTypeResolver, ReactiveAdapterRegistry adapterRegistry, List<ErrorResponse.Interceptor> interceptors)	Variant of AbstractMessageWriterResultHandler(List, RequestedContentTypeResolver, ReactiveAdapterRegistry) with additional list of ErrorResponse.Interceptors for return value handling.

Method Summary

Modifier and Type	Method	Description
List<ErrorResponse.Interceptor>	getErrorResponseInterceptors()	Return the configured ErrorResponse.Interceptor's.
List<HttpMessageWriter<?>>	getMessageWriters()	Return the configured message converters.
protected void	invokeErrorResponseInterceptors(ProblemDetail detail, @Nullable ErrorResponse errorResponse)	Invoke the configured ErrorResponse.Interceptor's.
protected reactor.core.publisher.Mono<Void>	writeBody(@Nullable Object body, MethodParameter bodyParameter, @Nullable MethodParameter actualParam, ServerWebExchange exchange)	Write a given body to the response with HttpMessageWriter.
protected reactor.core.publisher.Mono<Void>	writeBody(@Nullable Object body, MethodParameter bodyParameter, ServerWebExchange exchange)	Write a given body to the response with HttpMessageWriter.

Methods inherited from class HandlerResultHandlerSupport

getAdapter, getAdapterRegistry, getContentTypeResolver, getOrder, selectMediaType, selectMediaType, setOrder

Methods inherited from class Object

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

Field Details

COROUTINES_FLOW_CLASS_NAME

protected static final String COROUTINES_FLOW_CLASS_NAME

See Also:

• Constant Field Values

Constructor Details

AbstractMessageWriterResultHandler

protected AbstractMessageWriterResultHandler(List<HttpMessageWriter<?>> messageWriters,
 RequestedContentTypeResolver contentTypeResolver)

Constructor with HttpMessageWriters and a RequestedContentTypeResolver.

Parameters:

messageWriters - for serializing Objects to the response body stream

contentTypeResolver - for resolving the requested content type

AbstractMessageWriterResultHandler

protected AbstractMessageWriterResultHandler(List<HttpMessageWriter<?>> messageWriters,
 RequestedContentTypeResolver contentTypeResolver,
 ReactiveAdapterRegistry adapterRegistry)

Constructor with an additional ReactiveAdapterRegistry.

Parameters:

messageWriters - for serializing Objects to the response body stream

contentTypeResolver - for resolving the requested content type

adapterRegistry - for adapting other reactive types (for example, rx.Observable, rx.Single, etc.) to Flux or Mono

AbstractMessageWriterResultHandler

protected AbstractMessageWriterResultHandler(List<HttpMessageWriter<?>> messageWriters,
 RequestedContentTypeResolver contentTypeResolver,
 ReactiveAdapterRegistry adapterRegistry,
 List<ErrorResponse.Interceptor> interceptors)

Variant of AbstractMessageWriterResultHandler(List, RequestedContentTypeResolver, ReactiveAdapterRegistry) with additional list of ErrorResponse.Interceptors for return value handling.

Since:

6.2

Method Details

getMessageWriters

public List<HttpMessageWriter<?>> getMessageWriters()

Return the configured message converters.

getErrorResponseInterceptors

public List<ErrorResponse.Interceptor> getErrorResponseInterceptors()

Return the configured ErrorResponse.Interceptor's.

Since:

6.2

invokeErrorResponseInterceptors

protected void invokeErrorResponseInterceptors(ProblemDetail detail,
 @Nullable ErrorResponse errorResponse)

Invoke the configured ErrorResponse.Interceptor's.

Since:

6.2

writeBody

protected reactor.core.publisher.Mono<Void> writeBody(@Nullable Object body,
 MethodParameter bodyParameter,
 ServerWebExchange exchange)

Write a given body to the response with HttpMessageWriter.

Parameters:

body - the object to write

bodyParameter - the MethodParameter of the body to write

exchange - the current exchange

Returns:

indicates completion or error

See Also:

• writeBody(Object, MethodParameter, MethodParameter, ServerWebExchange)

writeBody

protected reactor.core.publisher.Mono<Void> writeBody(@Nullable Object body,
 MethodParameter bodyParameter,
 @Nullable MethodParameter actualParam,
 ServerWebExchange exchange)

Write a given body to the response with HttpMessageWriter.

Parameters:

body - the object to write

bodyParameter - the MethodParameter of the body to write

actualParam - the actual return type of the method that returned the value; could be different from bodyParameter when processing HttpEntity for example

exchange - the current exchange

Returns:

indicates completion or error

Since:

5.0.2