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

Class ServletResponseMethodArgumentResolver

java.lang.Object

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

All Implemented Interfaces:

HandlerMethodArgumentResolver

public class ServletResponseMethodArgumentResolver
extends Object
implements HandlerMethodArgumentResolver

Resolves response-related method argument values of types:

• ServletResponse
• OutputStream
• Writer

Since:

3.1

Author:

Arjen Poutsma, Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
ServletResponseMethodArgumentResolver()

Method Summary

Modifier and Type	Method and Description
Object	resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Set ModelAndViewContainer.setRequestHandled(boolean) to false to indicate that the method signature provides access to the response.
boolean	supportsParameter(MethodParameter parameter) Whether the given method parameter is supported by this resolver.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletResponseMethodArgumentResolver

public ServletResponseMethodArgumentResolver()

Method Detail

supportsParameter

public boolean supportsParameter(MethodParameter parameter)

Description copied from interface: HandlerMethodArgumentResolver

Whether the given method parameter is supported by this resolver.

Specified by:

supportsParameter in interface HandlerMethodArgumentResolver

Parameters:

parameter - the method parameter to check

Returns:

true if this resolver supports the supplied parameter; false otherwise

resolveArgument

public Object resolveArgument(MethodParameter parameter,
                              ModelAndViewContainer mavContainer,
                              NativeWebRequest webRequest,
                              WebDataBinderFactory binderFactory)
                       throws Exception

Set ModelAndViewContainer.setRequestHandled(boolean) to false to indicate that the method signature provides access to the response. If subsequently the underlying method returns null, the request is considered directly handled.

Specified by:

resolveArgument in interface HandlerMethodArgumentResolver

Parameters:

parameter - the method parameter to resolve. This parameter must have previously been passed to HandlerMethodArgumentResolver.supportsParameter(org.springframework.core.MethodParameter) which must have returned true.

mavContainer - the ModelAndViewContainer for the current request

webRequest - the current request

binderFactory - a factory for creating WebDataBinder instances

Returns:

the resolved argument value, or null

Throws:

Exception - in case of errors with the preparation of argument values