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

Class HttpEntityMethodProcessor

java.lang.Object

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

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

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

All Implemented Interfaces:

org.springframework.web.method.support.HandlerMethodArgumentResolver, org.springframework.web.method.support.HandlerMethodReturnValueHandler

public class HttpEntityMethodProcessor
extends AbstractMessageConverterMethodProcessor

Resolves HttpEntity and RequestEntity method argument values and also handles HttpEntity and ResponseEntity return values.

An HttpEntity return type has a specific purpose. Therefore this handler should be configured ahead of handlers that support any return value type annotated with @ModelAttribute or @ResponseBody to ensure they don't take over.

Since:

3.1

Author:

Arjen Poutsma, Rossen Stoyanchev

Field Summary

Fields inherited from class org.springframework.web.servlet.mvc.method.annotation.AbstractMessageConverterMethodArgumentResolver

allSupportedMediaTypes, logger, messageConverters

Constructor Summary

Constructors

Constructor and Description
HttpEntityMethodProcessor(java.util.List<org.springframework.http.converter.HttpMessageConverter<?>> messageConverters)
HttpEntityMethodProcessor(java.util.List<org.springframework.http.converter.HttpMessageConverter<?>> messageConverters, org.springframework.web.accept.ContentNegotiationManager contentNegotiationManager)
HttpEntityMethodProcessor(java.util.List<org.springframework.http.converter.HttpMessageConverter<?>> messageConverters, org.springframework.web.accept.ContentNegotiationManager contentNegotiationManager, java.util.List<java.lang.Object> responseBodyAdvice)

Method Summary

Modifier and Type	Method and Description
protected java.lang.Class<?>	getReturnValueType(java.lang.Object returnValue, org.springframework.core.MethodParameter returnType) Return the type of the value to be written to the response.
void	handleReturnValue(java.lang.Object returnValue, org.springframework.core.MethodParameter returnType, org.springframework.web.method.support.ModelAndViewContainer mavContainer, org.springframework.web.context.request.NativeWebRequest webRequest)
java.lang.Object	resolveArgument(org.springframework.core.MethodParameter parameter, org.springframework.web.method.support.ModelAndViewContainer mavContainer, org.springframework.web.context.request.NativeWebRequest webRequest, org.springframework.web.bind.support.WebDataBinderFactory binderFactory)
boolean	supportsParameter(org.springframework.core.MethodParameter parameter)
boolean	supportsReturnType(org.springframework.core.MethodParameter returnType)

Methods inherited from class org.springframework.web.servlet.mvc.method.annotation.AbstractMessageConverterMethodProcessor

createOutputMessage, getAdviceChain, getProducibleMediaTypes, writeWithMessageConverters, writeWithMessageConverters

Methods inherited from class org.springframework.web.servlet.mvc.method.annotation.AbstractMessageConverterMethodArgumentResolver

createInputMessage, readWithMessageConverters, readWithMessageConverters

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpEntityMethodProcessor

public HttpEntityMethodProcessor(java.util.List<org.springframework.http.converter.HttpMessageConverter<?>> messageConverters)

HttpEntityMethodProcessor

public HttpEntityMethodProcessor(java.util.List<org.springframework.http.converter.HttpMessageConverter<?>> messageConverters,
                                 org.springframework.web.accept.ContentNegotiationManager contentNegotiationManager)

HttpEntityMethodProcessor

public HttpEntityMethodProcessor(java.util.List<org.springframework.http.converter.HttpMessageConverter<?>> messageConverters,
                                 org.springframework.web.accept.ContentNegotiationManager contentNegotiationManager,
                                 java.util.List<java.lang.Object> responseBodyAdvice)

Method Detail

supportsParameter

public boolean supportsParameter(org.springframework.core.MethodParameter parameter)

supportsReturnType

public boolean supportsReturnType(org.springframework.core.MethodParameter returnType)

resolveArgument

public java.lang.Object resolveArgument(org.springframework.core.MethodParameter parameter,
                                        org.springframework.web.method.support.ModelAndViewContainer mavContainer,
                                        org.springframework.web.context.request.NativeWebRequest webRequest,
                                        org.springframework.web.bind.support.WebDataBinderFactory binderFactory)
                                 throws java.io.IOException,
                                        org.springframework.web.HttpMediaTypeNotSupportedException

Throws:

java.io.IOException

org.springframework.web.HttpMediaTypeNotSupportedException

handleReturnValue

public void handleReturnValue(java.lang.Object returnValue,
                              org.springframework.core.MethodParameter returnType,
                              org.springframework.web.method.support.ModelAndViewContainer mavContainer,
                              org.springframework.web.context.request.NativeWebRequest webRequest)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getReturnValueType

protected java.lang.Class<?> getReturnValueType(java.lang.Object returnValue,
                                                org.springframework.core.MethodParameter returnType)

Description copied from class: AbstractMessageConverterMethodProcessor

Return the type of the value to be written to the response. Typically this is a simple check via getClass on the returnValue but if the returnValue is null, then the returnType needs to be examined possibly including generic type determination (e.g. ResponseEntity<T>).

Overrides:

getReturnValueType in class AbstractMessageConverterMethodProcessor