org.atmosphere.nettosphere

Class HttpStaticFileServerHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

org.atmosphere.nettosphere.HttpStaticFileServerHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

BridgeRuntime

public class HttpStaticFileServerHandler
extends io.netty.channel.SimpleChannelInboundHandler<io.netty.handler.codec.http.FullHttpRequest>

A simple handler that serves incoming HTTP requests to send their respective HTTP responses. It also implements 'If-Modified-Since' header to take advantage of browser cache, as described in RFC 2616.

How Browser Caching Works

Web browser caching works with HTTP headers as illustrated by the following sample:

1. Request #1 returns the content of /file1.txt.
2. Contents of /file1.txt is cached by the browser.
3. Request #2 for /file1.txt does return the contents of the file again. Rather, a 304 Not Modified is returned. This tells the browser to use the contents stored in its cache.
4. The server knows the file has not been modified because the If-Modified-Since date is the same as the file's last modified date.

 Request #1 Headers
 ===================
 GET /file1.txt HTTP/1.1

 Response #1 Headers
 ===================
 HTTP/1.1 200 OK
 Date:               Tue, 01 Mar 2011 22:44:26 GMT
 Last-Modified:      Wed, 30 Jun 2010 21:36:48 GMT
 Expires:            Tue, 01 Mar 2012 22:44:26 GMT
 Cache-Control:      private, max-age=31536000

 Request #2 Headers
 ===================
 GET /file1.txt HTTP/1.1
 If-Modified-Since:  Wed, 30 Jun 2010 21:36:48 GMT

 Response #2 Headers
 ===================
 HTTP/1.1 304 Not Modified
 Date:               Tue, 01 Mar 2011 22:44:28 GMT

 

Nested Class Summary

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<java.lang.Object>	ATTACHMENT
static int	HTTP_CACHE_SECONDS
static java.lang.String	HTTP_DATE_FORMAT
static java.lang.String	HTTP_DATE_GMT_TIMEZONE
static java.lang.String	SERVICED
static java.lang.String	STATIC_MAPPING

Constructor Summary

Constructors

Constructor and Description
HttpStaticFileServerHandler(java.util.List<java.lang.String> paths)

Method Summary

Modifier and Type	Method and Description
void	channelRead0(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.FullHttpRequest request)
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, java.lang.Throwable t)
protected java.lang.String	sanitizeUri(java.lang.String uri)
void	sendError(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpResponseStatus status, io.netty.handler.codec.http.FullHttpRequest request)
static void	sendRedirect(io.netty.channel.ChannelHandlerContext ctx, java.lang.String newUri)

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

HTTP_DATE_FORMAT

public static final java.lang.String HTTP_DATE_FORMAT

See Also:

Constant Field Values

HTTP_DATE_GMT_TIMEZONE

public static final java.lang.String HTTP_DATE_GMT_TIMEZONE

See Also:

Constant Field Values

HTTP_CACHE_SECONDS

public static final int HTTP_CACHE_SECONDS

See Also:

Constant Field Values

ATTACHMENT

public static final io.netty.util.AttributeKey<java.lang.Object> ATTACHMENT

STATIC_MAPPING

public static final java.lang.String STATIC_MAPPING

SERVICED

public static final java.lang.String SERVICED

Constructor Detail

HttpStaticFileServerHandler

public HttpStaticFileServerHandler(java.util.List<java.lang.String> paths)

Method Detail

channelRead0

public void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
                         io.netty.handler.codec.http.FullHttpRequest request)
                  throws java.lang.Exception

Specified by:

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

Throws:

java.lang.Exception

exceptionCaught

public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
                            java.lang.Throwable t)

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

sanitizeUri

protected java.lang.String sanitizeUri(java.lang.String uri)

sendRedirect

public static void sendRedirect(io.netty.channel.ChannelHandlerContext ctx,
                                java.lang.String newUri)

sendError

public void sendError(io.netty.channel.ChannelHandlerContext ctx,
                      io.netty.handler.codec.http.HttpResponseStatus status,
                      io.netty.handler.codec.http.FullHttpRequest request)