org.apache.flink.runtime.rest.handler.job

Class AbstractExecutionGraphHandler<R extends ResponseBody,M extends JobMessageParameters>

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<T,R,M>

org.apache.flink.runtime.rest.handler.AbstractRestHandler<RestfulGateway,EmptyRequestBody,R,M>

org.apache.flink.runtime.rest.handler.job.AbstractExecutionGraphHandler<R,M>

Type Parameters:

R - response type

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCheckpointHandler, AbstractJobVertexHandler, CheckpointConfigHandler, CheckpointingStatisticsHandler, JobAccumulatorsHandler, JobConfigHandler, JobDetailsHandler, JobExceptionsHandler, JobPlanHandler, JobVertexDetailsHandler, JobVertexTaskManagersHandler

public abstract class AbstractExecutionGraphHandler<R extends ResponseBody,M extends JobMessageParameters>
extends AbstractRestHandler<RestfulGateway,EmptyRequestBody,R,M>

Base class for all AccessExecutionGraph based REST handlers.

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 and Description
protected	AbstractExecutionGraphHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, org.apache.flink.api.common.time.Time timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,R,M> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)

Method Summary

Modifier and Type	Method and Description
protected abstract R	handleRequest(HandlerRequest<EmptyRequestBody,M> request, AccessExecutionGraph executionGraph) Called for each request after the corresponding AccessExecutionGraph has been retrieved from the ExecutionGraphCache.
protected CompletableFuture<R>	handleRequest(HandlerRequest<EmptyRequestBody,M> request, RestfulGateway gateway) This method is called for every incoming request and returns a CompletableFuture containing a the response.

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

getMessageHeaders, respondToRequest

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

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

AbstractExecutionGraphHandler

protected AbstractExecutionGraphHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever,
                                        org.apache.flink.api.common.time.Time timeout,
                                        Map<String,String> responseHeaders,
                                        MessageHeaders<EmptyRequestBody,R,M> messageHeaders,
                                        ExecutionGraphCache executionGraphCache,
                                        Executor executor)

Method Detail

handleRequest

protected CompletableFuture<R> handleRequest(@Nonnull
                                             HandlerRequest<EmptyRequestBody,M> request,
                                             @Nonnull
                                             RestfulGateway gateway)
                                      throws RestHandlerException

Description copied from class: AbstractRestHandler

This method is called for every incoming request and returns a CompletableFuture containing a the response.

Implementations may decide whether to throw RestHandlerExceptions or fail the returned CompletableFuture with a RestHandlerException.

Failing the future with another exception type or throwing unchecked exceptions is regarded as an implementation error as it does not allow us to provide a meaningful HTTP status code. In this case a HttpResponseStatus.INTERNAL_SERVER_ERROR will be returned.

Specified by:

handleRequest in class AbstractRestHandler<RestfulGateway,EmptyRequestBody,R extends ResponseBody,M extends JobMessageParameters>

Parameters:

request - request that should be handled

gateway - leader gateway

Returns:

future containing a handler response

Throws:

RestHandlerException - if the handling failed

handleRequest

protected abstract R handleRequest(HandlerRequest<EmptyRequestBody,M> request,
                                   AccessExecutionGraph executionGraph)
                            throws RestHandlerException

Called for each request after the corresponding AccessExecutionGraph has been retrieved from the ExecutionGraphCache.

Parameters:

request - for further information

executionGraph - for which the handler was called

Returns:

Response

Throws:

RestHandlerException - if the handler could not process the request