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

Class ResponseBodyResultHandler

java.lang.Object

org.springframework.web.reactive.result.AbstractHandlerResultHandler

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

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

All Implemented Interfaces:

Ordered, HandlerResultHandler

public class ResponseBodyResultHandler
extends AbstractMessageWriterResultHandler
implements HandlerResultHandler

HandlerResultHandler that handles return values from methods annotated with @ResponseBody writing to the body of the request or response with an HttpMessageWriter.

By default the order for this result handler is set to 100. As it detects the presence of @ResponseBody it should be ordered after result handlers that look for a specific return type. Note however that this handler does recognize and explicitly ignores the ResponseEntity return type.

Since:

5.0

Author:

Rossen Stoyanchev, Stephane Maldini, Sebastien Deleuze, Arjen Poutsma

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ResponseBodyResultHandler(java.util.List<HttpMessageWriter<?>> messageWriters, RequestedContentTypeResolver contentTypeResolver) Constructor with HttpMessageWriters and a RequestedContentTypeResolver.
ResponseBodyResultHandler(java.util.List<HttpMessageWriter<?>> messageWriters, RequestedContentTypeResolver contentTypeResolver, ReactiveAdapterRegistry adapterRegistry) Constructor with an additional ReactiveAdapterRegistry.

Method Summary

Modifier and Type	Method and Description
<any>	handleResult(ServerWebExchange exchange, HandlerResult result) Process the given result modifying response headers and/or writing data to the response.
private boolean	hasResponseBodyAnnotation(MethodParameter parameter)
private boolean	isHttpEntityType(HandlerResult result)
boolean	supports(HandlerResult result) Whether this handler supports the given HandlerResult.

Methods inherited from class org.springframework.web.reactive.result.method.annotation.AbstractMessageWriterResultHandler

getMessageWriters, writeBody

Methods inherited from class org.springframework.web.reactive.result.AbstractHandlerResultHandler

getAdapterRegistry, getContentTypeResolver, getOrder, selectMediaType, setOrder

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseBodyResultHandler

public ResponseBodyResultHandler(java.util.List<HttpMessageWriter<?>> messageWriters,
                                 RequestedContentTypeResolver contentTypeResolver)

Constructor with HttpMessageWriters and a RequestedContentTypeResolver.

Parameters:

messageWriters - writers for serializing to the response body stream

contentTypeResolver - for resolving the requested content type

ResponseBodyResultHandler

public ResponseBodyResultHandler(java.util.List<HttpMessageWriter<?>> messageWriters,
                                 RequestedContentTypeResolver contentTypeResolver,
                                 ReactiveAdapterRegistry adapterRegistry)

Constructor with an additional ReactiveAdapterRegistry.

Parameters:

messageWriters - writers for serializing to the response body stream

contentTypeResolver - for resolving the requested content type

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

Method Detail

supports

public boolean supports(HandlerResult result)

Description copied from interface: HandlerResultHandler

Whether this handler supports the given HandlerResult.

Specified by:

supports in interface HandlerResultHandler

Parameters:

result - result object to check

Returns:

whether or not this object can use the given result

hasResponseBodyAnnotation

private boolean hasResponseBodyAnnotation(MethodParameter parameter)

isHttpEntityType

private boolean isHttpEntityType(HandlerResult result)

handleResult

public <any> handleResult(ServerWebExchange exchange,
                          HandlerResult result)

Description copied from interface: HandlerResultHandler

Process the given result modifying response headers and/or writing data to the response.

Specified by:

handleResult in interface HandlerResultHandler

Parameters:

exchange - current server exchange

result - the result from the handling

Returns:

Mono<Void> to indicate when request handling is complete.