Package org.springframework.web.reactive.result.method.annotation

Class RequestHeaderMethodArgumentResolver

java.lang.Object

org.springframework.web.reactive.result.method.HandlerMethodArgumentResolverSupport

org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver

org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver

org.springframework.web.reactive.result.method.annotation.RequestHeaderMethodArgumentResolver

All Implemented Interfaces:

HandlerMethodArgumentResolver, SyncHandlerMethodArgumentResolver

public class RequestHeaderMethodArgumentResolver
extends AbstractNamedValueSyncArgumentResolver

Resolves method arguments annotated with @RequestHeader except for Map arguments. See RequestHeaderMapMethodArgumentResolver for details on Map arguments annotated with @RequestHeader.

An @RequestHeader is a named value resolved from a request header. It has a required flag and a default value to fall back on when the request header does not exist.

A ConversionService is invoked to apply type conversion to resolved request header values that don't yet match the method parameter type.

Since:

5.0

Author:

Rossen Stoyanchev

See Also:

• RequestHeaderMapMethodArgumentResolver

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver

AbstractNamedValueArgumentResolver.NamedValueInfo

Field Summary

Fields inherited from class org.springframework.web.reactive.result.method.HandlerMethodArgumentResolverSupport

logger

Constructor Summary

Constructors

Constructor	Description
RequestHeaderMethodArgumentResolver(ConfigurableBeanFactory factory, ReactiveAdapterRegistry registry)	Create a new RequestHeaderMethodArgumentResolver instance.

Method Summary

Modifier and Type	Method	Description
protected AbstractNamedValueArgumentResolver.NamedValueInfo	createNamedValueInfo(MethodParameter parameter)	Create the AbstractNamedValueArgumentResolver.NamedValueInfo object for the given method parameter.
protected void	handleMissingValue(String name, MethodParameter parameter)	Invoked when a named value is required, but AbstractNamedValueArgumentResolver.resolveName(String, MethodParameter, ServerWebExchange) returned null and there is no default value.
protected Object	resolveNamedValue(String name, MethodParameter parameter, ServerWebExchange exchange)	Actually resolve the value synchronously.
boolean	supportsParameter(MethodParameter param)	Whether this resolver supports the given method parameter.

Methods inherited from class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver

resolveArgument, resolveArgumentValue, resolveName

Methods inherited from class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver

handleMissingValue, handleResolvedValue

Methods inherited from class org.springframework.web.reactive.result.method.HandlerMethodArgumentResolverSupport

checkAnnotatedParamNoReactiveWrapper, checkParameterType, checkParameterTypeNoReactiveWrapper, getAdapterRegistry

Methods inherited from class java.lang.Object

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

Constructor Details

RequestHeaderMethodArgumentResolver

public RequestHeaderMethodArgumentResolver(@Nullable
 ConfigurableBeanFactory factory,
 ReactiveAdapterRegistry registry)

Create a new RequestHeaderMethodArgumentResolver instance.

Parameters:

factory - a bean factory to use for resolving ${...} placeholder and #{...} SpEL expressions in default values; or null if default values are not expected to have expressions

registry - for checking reactive type wrappers

Method Details

supportsParameter

public boolean supportsParameter(MethodParameter param)

Description copied from interface: HandlerMethodArgumentResolver

Whether this resolver supports the given method parameter.

Parameters:

param - the method parameter

createNamedValueInfo

protected AbstractNamedValueArgumentResolver.NamedValueInfo createNamedValueInfo(MethodParameter parameter)

Description copied from class: AbstractNamedValueArgumentResolver

Create the AbstractNamedValueArgumentResolver.NamedValueInfo object for the given method parameter. Implementations typically retrieve the method annotation by means of MethodParameter.getParameterAnnotation(Class).

Specified by:

createNamedValueInfo in class AbstractNamedValueArgumentResolver

Parameters:

parameter - the method parameter

Returns:

the named value information

resolveNamedValue

@Nullable
protected Object resolveNamedValue(String name,
 MethodParameter parameter,
 ServerWebExchange exchange)

Description copied from class: AbstractNamedValueSyncArgumentResolver

Actually resolve the value synchronously.

Specified by:

resolveNamedValue in class AbstractNamedValueSyncArgumentResolver

handleMissingValue

protected void handleMissingValue(String name,
 MethodParameter parameter)

Description copied from class: AbstractNamedValueArgumentResolver

Invoked when a named value is required, but AbstractNamedValueArgumentResolver.resolveName(String, MethodParameter, ServerWebExchange) returned null and there is no default value. Subclasses typically throw an exception in this case.

Overrides:

handleMissingValue in class AbstractNamedValueArgumentResolver

Parameters:

name - the name for the value

parameter - the method parameter