Package org.springframework.messaging.handler.annotation

Annotation Interface Header

@Target(PARAMETER)
@Retention(RUNTIME)
@Documented
public @interface Header

Annotation which indicates that a method parameter should be bound to a message header.

Since:

4.0

Author:

Rossen Stoyanchev, Sam Brannen

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	defaultValue	The default value to use as a fallback.
String	name	The name of the request header to bind to.
boolean	required	Whether the header is required.
String	value	Alias for name().

Element Details

value

@AliasFor("name")
String value

Alias for name().

Default:

""

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.

Default is true, leading to an exception if the header is missing. Switch this to false if you prefer a null value in case of a header missing.

See Also:

• defaultValue()

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"