Package com.shri.restinpeace.annotation.request

Annotation Type HeaderParam

@Documented @Retention(RUNTIME) @Target(PARAMETER) @HTTPRequestParamMarker(HEADER) public @interface HeaderParam
Sets an HTTP header on the request from the annotated parameter's value.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    The header name to set.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    defaultValue
    Value used when the argument is null.
    boolean
    required
    If true, a null argument with no defaultValue() throws a RestInPeaceException at call time.

  • Element Details

    • value

      String value
      The header name to set.
      Returns:
      the header name

    • required

      boolean required
      If true, a null argument with no defaultValue() throws a RestInPeaceException at call time.
      Returns:
      whether the header is required
      Default:
      false

    • defaultValue

      String defaultValue
      Value used when the argument is null.
      Returns:
      the default value
      Default:
      "REST-IN-PEACE-DEFAULT-STRING"