org.yamcs.web.rest

Annotation Type Route

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Repeatable(value=Routes.class)
public @interface Route

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	path Currently must be an absolute path.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	dataLoad Data load routes expect to receive a large body and they receive it piece by piece in HttpContent objects.
String[]	method HTTP method or methods by which this rule is available.
boolean	priority Whether this route must be checked before any other route.

Element Detail

path

public abstract String path

Currently must be an absolute path. Specify route params by preceding them with a colon, followed by their identifying name.

method

public abstract String[] method

HTTP method or methods by which this rule is available. By default set to "GET".

Implementation note: can't use netty's HttpMethod because it's not an enum

Default:

"GET"

priority

public abstract boolean priority

Whether this route must be checked before any other route. Used to differentiate a route when it's identifying part overlaps with the route params of another route.

When matching the request URI, the first rule with the highest weight that matches is responsible for handling the request.

FYI: The order of java methods is non-deterministic when accessing them through reflection. We implement some tricks to get the desired result. This priority qualifier is one of them, another is that paths are reverse sorted on string length before matching. This to make suffixes of otherwise identical rules stand out.

Try to architect non-overlapping paths such that you don't require this extra parameter, we have it here mostly due to some legacy paths, that may need rework.

Default:

false

dataLoad

public abstract boolean dataLoad

Data load routes expect to receive a large body and they receive it piece by piece in HttpContent objects. See org.yamcs.web.rest.archive.ArchiveTableRestHandler#loadTableData(io.netty.channel.ChannelHandlerContext, io.netty.handler.codec.http.HttpRequest, RouteMatch) for an example on how to implement this. For the normal routes (where dataLoad=false) the body is limited to Router.MAX_BODY_SIZE bytes provided to the HttpObjectAgregator.

Default:

false