com.twitter.finatra.http.annotations

Annotation Type RouteParam

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

Marker Annotation for denoting a Jackson "injectable value" which should be obtained from a Finagle HTTP Request URI path variable. This specifically allows access to the Finatra "named parameter" of the path of an HTTP route callback defined in a Controller.

See Also:

InjectableValue, Finatra User's Guide - JSON Injectable Values, Finatra User's Guide - Controller Named Parameters, 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 route parameter from the Finagle HTTP Request.

Element Detail

value

public abstract java.lang.String value

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

Returns:

the name of the route parameter field.

Default:

""