Package jakarta.ws.rs
Annotation Type HeaderParam
-
@Target({PARAMETER,METHOD,FIELD}) @Retention(RUNTIME) @Documented public @interface HeaderParam
Binds the value(s) of a HTTP header to a resource method parameter, resource class field, or resource class bean property. A default value can be specified using theDefaultValue
annotation. The typeT
of the annotated parameter, field or property must either:- Be a primitive type
- Have a constructor that accepts a single
String
argument - Have a static method named
valueOf
orfromString
that accepts a singleString
argument (see, for example,Integer.valueOf(String)
) - Have a registered implementation of
ParamConverterProvider
JAX-RS extension SPI that returns aParamConverter
instance capable of a "from string" conversion for the type. - Be
List<T>
,Set<T>
,SortedSet<T>
orT[]
array, whereT
satisfies 2, 3 or 4 above. The resulting collection is read-only.
If the type is not one of the collection types listed in 5 above and the header parameter is represented by multiple values then the first value (lexically) of the parameter is used.
Because injection occurs at object creation time, use of this annotation on resource class fields and bean properties is only supported for the default per-request resource class lifecycle. Resource classes using other lifecycles should only use this annotation on resource method parameters.
- Since:
- 1.0
- Author:
- Paul Sandoz, Marc Hadley
- See Also:
DefaultValue
,HttpHeaders
-
-
Element Detail
-
value
String value
Defines the name of the HTTP header whose value will be used to initialize the value of the annotated method argument, class field or bean property. Case insensitive.- Returns:
- HTTP header name.
-
-