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

Class AbstractJobVertexHandler<R extends ResponseBody,M extends JobVertexMessageParameters>

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<org.apache.flink.shaded.netty4.io.netty.handler.codec.http.router.Routed>

org.apache.flink.runtime.rest.handler.RedirectHandler<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.AbstractJobVertexHandler<R,M>

Type Parameters:

R - the response type

M - the message parameters 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:

AbstractSubtaskHandler, JobVertexAccumulatorsHandler, SubtasksAllAccumulatorsHandler, SubtasksTimesHandler

public abstract class AbstractJobVertexHandler<R extends ResponseBody,M extends JobVertexMessageParameters>
extends AbstractExecutionGraphHandler<R,M>

Base class for request handlers whose response depends on a specific job vertex (defined via the "JobVertexIdPathParameter.KEY" parameter) in a specific job, defined via (defined via the "JobIDPathParameter.KEY" parameter).

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.RedirectHandler

leaderRetriever, localAddressFuture, logger, responseHeaders, timeout

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJobVertexHandler(CompletableFuture<String> localRestAddress, GatewayRetriever<? extends RestfulGateway> leaderRetriever, Time timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,R,M> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor) Instantiates a new Abstract job vertex handler.

Method Summary

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

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.RedirectHandler

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

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

AbstractJobVertexHandler

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

Instantiates a new Abstract job vertex handler.

Parameters:

localRestAddress - the local rest address

leaderRetriever - the leader retriever

timeout - the timeout

responseHeaders - the response headers

messageHeaders - the message headers

executionGraphCache - the execution graph cache

executor - the executor

Method Detail

handleRequest

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

Description copied from class: AbstractExecutionGraphHandler

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

Specified by:

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

Parameters:

request - for further information

executionGraph - 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,M> request,
                                   AccessExecutionJobVertex jobVertex)
                            throws RestHandlerException

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

Parameters:

request - the request

jobVertex - the execution job vertex

Returns:

the response

Throws:

RestHandlerException - if the handler could not process the request