@Target(value=PARAMETER)
@Retention(value=RUNTIME)
@Documented
public @interface RequestHeader
Supported for annotated handler methods in Servlet and Portlet environments.
If the method parameter is Map<String, String>,
MultiValueMap<String, String>,
or HttpHeaders then the map is
populated with all header names and values.
RequestMapping,
RequestParam,
CookieValue,
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter,
org.springframework.web.portlet.mvc.annotation.AnnotationMethodHandlerAdapter| Modifier and Type | Optional Element and Description |
|---|---|
java.lang.String |
defaultValue
The default value to use as a fallback.
|
java.lang.String |
name
The name of the request header to bind to.
|
boolean |
required
Whether the header is required.
|
java.lang.String |
value
Alias for
name(). |
@AliasFor(value="name") public abstract java.lang.String value
name().@AliasFor(value="value") public abstract java.lang.String name
public abstract boolean required
Defaults to true, leading to an exception being thrown
if the header is missing in the request. Switch this to
false if you prefer a null value if the header is
not present in the request.
Alternatively, provide a defaultValue(), which implicitly
sets this flag to false.
public abstract java.lang.String defaultValue
Supplying a default value implicitly sets required() to
false.