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

Class ResponseBodyEmitterReturnValueHandler

java.lang.Object

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

All Implemented Interfaces:

AsyncHandlerMethodReturnValueHandler, HandlerMethodReturnValueHandler

public class ResponseBodyEmitterReturnValueHandler
extends java.lang.Object
implements AsyncHandlerMethodReturnValueHandler

Handler for return values of type ResponseBodyEmitter (and the ResponseEntity<ResponseBodyEmitter> sub-class) as well as any other async type with a registered adapter.

Since:

4.2

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ResponseBodyEmitterReturnValueHandler.HttpMessageConvertingHandler ResponseBodyEmitter.Handler that writes with HttpMessageConverter's.
private static class	ResponseBodyEmitterReturnValueHandler.SimpleResponseBodyEmitterAdapter Adapter for ResponseBodyEmitter return values.
private static class	ResponseBodyEmitterReturnValueHandler.StreamingServletServerHttpResponse Wrap to silently ignore header changes HttpMessageConverter's that would otherwise cause HttpHeaders to raise exceptions.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.Class<?>,ResponseBodyEmitterAdapter>	adapterMap
private static Log	logger
private java.util.List<HttpMessageConverter<?>>	messageConverters

Constructor Summary

Constructors

Constructor and Description
ResponseBodyEmitterReturnValueHandler(java.util.List<HttpMessageConverter<?>> messageConverters)

Method Summary

Modifier and Type	Method and Description
private ResponseBodyEmitterAdapter	getAdapterFor(java.lang.Class<?> type)
java.util.Map<java.lang.Class<?>,ResponseBodyEmitterAdapter>	getAdapterMap() Return the map with ResponseBodyEmitter adapters.
void	handleReturnValue(java.lang.Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) 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	isAsyncReturnValue(java.lang.Object returnValue, MethodParameter returnType) Whether the given return value represents asynchronous computation.
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

Field Detail

logger

private static final Log logger

messageConverters

private final java.util.List<HttpMessageConverter<?>> messageConverters

adapterMap

private final java.util.Map<java.lang.Class<?>,ResponseBodyEmitterAdapter> adapterMap

Constructor Detail

ResponseBodyEmitterReturnValueHandler

public ResponseBodyEmitterReturnValueHandler(java.util.List<HttpMessageConverter<?>> messageConverters)

Method Detail

getAdapterMap

public java.util.Map<java.lang.Class<?>,ResponseBodyEmitterAdapter> getAdapterMap()

Return the map with ResponseBodyEmitter adapters. By default the map contains a single adapter ResponseBodyEmitter that simply downcasts the return value.

Returns:

the map of adapters

getAdapterFor

private ResponseBodyEmitterAdapter getAdapterFor(java.lang.Class<?> type)

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

isAsyncReturnValue

public boolean isAsyncReturnValue(java.lang.Object returnValue,
                                  MethodParameter returnType)

Description copied from interface: AsyncHandlerMethodReturnValueHandler

Whether the given return value represents asynchronous computation.

Specified by:

isAsyncReturnValue in interface AsyncHandlerMethodReturnValueHandler

Parameters:

returnValue - the return value

returnType - the return type

Returns:

true if the return value is asynchronous.

handleReturnValue

public void handleReturnValue(java.lang.Object returnValue,
                              MethodParameter returnType,
                              ModelAndViewContainer mavContainer,
                              NativeWebRequest webRequest)
                       throws java.lang.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

webRequest - the current request

Throws:

java.lang.Exception - if the return value handling results in an error