org.springframework.web.servlet.mvc.method.annotation.support
Class RequestResponseBodyMethodProcessor

java.lang.Object
  extended by org.springframework.web.servlet.mvc.method.annotation.support.AbstractMessageConverterMethodProcessor
      extended by org.springframework.web.servlet.mvc.method.annotation.support.RequestResponseBodyMethodProcessor
All Implemented Interfaces:
HandlerMethodArgumentResolver, HandlerMethodReturnValueHandler

public class RequestResponseBodyMethodProcessor
extends AbstractMessageConverterMethodProcessor

Resolves method arguments annotated with @RequestBody and handles return values from methods annotated with ResponseBody.

An @RequestBody method argument will be validated if annotated with @Valid. A Validator instance can be configured globally in XML configuration with the Spring MVC namespace or in Java-based configuration with @EnableWebMvc.

Since:
3.1
Author:
Arjen Poutsma, Rossen Stoyanchev

Field Summary
 
Fields inherited from class org.springframework.web.servlet.mvc.method.annotation.support.AbstractMessageConverterMethodProcessor
logger
 
Constructor Summary
RequestResponseBodyMethodProcessor(List<HttpMessageConverter<?>> messageConverters)
           
 
Method Summary
 void handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest)
          Handle the given return value by adding attributes to the model, setting the view (or view name), or by writing to the response.
 Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory)
          Resolves a method parameter into an argument value from a given request.
protected  boolean shouldValidate(MethodParameter parameter, Object argumentValue)
          Whether to validate the given @RequestBody method argument.
 boolean supportsParameter(MethodParameter parameter)
          Whether the given method parameter is supported by this resolver.
 boolean supportsReturnType(MethodParameter returnType)
          Whether the given method return type is supported by this handler.
 
Methods inherited from class org.springframework.web.servlet.mvc.method.annotation.support.AbstractMessageConverterMethodProcessor
createInputMessage, createOutputMessage, getProducibleMediaTypes, readWithMessageConverters, writeWithMessageConverters, writeWithMessageConverters
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RequestResponseBodyMethodProcessor

public RequestResponseBodyMethodProcessor(List<HttpMessageConverter<?>> messageConverters)
Method Detail

supportsParameter

public boolean supportsParameter(MethodParameter parameter)
Description copied from interface: HandlerMethodArgumentResolver
Whether the given method parameter is supported by this resolver.

Parameters:
parameter - the method parameter to check
Returns:
true if this resolver supports the supplied parameter; false otherwise

supportsReturnType

public boolean supportsReturnType(MethodParameter returnType)
Description copied from interface: HandlerMethodReturnValueHandler
Whether the given method return type is supported by this handler.

Parameters:
returnType - the method return type to check
Returns:
true if this handler supports the supplied return type; false otherwise

resolveArgument

public Object resolveArgument(MethodParameter parameter,
                              ModelAndViewContainer mavContainer,
                              NativeWebRequest webRequest,
                              WebDataBinderFactory binderFactory)
                       throws Exception
Description copied from interface: HandlerMethodArgumentResolver
Resolves a method parameter into an argument value from a given request. A ModelAndViewContainer provides access to the model for the request. A WebDataBinderFactory provides a way to create a WebDataBinder instance when needed for data binding and type conversion purposes.

Parameters:
parameter - the method parameter to resolve. This parameter must have previously been passed to HandlerMethodArgumentResolver.supportsParameter(org.springframework.core.MethodParameter) and it 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

shouldValidate

protected boolean shouldValidate(MethodParameter parameter,
                                 Object argumentValue)
Whether to validate the given @RequestBody method argument. The default implementation checks if the parameter is also annotated with @Valid.

Parameters:
parameter - the method argument for which to check if validation is needed
argumentValue - the method argument value (instantiated with a message converter)
Returns:
true if validation should be invoked, false otherwise.

handleReturnValue

public void handleReturnValue(Object returnValue,
                              MethodParameter returnType,
                              ModelAndViewContainer mavContainer,
                              NativeWebRequest webRequest)
                       throws IOException,
                              HttpMediaTypeNotAcceptableException
Description copied from interface: HandlerMethodReturnValueHandler
Handle the given return value by adding attributes to the model, setting the view (or view name), or by writing to the response. HandlerMethodReturnValueHandler implementations should also consider whether to set ModelAndViewContainer.setResolveView(boolean), which is set to true by default and therefore needs to be set to false explicitly if view resolution is to be bypassed.

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) and it must have returned true
mavContainer - the ModelAndViewContainer for the current request
webRequest - the current request
Throws:
IOException
HttpMediaTypeNotAcceptableException