|
spring-web | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT | ||||||||
@Target(value=PARAMETER) @Retention(value=RUNTIME) @Documented public @interface RequestHeader
Annotation which indicates that a method parameter should be bound to a web request header. Supported for annotated handler methods in Servlet and Portlet environments.
RequestMapping,
RequestParam,
CookieValue,
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter,
org.springframework.web.portlet.mvc.annotation.AnnotationMethodHandlerAdapter| Optional Element Summary | |
|---|---|
java.lang.String |
defaultValue
The default value to use as a fallback. |
boolean |
required
Whether the header is required. |
java.lang.String |
value
The name of the request header to bind to. |
public abstract java.lang.String value
public abstract boolean required
Default is Alternatively, provide a
true, leading to an exception thrown in case
of the header missing in the request. Switch this to false
if you prefer a null in case of the header missing.
defaultValue,
which implicitely sets this flag to false.
public abstract java.lang.String defaultValue
required() to false.
|
spring-web | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT | ||||||||