Package io.quarkus.vertx.web

Annotation Interface Header

@Retention(RUNTIME) @Target(PARAMETER) public @interface Header
Identifies a route method parameter that should be injected with a value returned from HttpServerRequest.getHeader(String).

The parameter type must be String, java.util.Optional<String> or java.util.List<String>, otherwise the build fails.

See Also:
  • HttpServerRequest.getHeader(String)

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    value
    The name of the header.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELEMENT_NAME
    Constant value for value() indicating that the annotated element's name should be used as-is.

  • Field Details

    • ELEMENT_NAME

      static final String ELEMENT_NAME
      Constant value for value() indicating that the annotated element's name should be used as-is.
      See Also:

  • Element Details

    • value

      String value
      The name of the header. By default, the element's name is used as-is.
      Returns:
      the name of the header
      Default:
      "<<element name>>"