org.yamcs.web.rest

Class Router

java.lang.Object

org.yamcs.web.rest.Router

public class Router
extends Object

Matches a request uri to a registered route handler. Stops on the first match.

The Router itself has the same granularity as HttpServer: one instance only.

When matching a route, priority is first given to built-in routes, only if none match the first matching instance-specific dynamic route is matched. Dynamic routes often mention ':instance' in their url, which will be expanded upon registration into the actual yamcs instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Router.RouteConfig Struct containing all non-path route configuration
static class	Router.RouteMatch Represents a matched route pattern

Constructor Summary

Constructors

Constructor and Description
Router()

Method Summary

Modifier and Type	Method and Description
protected void	dispatch(RestRequest req, Router.RouteMatch match)
void	handleHttpRequest(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.FullHttpRequest req, AuthenticationToken token, io.netty.handler.codec.http.QueryStringDecoder qsDecoder)
protected Router.RouteMatch	matchURI(io.netty.handler.codec.http.HttpMethod method, String uri)
void	registerRouteHandler(String yamcsInstance, RouteHandler routeHandler)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Router

public Router()

Method Detail

registerRouteHandler

public void registerRouteHandler(String yamcsInstance,
                                 RouteHandler routeHandler)

handleHttpRequest

public void handleHttpRequest(io.netty.channel.ChannelHandlerContext ctx,
                              io.netty.handler.codec.http.FullHttpRequest req,
                              AuthenticationToken token,
                              io.netty.handler.codec.http.QueryStringDecoder qsDecoder)

matchURI

protected Router.RouteMatch matchURI(io.netty.handler.codec.http.HttpMethod method,
                                     String uri)
                              throws MethodNotAllowedException

Throws:

MethodNotAllowedException

dispatch

protected void dispatch(RestRequest req,
                        Router.RouteMatch match)