Annotation Type HeaderValue


  • @Target(PARAMETER)
    @Retention(RUNTIME)
    public @interface HeaderValue
    Annotation that indicates method parameter should be bound to the HTTP header with the specified name.

    Supported for HttpRoute annotated handler methods.

    Since:
    1.1
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String value
      Returns the name of the value in HTTP header.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean required
      Returns whether the header is required.
    • Element Detail

      • value

        java.lang.String value
        Returns the name of the value in HTTP header.
        Returns:
        the name of the value in HTTP header
      • required

        boolean required
        Returns whether the header is required.

        The default is true.

        Returns:
        whether the header is required
        Default:
        true