程序包 cn.taketoday.web.bind.resolver

类 HttpEntityMethodProcessor

java.lang.Object

cn.taketoday.web.bind.resolver.AbstractMessageConverterMethodArgumentResolver

cn.taketoday.web.bind.resolver.AbstractMessageConverterMethodProcessor

cn.taketoday.web.bind.resolver.HttpEntityMethodProcessor

所有已实现的接口:

ParameterResolvingStrategy, HandlerMethodReturnValueHandler, ReturnValueHandler

public class HttpEntityMethodProcessor
extends AbstractMessageConverterMethodProcessor
implements HandlerMethodReturnValueHandler

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.

从以下版本开始:

4.0 2022/1/23 17:43

作者:

Arjen Poutsma, Rossen Stoyanchev, Brian Clozel, Sam Brannen, Harry Yang

嵌套类概要

从类继承的嵌套类/接口 cn.taketoday.web.bind.resolver.AbstractMessageConverterMethodProcessor

AbstractMessageConverterMethodProcessor.ServletDelegate

字段概要

字段

修饰符和类型	字段	说明
private final RedirectModelManager	redirectModelManager

从类继承的字段 cn.taketoday.web.bind.resolver.AbstractMessageConverterMethodArgumentResolver

messageConverters

从接口继承的字段 cn.taketoday.web.ReturnValueHandler

NONE_RETURN_VALUE

构造器概要

构造器

构造器	说明
HttpEntityMethodProcessor(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager, RedirectModelManager redirectModelManager)	Basic constructor with converters and ContentNegotiationManager.
HttpEntityMethodProcessor(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager, List<Object> requestResponseBodyAdvice, RedirectModelManager redirectModelManager)	Complete constructor for resolving HttpEntity and handling ResponseEntity.
HttpEntityMethodProcessor(List<HttpMessageConverter<?>> converters, RedirectModelManager redirectModelManager)	Basic constructor with converters only.
HttpEntityMethodProcessor(List<HttpMessageConverter<?>> converters, List<Object> requestResponseBodyAdvice, RedirectModelManager redirectModelManager)	Complete constructor for resolving HttpEntity method arguments.

方法概要

修饰符和类型	方法	说明
private Type	getHttpEntityType(cn.taketoday.core.MethodParameter parameter)
protected Class<?>	getReturnValueType(Object returnValue, cn.taketoday.core.MethodParameter returnType)	Return the type of the value to be written to the response.
private List<String>	getVaryRequestHeadersToAdd(HttpHeaders responseHeaders, HttpHeaders entityHeaders)
void	handleReturnValue(RequestContext context, Object handler, Object returnValue)	Handle result of the handler
private boolean	isResourceNotModified(RequestContext context, HttpMethod method)
Object	resolveArgument(RequestContext context, ResolvableMethodParameter resolvable)	Resolve parameter
private void	saveRedirectAttributes(RequestContext request, String location)
boolean	supportsHandlerMethod(HandlerMethod handlerMethod)	Whether the given method is supported by this handler.
boolean	supportsParameter(ResolvableMethodParameter resolvable)	Whether the given parameter is supported by this resolver.
boolean	supportsReturnValue(Object returnValue)	If this ReturnValueHandler supports the target handler's result

从类继承的方法 cn.taketoday.web.bind.resolver.AbstractMessageConverterMethodProcessor

getProducibleMediaTypes, getProducibleMediaTypes, isResourceType, writeWithMessageConverters

从类继承的方法 cn.taketoday.web.bind.resolver.AbstractMessageConverterMethodArgumentResolver

adaptArgumentIfNecessary, closeStreamIfNecessary, getAdvice, getSupportedMediaTypes, isBindExceptionRequired, readWithMessageConverters, readWithMessageConverters, validateIfApplicable, validateIfApplicable

从类继承的方法 java.lang.Object

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

从接口继承的方法 cn.taketoday.web.handler.result.HandlerMethodReturnValueHandler

handleHandlerMethodReturnValue, supportsHandler

字段详细资料

redirectModelManager

@Nullable
private final RedirectModelManager redirectModelManager

构造器详细资料

HttpEntityMethodProcessor

public HttpEntityMethodProcessor(List<HttpMessageConverter<?>> converters,
 @Nullable
 RedirectModelManager redirectModelManager)

Basic constructor with converters only. Suitable for resolving HttpEntity. For handling ResponseEntity consider also providing a ContentNegotiationManager.

HttpEntityMethodProcessor

public HttpEntityMethodProcessor(List<HttpMessageConverter<?>> converters,
 @Nullable
 ContentNegotiationManager manager,
 @Nullable
 RedirectModelManager redirectModelManager)

Basic constructor with converters and ContentNegotiationManager. Suitable for resolving HttpEntity and handling ResponseEntity without Request~ or ResponseBodyAdvice.

HttpEntityMethodProcessor

public HttpEntityMethodProcessor(List<HttpMessageConverter<?>> converters,
 @Nullable
 List<Object> requestResponseBodyAdvice,
 @Nullable
 RedirectModelManager redirectModelManager)

Complete constructor for resolving HttpEntity method arguments. For handling ResponseEntity consider also providing a ContentNegotiationManager.

HttpEntityMethodProcessor

public HttpEntityMethodProcessor(List<HttpMessageConverter<?>> converters,
 @Nullable
 ContentNegotiationManager manager,
 List<Object> requestResponseBodyAdvice,
 @Nullable
 RedirectModelManager redirectModelManager)

Complete constructor for resolving HttpEntity and handling ResponseEntity.

方法详细资料

supportsParameter

public boolean supportsParameter(ResolvableMethodParameter resolvable)

从接口复制的说明: ParameterResolvingStrategy

Whether the given parameter is supported by this resolver.

static match

指定者:

supportsParameter 在接口中 ParameterResolvingStrategy

resolveArgument

@Nullable
public Object resolveArgument(RequestContext context,
 ResolvableMethodParameter resolvable)
                       throws IOException,
HttpMediaTypeNotSupportedException

从接口复制的说明: ParameterResolvingStrategy

Resolve parameter

指定者:

resolveArgument 在接口中 ParameterResolvingStrategy

参数:

context - Current request context

resolvable - resolvable parameter

返回:

method parameter instance

抛出:

IOException

HttpMediaTypeNotSupportedException

另请参阅:

• MethodParameterResolvingException

getHttpEntityType

@Nullable
private Type getHttpEntityType(cn.taketoday.core.MethodParameter parameter)

supportsReturnValue

public boolean supportsReturnValue(@Nullable
 Object returnValue)

从接口复制的说明: ReturnValueHandler

If this ReturnValueHandler supports the target handler's result

This method can test this ReturnValueHandler supports the target handler in application runtime

指定者:

supportsReturnValue 在接口中 ReturnValueHandler

参数:

returnValue - Target handler's return-value or result

返回:

If this ReturnValueHandler supports the target handler's result

supportsHandlerMethod

public boolean supportsHandlerMethod(HandlerMethod handlerMethod)

从接口复制的说明: HandlerMethodReturnValueHandler

Whether the given method is supported by this handler.

指定者:

supportsHandlerMethod 在接口中 HandlerMethodReturnValueHandler

返回:

true if this handler supports the supplied return type; false otherwise

另请参阅:

• HandlerMethod

handleReturnValue

public void handleReturnValue(RequestContext context,
 @Nullable
 Object handler,
 @Nullable
 Object returnValue)
                       throws Exception

从接口复制的说明: HandlerMethodReturnValueHandler

Handle result of the handler

指定者:

handleReturnValue 在接口中 HandlerMethodReturnValueHandler

指定者:

handleReturnValue 在接口中 ReturnValueHandler

参数:

context - Current HTTP request context

handler - handler may be HandlerMethod

returnValue - Handler execution result Or HandlerExceptionHandler return value

抛出:

Exception - return-value handled failed

getVaryRequestHeadersToAdd

private List<String> getVaryRequestHeadersToAdd(HttpHeaders responseHeaders,
 HttpHeaders entityHeaders)

isResourceNotModified

private boolean isResourceNotModified(RequestContext context,
 HttpMethod method)

saveRedirectAttributes

private void saveRedirectAttributes(RequestContext request,
 String location)

getReturnValueType

protected Class<?> getReturnValueType(@Nullable
 Object returnValue,
 @Nullable
 cn.taketoday.core.MethodParameter returnType)

从类复制的说明: AbstractMessageConverterMethodProcessor

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

覆盖:

getReturnValueType 在类中 AbstractMessageConverterMethodProcessor