io.quarkus.vertx.web

Annotation Type Header

@Retention(value=RUNTIME)
 @Target(value=PARAMETER)
public @interface Header

Identifies a route method parameter that should be injected with a value returned from HttpServerRequest.getHeader(String).

The parameter type must be String, java.util.Optional<String> or java.util.List<String>, otherwise the build fails.

See Also:

HttpServerRequest.getHeader(String)

Field Summary

Fields

Modifier and Type	Fields and Description
static String	ELEMENT_NAME Constant value for value() indicating that the annotated element's name should be used as-is.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	value The name of the header.

Field Detail

ELEMENT_NAME

public static final String ELEMENT_NAME

Constant value for value() indicating that the annotated element's name should be used as-is.

Element Detail

value

public abstract String value

The name of the header. By default, the element's name is used as-is.

Returns:

the name of the header

Default:

"<<element name>>"