Package org.apache.flink.runtime.rest.handler.taskmanager

Class AbstractTaskManagerFileHandler<M extends TaskManagerMessageParameters>

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.AbstractHandler<RestfulGateway,EmptyRequestBody,M>

org.apache.flink.runtime.rest.handler.taskmanager.AbstractTaskManagerFileHandler<M>

All Implemented Interfaces:

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

Direct Known Subclasses:

TaskManagerCustomLogHandler, TaskManagerLogFileHandler, TaskManagerProfilingFileHandler, TaskManagerStdoutFileHandler

public abstract class AbstractTaskManagerFileHandler<M extends TaskManagerMessageParameters>
extends AbstractHandler<RestfulGateway,EmptyRequestBody,M>

Base class for serving files from the TaskExecutor.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

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

Field Summary

Fields inherited from class org.apache.flink.runtime.rest.handler.AbstractHandler

log, MAPPER

Fields inherited from class org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler

leaderRetriever, logger, responseHeaders, timeout

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTaskManagerFileHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, UntypedResponseMessageHeaders<EmptyRequestBody,M> untypedResponseMessageHeaders, GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever, TransientBlobService transientBlobService, Duration cacheEntryDuration)

Method Summary

Modifier and Type	Method	Description
protected String	getFileName(HandlerRequest<EmptyRequestBody> handlerRequest)
protected CompletableFuture<Void>	handleException(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext channelHandlerContext, org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest httpRequest, Throwable throwable, ResourceID taskManagerId)
protected abstract CompletableFuture<TransientBlobKey>	requestFileUpload(ResourceManagerGateway resourceManagerGateway, Tuple2<ResourceID,String> taskManagerIdAndFileName)
protected CompletableFuture<Void>	respondToRequest(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx, org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest httpRequest, HandlerRequest<EmptyRequestBody> handlerRequest, RestfulGateway gateway)	Respond to the given HandlerRequest.

Methods inherited from class org.apache.flink.runtime.rest.handler.AbstractHandler

closeAsync, closeHandlerAsync, respondAsLeader

Methods inherited from class org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler

channelRead0, getTimeout

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

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

Methods inherited from class org.apache.flink.shaded.netty4.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 org.apache.flink.util.AutoCloseableAsync

close

Methods inherited from interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Detail

AbstractTaskManagerFileHandler

protected AbstractTaskManagerFileHandler(@Nonnull
                                         GatewayRetriever<? extends RestfulGateway> leaderRetriever,
                                         @Nonnull
                                         Duration timeout,
                                         @Nonnull
                                         Map<String,String> responseHeaders,
                                         @Nonnull
                                         UntypedResponseMessageHeaders<EmptyRequestBody,M> untypedResponseMessageHeaders,
                                         @Nonnull
                                         GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever,
                                         @Nonnull
                                         TransientBlobService transientBlobService,
                                         @Nonnull
                                         Duration cacheEntryDuration)

Method Detail

respondToRequest

protected CompletableFuture<Void> respondToRequest(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx,
                                                   org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest httpRequest,
                                                   HandlerRequest<EmptyRequestBody> handlerRequest,
                                                   RestfulGateway gateway)
                                            throws RestHandlerException

Description copied from class: AbstractHandler

Respond to the given HandlerRequest.

Specified by:

respondToRequest in class AbstractHandler<RestfulGateway,EmptyRequestBody,M extends TaskManagerMessageParameters>

Parameters:

ctx - channel handler context to write the response

httpRequest - original http request

handlerRequest - typed handler request

gateway - leader gateway

Returns:

Future which is completed once the request has been processed

Throws:

RestHandlerException - if an exception occurred while responding

requestFileUpload

protected abstract CompletableFuture<TransientBlobKey> requestFileUpload(ResourceManagerGateway resourceManagerGateway,
                                                                         Tuple2<ResourceID,String> taskManagerIdAndFileName)

getFileName

protected String getFileName(HandlerRequest<EmptyRequestBody> handlerRequest)

handleException

protected CompletableFuture<Void> handleException(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext channelHandlerContext,
                                                  org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest httpRequest,
                                                  Throwable throwable,
                                                  ResourceID taskManagerId)