Annotation Type RequestHeader

    • Optional Element Summary

      Optional Elements 
      Modifier and TypeOptional ElementDescription
      StringdefaultValue
      The default value to use as a fallback.
      Stringname
      The name of the request header to bind to.
      booleanrequired
      Whether the header is required.
      Stringvalue
      Alias for name().
      • name

        @AliasFor("value")
        String name
        The name of the request header to bind to.
        Since:
        4.2
        Default:
        ""
      • required

        boolean required
        Whether the header is required.

        Defaults to true, leading to an exception being thrown if the header is missing in the request. Switch this to false if you prefer a null value if the header is not present in the request.

        Alternatively, provide a defaultValue(), which implicitly sets this flag to false.

        Default:
        true
      • defaultValue

        String defaultValue
        The default value to use as a fallback.

        Supplying a default value implicitly sets required() to false.

        Default:
        "\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n"