Package org.springframework.web.servlet.mvc.method.annotation

Class ResponseEntityReturnValueHandler

java.lang.Object

org.springframework.web.servlet.mvc.method.annotation.ResponseEntityReturnValueHandler

All Implemented Interfaces:

HandlerMethodReturnValueHandler

public class ResponseEntityReturnValueHandler
extends Object
implements HandlerMethodReturnValueHandler

Handler for return values of type ResponseEntity that delegates to one of the following:

• HttpEntityMethodProcessor for responses with a concrete body value
• ResponseBodyEmitterReturnValueHandler for responses with a body that is a ResponseBodyEmitter or an async/reactive type.

Use of this wrapper allows for late check in handleReturnValue(java.lang.Object, org.springframework.core.MethodParameter, org.springframework.web.method.support.ModelAndViewContainer, org.springframework.web.context.request.NativeWebRequest) of the type of the actual body value in case the method signature does not provide enough information to decide via supportsReturnType(org.springframework.core.MethodParameter).

Since:

6.2.9

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor	Description
ResponseEntityReturnValueHandler(HttpEntityMethodProcessor httpEntityMethodProcessor, ResponseBodyEmitterReturnValueHandler responseBodyEmitterHandler)

Method Summary

Modifier and Type	Method	Description
void	handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest request)	Handle the given return value by adding attributes to the model and setting a view or setting the ModelAndViewContainer.setRequestHandled(boolean) flag to true to indicate the response has been handled directly.
boolean	supportsReturnType(MethodParameter returnType)	Whether the given method return type is supported by this handler.

Methods inherited from class java.lang.Object

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

Constructor Details

ResponseEntityReturnValueHandler

public ResponseEntityReturnValueHandler(HttpEntityMethodProcessor httpEntityMethodProcessor,
 ResponseBodyEmitterReturnValueHandler responseBodyEmitterHandler)

Method Details

supportsReturnType

public boolean supportsReturnType(MethodParameter returnType)

Description copied from interface: HandlerMethodReturnValueHandler

Whether the given method return type is supported by this handler.

Specified by:

supportsReturnType in interface HandlerMethodReturnValueHandler

Parameters:

returnType - the method return type to check

Returns:

true if this handler supports the supplied return type; false otherwise

handleReturnValue

public void handleReturnValue(@Nullable
 Object returnValue,
 MethodParameter returnType,
 ModelAndViewContainer mavContainer,
 NativeWebRequest request)
                       throws Exception

Description copied from interface: HandlerMethodReturnValueHandler

Handle the given return value by adding attributes to the model and setting a view or setting the ModelAndViewContainer.setRequestHandled(boolean) flag to true to indicate the response has been handled directly.

Specified by:

handleReturnValue in interface HandlerMethodReturnValueHandler

Parameters:

returnValue - the value returned from the handler method

returnType - the type of the return value. This type must have previously been passed to HandlerMethodReturnValueHandler.supportsReturnType(org.springframework.core.MethodParameter) which must have returned true.

mavContainer - the ModelAndViewContainer for the current request

request - the current request

Throws:

Exception - if the return value handling results in an error