org.apache.flink.runtime.rest.handler.legacy.files

类 StaticFileServerHandler<T extends RestfulGateway>

java.lang.Object

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerAdapter

org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

org.apache.flink.shaded.netty4.io.netty.channel.SimpleChannelInboundHandler<RoutedRequest>

org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler<T>

org.apache.flink.runtime.rest.handler.legacy.files.StaticFileServerHandler<T>

所有已实现的接口:

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler, org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler

@ChannelHandler.Sharable
public class StaticFileServerHandler<T extends RestfulGateway>
extends LeaderRetrievalHandler<T>

Simple file server handler that serves requests to web frontend's static files, such as HTML, CSS, or JS files.

This code is based on the "HttpStaticFileServerHandler" from the Netty project's HTTP server example.

嵌套类概要

从接口继承的嵌套类/接口 org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler.Sharable

字段概要

字段

限定符和类型	字段和说明
static String	HTTP_DATE_FORMAT Date format for HTTP.

从类继承的字段 org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler

leaderRetriever, logger, responseHeaders, timeout

构造器概要

构造器

构造器和说明
StaticFileServerHandler(GatewayRetriever<? extends T> retriever, org.apache.flink.api.common.time.Time timeout, File rootPath)

方法概要

限定符和类型	方法和说明
static void	checkFileValidity(File file, File rootPath, org.slf4j.Logger logger) Checks various conditions for file access.
void	exceptionCaught(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
protected void	respondAsLeader(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext channelHandlerContext, RoutedRequest routedRequest, T gateway)
static void	sendNotModified(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx) Send the "304 Not Modified" response.
static void	setContentTypeHeader(org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponse response, File file) Sets the content type header for the HTTP Response.
static void	setDateAndCacheHeaders(org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponse response, File fileToCache) Sets the "date" and "cache" headers for the HTTP Response.
static void	setDateHeader(org.apache.flink.shaded.netty4.io.netty.handler.codec.http.FullHttpResponse response) Sets the "date" header for the HTTP response.

从类继承的方法 org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler

channelRead0

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

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

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

字段详细资料

HTTP_DATE_FORMAT

public static final String HTTP_DATE_FORMAT

Date format for HTTP.

另请参阅:

常量字段值

构造器详细资料

StaticFileServerHandler

public StaticFileServerHandler(GatewayRetriever<? extends T> retriever,
                               org.apache.flink.api.common.time.Time timeout,
                               File rootPath)
                        throws IOException

抛出:

IOException

方法详细资料

respondAsLeader

protected void respondAsLeader(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext channelHandlerContext,
                               RoutedRequest routedRequest,
                               T gateway)
                        throws Exception

指定者:

respondAsLeader 在类中 LeaderRetrievalHandler<T extends RestfulGateway>

抛出:

Exception

exceptionCaught

public void exceptionCaught(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx,
                            Throwable cause)

指定者:

exceptionCaught 在接口中 org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

指定者:

exceptionCaught 在接口中 org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler

覆盖:

exceptionCaught 在类中 org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

sendNotModified

public static void sendNotModified(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx)

Send the "304 Not Modified" response. This response can be used when the file timestamp is the same as what the browser is sending up.

参数:

ctx - The channel context to write the response to.

setDateHeader

public static void setDateHeader(org.apache.flink.shaded.netty4.io.netty.handler.codec.http.FullHttpResponse response)

Sets the "date" header for the HTTP response.

参数:

response - HTTP response

setDateAndCacheHeaders

public static void setDateAndCacheHeaders(org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponse response,
                                          File fileToCache)

Sets the "date" and "cache" headers for the HTTP Response.

参数:

response - The HTTP response object.

fileToCache - File to extract the modification timestamp from.

setContentTypeHeader

public static void setContentTypeHeader(org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponse response,
                                        File file)

Sets the content type header for the HTTP Response.

参数:

response - HTTP response

file - file to extract content type

checkFileValidity

public static void checkFileValidity(File file,
                                     File rootPath,
                                     org.slf4j.Logger logger)
                              throws IOException,
                                     RestHandlerException

Checks various conditions for file access. If all checks pass this method returns, and processing of the request may continue. If any check fails this method throws a RestHandlerException, and further processing of the request must be limited to sending an error response.

抛出:

IOException

RestHandlerException