org.yamcs.web

Class HttpRequestHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

org.yamcs.web.HttpRequestHandler

All Implemented Interfaces:

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

public class HttpRequestHandler
extends io.netty.channel.ChannelInboundHandlerAdapter

Handles handshakes and messages. We have following different request types

• static requests - sent to the fileRequestHandler - do no go higher in the netty pipeline
• websocket requests - the pipeline is modified to add the websocket handshaker.
• load data requests - the pipeline is modified by the respective route handler
• standard API calls (the vast majority) - the HttpObjectAgreggator is added upstream to collect (and limit) all data from the http request in one object.

Because we support multiple http requests on one connection (keep-alive), we have to clean the pipeline when the request type changes

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpRequestHandler.ChunkedTransferStats

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 Object	CONTENT_FINISHED_EVENT
static io.netty.util.AttributeKey<AuthenticationToken>	CTX_AUTH_TOKEN
static io.netty.util.AttributeKey<HttpRequestHandler.ChunkedTransferStats>	CTX_CHUNK_STATS
static String	HANDLER_NAME_CHUNKED_WRITER
static String	HANDLER_NAME_COMPRESSOR
static byte[]	NEWLINE_BYTES

Constructor Summary

Constructors

Constructor and Description
HttpRequestHandler(Router apiRouter, WebConfig webConfig)

Method Summary

Modifier and Type	Method and Description
void	channelRead(io.netty.channel.ChannelHandlerContext ctx, Object msg)
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
static <T extends com.google.protobuf.Message> io.netty.channel.ChannelFuture	sendMessageResponse(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpRequest req, io.netty.handler.codec.http.HttpResponseStatus status, T responseMsg)
static <T extends com.google.protobuf.Message> io.netty.channel.ChannelFuture	sendMessageResponse(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpRequest req, io.netty.handler.codec.http.HttpResponseStatus status, T responseMsg, boolean autoCloseOnError)
static io.netty.channel.ChannelFuture	sendPlainTextError(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpRequest req, io.netty.handler.codec.http.HttpResponseStatus status)
static io.netty.channel.ChannelFuture	sendPlainTextError(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpRequest req, io.netty.handler.codec.http.HttpResponseStatus status, String msg)
io.netty.channel.ChannelFuture	sendRedirect(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpRequest req, String newUri)
static io.netty.channel.ChannelFuture	sendResponse(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpRequest req, io.netty.handler.codec.http.HttpResponse response, boolean autoCloseOnError)
static io.netty.channel.ChannelFuture	startChunkedTransfer(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpRequest req, MediaType contentType, String filename) Sends base HTTP response indicating the use of chunked transfer encoding NM 11-May-2018: We do not put the ChunckedWriteHandler on the pipeline because the input is already chunked.
static io.netty.channel.ChannelFuture	writeChunk(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf buf)

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

CTX_CHUNK_STATS

public static final io.netty.util.AttributeKey<HttpRequestHandler.ChunkedTransferStats> CTX_CHUNK_STATS

CTX_AUTH_TOKEN

public static final io.netty.util.AttributeKey<AuthenticationToken> CTX_AUTH_TOKEN

CONTENT_FINISHED_EVENT

public static final Object CONTENT_FINISHED_EVENT

HANDLER_NAME_COMPRESSOR

public static final String HANDLER_NAME_COMPRESSOR

See Also:

Constant Field Values

HANDLER_NAME_CHUNKED_WRITER

public static final String HANDLER_NAME_CHUNKED_WRITER

See Also:

Constant Field Values

NEWLINE_BYTES

public static final byte[] NEWLINE_BYTES

Constructor Detail

HttpRequestHandler

public HttpRequestHandler(Router apiRouter,
                          WebConfig webConfig)

Method Detail

channelRead

public void channelRead(io.netty.channel.ChannelHandlerContext ctx,
                        Object msg)
                 throws Exception

Specified by:

channelRead in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelRead in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

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

sendRedirect

public io.netty.channel.ChannelFuture sendRedirect(io.netty.channel.ChannelHandlerContext ctx,
                                                   io.netty.handler.codec.http.HttpRequest req,
                                                   String newUri)

sendMessageResponse

public static <T extends com.google.protobuf.Message> io.netty.channel.ChannelFuture sendMessageResponse(io.netty.channel.ChannelHandlerContext ctx,
                                                                                                         io.netty.handler.codec.http.HttpRequest req,
                                                                                                         io.netty.handler.codec.http.HttpResponseStatus status,
                                                                                                         T responseMsg)

sendMessageResponse

public static <T extends com.google.protobuf.Message> io.netty.channel.ChannelFuture sendMessageResponse(io.netty.channel.ChannelHandlerContext ctx,
                                                                                                         io.netty.handler.codec.http.HttpRequest req,
                                                                                                         io.netty.handler.codec.http.HttpResponseStatus status,
                                                                                                         T responseMsg,
                                                                                                         boolean autoCloseOnError)

sendPlainTextError

public static io.netty.channel.ChannelFuture sendPlainTextError(io.netty.channel.ChannelHandlerContext ctx,
                                                                io.netty.handler.codec.http.HttpRequest req,
                                                                io.netty.handler.codec.http.HttpResponseStatus status)

sendPlainTextError

public static io.netty.channel.ChannelFuture sendPlainTextError(io.netty.channel.ChannelHandlerContext ctx,
                                                                io.netty.handler.codec.http.HttpRequest req,
                                                                io.netty.handler.codec.http.HttpResponseStatus status,
                                                                String msg)

sendResponse

public static io.netty.channel.ChannelFuture sendResponse(io.netty.channel.ChannelHandlerContext ctx,
                                                          io.netty.handler.codec.http.HttpRequest req,
                                                          io.netty.handler.codec.http.HttpResponse response,
                                                          boolean autoCloseOnError)

startChunkedTransfer

public static io.netty.channel.ChannelFuture startChunkedTransfer(io.netty.channel.ChannelHandlerContext ctx,
                                                                  io.netty.handler.codec.http.HttpRequest req,
                                                                  MediaType contentType,
                                                                  String filename)

Sends base HTTP response indicating the use of chunked transfer encoding NM 11-May-2018: We do not put the ChunckedWriteHandler on the pipeline because the input is already chunked.

writeChunk

public static io.netty.channel.ChannelFuture writeChunk(io.netty.channel.ChannelHandlerContext ctx,
                                                        io.netty.buffer.ByteBuf buf)
                                                 throws IOException

Throws:

IOException