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

Class AbstractAccessExecutionGraphHandler<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>

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

Type Parameters:

R - the response type

M - the message parameter type

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:

AbstractJobVertexHandler, CheckpointConfigHandler, JobAccumulatorsHandler, JobConfigHandler, JobDetailsHandler, JobPlanHandler, JobVertexDetailsHandler, JobVertexTaskManagersHandler

public abstract class AbstractAccessExecutionGraphHandler<R extends ResponseBody,M extends JobMessageParameters>
extends AbstractExecutionGraphHandler<R,M>

AbstractAccessExecutionGraphHandler handles requests that require accessing the job's AccessExecutionGraph.

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	AbstractAccessExecutionGraphHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,R,M> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)

Method Summary

Modifier and Type	Method	Description
protected abstract R	handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionGraph executionGraph)
protected R	handleRequest(HandlerRequest<EmptyRequestBody> request, ExecutionGraphInfo executionGraphInfo)	Called for each request after the corresponding ExecutionGraphInfo has been retrieved from the ExecutionGraphCache.

Methods inherited from class org.apache.flink.runtime.rest.handler.job.AbstractExecutionGraphHandler

handleRequest

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, 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

AbstractAccessExecutionGraphHandler

protected AbstractAccessExecutionGraphHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever,
                                              Duration timeout,
                                              Map<String,String> responseHeaders,
                                              MessageHeaders<EmptyRequestBody,R,M> messageHeaders,
                                              ExecutionGraphCache executionGraphCache,
                                              Executor executor)

Method Detail

handleRequest

protected R handleRequest(HandlerRequest<EmptyRequestBody> request,
                          ExecutionGraphInfo executionGraphInfo)
                   throws RestHandlerException

Description copied from class: AbstractExecutionGraphHandler

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

Specified by:

handleRequest in class AbstractExecutionGraphHandler<R extends ResponseBody,M extends JobMessageParameters>

Parameters:

request - for further information

executionGraphInfo - for which the handler was called

Returns:

Response

Throws:

RestHandlerException - if the handler could not process the request

handleRequest

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

Throws:

RestHandlerException