Annotation Interface Messaging.HeaderParam

Enclosing class:
Messaging
@Documented @Retention(CLASS) @Target(PARAMETER) public static @interface Messaging.HeaderParam
Message header parameter.

Header names are exact and case-sensitive. Supported parameter types are:

  • String: required last value, which must be a MessageHeaderValue.TextValue
  • Optional<String>: optional last value, which must be a TextValue when present
  • MessageHeaderValue: required last value of any kind
  • Optional<MessageHeaderValue>: optional last value of any kind
  • List<MessageHeaderValue>: immutable list of all matching values in message-entry order, empty when absent
A missing required value or a non-text value selected for a text parameter fails delivery. An explicit MessageHeaderValue.NullValue is a present header value, including in Optional<MessageHeaderValue>. No automatic header-value conversion is performed. Local metadata is not visible through this annotation. A handler may declare at most one header parameter for each exact name.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    Header name.

  • Element Details

    • value

      String value
      Header name.
      Returns:
      header name