org.yamcs.web.rest

Class Router

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.SimpleChannelInboundHandler<io.netty.handler.codec.http.FullHttpRequest>

org.yamcs.web.rest.Router

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

@ChannelHandler.Sharable
public class Router
extends io.netty.channel.SimpleChannelInboundHandler<io.netty.handler.codec.http.FullHttpRequest>

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

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
static io.netty.util.AttributeKey<Router.RouteMatch>	CTX_ROUTE_MATCH
static int	MAX_BODY_SIZE

Constructor Summary

Constructors

Constructor and Description
Router()

Method Summary

Modifier and Type	Method and Description
protected void	channelRead0(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.FullHttpRequest req)
protected void	dispatch(RestRequest req, Router.RouteMatch match)
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
Router.RouteMatch	matchURI(io.netty.handler.codec.http.HttpMethod method, String uri)
void	registerRouteHandler(String yamcsInstance, RouteHandler routeHandler)
boolean	scheduleExecution(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpRequest req, io.netty.handler.codec.http.QueryStringDecoder qsDecoder) At this point we do not have the full request (only the header) so we have to configure the pipeline either for receiving the full request or with route specific pipeline for receiving (large amounts of) data in case of dataLoad routes.

Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Field Detail

MAX_BODY_SIZE

public static final int MAX_BODY_SIZE

See Also:

Constant Field Values

CTX_ROUTE_MATCH

public static final io.netty.util.AttributeKey<Router.RouteMatch> CTX_ROUTE_MATCH

Constructor Detail

Router

public Router()

Method Detail

registerRouteHandler

public void registerRouteHandler(String yamcsInstance,
                                 RouteHandler routeHandler)

scheduleExecution

public boolean scheduleExecution(io.netty.channel.ChannelHandlerContext ctx,
                                 io.netty.handler.codec.http.HttpRequest req,
                                 io.netty.handler.codec.http.QueryStringDecoder qsDecoder)

At this point we do not have the full request (only the header) so we have to configure the pipeline either for receiving the full request or with route specific pipeline for receiving (large amounts of) data in case of dataLoad routes.

Parameters:

ctx -

req -

qsDecoder -

Returns:

true if the request has been scheduled and false if the request is invalid or there was another error

channelRead0

protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
                            io.netty.handler.codec.http.FullHttpRequest req)
                     throws Exception

Specified by:

channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<io.netty.handler.codec.http.FullHttpRequest>

Throws:

Exception

matchURI

public 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)

exceptionCaught

public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
                            Throwable cause)
                     throws Exception

Specified by:

exceptionCaught in interface io.netty.channel.ChannelHandler

Specified by:

exceptionCaught in interface io.netty.channel.ChannelInboundHandler

Overrides:

exceptionCaught in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception