io.micronaut.messaging.annotation

Annotation Type MessageHeader

@Documented
 @Retention(value=RUNTIME)
 @Target(value={PARAMETER,TYPE,METHOD})
 @Repeatable(value=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 and 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 Detail

value

public abstract 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

public abstract 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:

""