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

Class DeferredResultMethodReturnValueHandler

java.lang.Object

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

All Implemented Interfaces:

AsyncHandlerMethodReturnValueHandler, HandlerMethodReturnValueHandler

public class DeferredResultMethodReturnValueHandler
extends java.lang.Object
implements AsyncHandlerMethodReturnValueHandler

Handler for return values of type DeferredResult, ListenableFuture, CompletionStage and any other async type with a registered adapter.

Since:

3.2

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DeferredResultMethodReturnValueHandler.CompletionStageAdapter Adapter for CompletionStage return values.
private static class	DeferredResultMethodReturnValueHandler.ListenableFutureAdapter Adapter for ListenableFuture return values.
private static class	DeferredResultMethodReturnValueHandler.SimpleDeferredResultAdapter Adapter for DeferredResult return values.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.Class<?>,DeferredResultAdapter>	adapterMap

Constructor Summary

Constructors

Constructor and Description
DeferredResultMethodReturnValueHandler()

Method Summary

Modifier and Type	Method and Description
private DeferredResultAdapter	getAdapterFor(java.lang.Class<?> type)
java.util.Map<java.lang.Class<?>,DeferredResultAdapter>	getAdapterMap() Return the map with DeferredResult 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

adapterMap

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

Constructor Detail

DeferredResultMethodReturnValueHandler

public DeferredResultMethodReturnValueHandler()

Method Detail

getAdapterMap

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

Return the map with DeferredResult adapters.

By default the map contains adapters for DeferredResult, which simply downcasts, ListenableFuture, and CompletionStage.

Returns:

the map of adapters

getAdapterFor

private DeferredResultAdapter 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