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 the DefaultValue annotation. The type T of the annotated parameter, field or property must either:
  1. Be a primitive type
  2. Have a constructor that accepts a single String argument
  3. Have a static method named valueOf or fromString that accepts a single String argument (see, for example, Integer.valueOf(String))
  4. Have a registered implementation of ParamConverterProvider JAX-RS extension SPI that returns a ParamConverter instance capable of a "from string" conversion for the type.
  5. Be List<T>, Set<T> or SortedSet<T>, where T 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

  • Required Element Summary

    Required Elements 
    Modifier and Type Required Element Description
    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.

  • Element Details

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