com.twitter.finatra.http.annotations

Annotation Type Header

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

Marker Annotation for denoting a Jackson "injectable value" which should be obtained from a Finagle HTTP Message header parameter.

See Also:

InjectableValue, Finatra User's Guide - JSON Injectable Values, Finatra User's Guide - HTTP Request Field Annotations

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	value An optional field name to use for reading the header parameter from the Finagle HTTP Message.

Element Detail

value

public abstract java.lang.String value

An optional field name to use for reading the header parameter from the Finagle HTTP Message. When empty, the annotated case class field name will be used to read the header parameter from the Finagle HTTP Message parameters.

Returns:

the name of the header parameter field.

Default:

""