Spring Framework

org.springframework.web.bind.annotation
Annotation Type RequestHeader


@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.

Since:
3.0
Author:
Juergen Hoeller
See Also:
RequestMapping, RequestParam, CookieValue, RequestMappingHandlerAdapter, 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.
 

value

public abstract java.lang.String value
The name of the request header to bind to.

Default:
""

required

public abstract boolean required
Whether the header is required.

Default is 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.

Alternatively, provide a defaultValue, which implicitely sets this flag to false.

Default:
true

defaultValue

public abstract java.lang.String defaultValue
The default value to use as a fallback. Supplying a default value implicitely sets required() to false.

Default:
"\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n"

Spring Framework