org.springframework.messaging.handler.annotation

Annotation Type Header

@Target(value=PARAMETER)
 @Retention(value=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

Optional Element Summary

Optional Elements

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

Element Detail

value

public abstract java.lang.String value

The name of the request header to bind to.

Default:

""

required

public abstract boolean required

Whether the header is required.

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

Default:

true

defaultValue

public abstract java.lang.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"