Package io.micronaut.messaging.annotation

Annotation Interface MessageHeader

@Documented @Retention(RUNTIME) @Target({PARAMETER,TYPE,METHOD}) @Repeatable(MessageHeaders.class) @Bindable @Inherited public @interface MessageHeader

An annotation that can be applied to method argument to indicate that the method argument is bound from a message header.

Since:
2.4.0
Author:
Graeme Rocher

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    name
    If used on a class level with @Headers this is the header name and value is the value.
    String
    value
    If used as a bound parameter, this is the header name.

  • Element Details

    • value

      String value
      If used as a bound parameter, this is the header name. If used on a class level this is value and not the header name.
      Returns:
      The name of the header, otherwise it is inferred from the parameter name
      Default:
      ""

    • name

      String name
      If used on a class level with @Headers this is the header name and value is the value.
      Returns:
      name of header when using with @Headers
      Default:
      ""