Class RequestHeaderArgumentResolver

java.lang.Object

org.springframework.web.service.invoker.AbstractNamedValueArgumentResolver

org.springframework.web.service.invoker.RequestHeaderArgumentResolver

All Implemented Interfaces:

HttpServiceArgumentResolver

public class RequestHeaderArgumentResolver
extends AbstractNamedValueArgumentResolver

HttpServiceArgumentResolver for @RequestHeader annotated arguments.

The argument may be:

• Map<String, ?> or MultiValueMap<String, ?> with multiple headers and value(s).
• Collection or an array of header values.
• An individual header value.

Individual header values may be Strings or Objects to be converted to String values through the configured ConversionService.

If the value is required but null, IllegalArgumentException is raised. The value is not required if:

• RequestHeader.required() is set to false
• RequestHeader.defaultValue() provides a fallback value
• The argument is declared as Optional

Since:

6.0

Author:

Olga Maciaszek-Sharma, Rossen Stoyanchev

Nested Class Summary

Nested classes/interfaces inherited from class AbstractNamedValueArgumentResolver

AbstractNamedValueArgumentResolver.NamedValueInfo

Field Summary

Fields inherited from class AbstractNamedValueArgumentResolver

logger

Constructor Summary

Constructors

Constructor	Description
RequestHeaderArgumentResolver(ConversionService conversionService)

Method Summary

Modifier and Type	Method	Description
protected void	addRequestValue(String name, Object value, MethodParameter parameter, HttpRequestValues.Builder requestValues)	Add the given, single request value.
protected @Nullable AbstractNamedValueArgumentResolver.NamedValueInfo	createNamedValueInfo(MethodParameter parameter)	Return information about the request value, or null if the parameter does not represent a request value of interest.

Methods inherited from class AbstractNamedValueArgumentResolver

createNamedValueInfo, resolve

Methods inherited from class Object

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

Constructor Details

RequestHeaderArgumentResolver

public RequestHeaderArgumentResolver(ConversionService conversionService)

Method Details

createNamedValueInfo

protected @Nullable AbstractNamedValueArgumentResolver.NamedValueInfo createNamedValueInfo(MethodParameter parameter)

Description copied from class: AbstractNamedValueArgumentResolver

Return information about the request value, or null if the parameter does not represent a request value of interest.

Specified by:

createNamedValueInfo in class AbstractNamedValueArgumentResolver

addRequestValue

protected void addRequestValue(String name,
 Object value,
 MethodParameter parameter,
 HttpRequestValues.Builder requestValues)

Description copied from class: AbstractNamedValueArgumentResolver

Add the given, single request value. This may be called multiples times if the request value is multivalued.

If the resolver was created with a ConversionService, the value will have been converted to a String and may be cast down.

Specified by:

addRequestValue in class AbstractNamedValueArgumentResolver

Parameters:

name - the request value name

value - the value

parameter - the method parameter type, nested if Map, List/array, or Optional

requestValues - builder to add the request value to