Package javax.ws.rs
Annotation Type 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 the
DefaultValue
annotation.
The type T
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)
) - Be
List<T>
,Set<T>
orSortedSet<T>
, whereT
satisfies 2 or 3 above. The resulting collection is read-only.
If the type is not one of those listed in 4 above then the first value (lexically) of the header 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.
- See Also:
-
Required Element Summary
Required Elements
-
Element Details
-
value
String valueDefines 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.
-