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

Class AbstractSubtaskAttemptHandler<R extends ResponseBody,M extends SubtaskAttemptMessageParameters>

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>

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

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

org.apache.flink.runtime.rest.handler.job.AbstractSubtaskAttemptHandler<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, org.apache.flink.util.AutoCloseableAsync

Direct Known Subclasses:

SubtaskExecutionAttemptAccumulatorsHandler, SubtaskExecutionAttemptDetailsHandler

public abstract class AbstractSubtaskAttemptHandler<R extends ResponseBody,M extends SubtaskAttemptMessageParameters>
extends AbstractSubtaskHandler<R,M>

Base class for request handlers whose response depends on a specific attempt (defined via the "SubtaskAttemptPathParameter.KEY" of a specific subtask (defined via the "SubtaskIndexPathParameter.KEY" in 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.LeaderRetrievalHandler

leaderRetriever, logger, responseHeaders, timeout

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSubtaskAttemptHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration 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	Description
protected abstract R	handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecution execution)	Called for each request after the corresponding AccessExecution has been retrieved from the AccessExecutionVertex.
protected R	handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionVertex executionVertex)	Called for each request after the corresponding AccessExecutionVertex has been retrieved from the AccessExecutionJobVertex.

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

handleRequest

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

handleRequest

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

handleRequest

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 Details

AbstractSubtaskAttemptHandler

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

Instantiates a new Abstract job vertex handler.

Parameters:

leaderRetriever - the leader retriever

timeout - the timeout

responseHeaders - the response headers

messageHeaders - the message headers

executionGraphCache - the execution graph cache

executor - the executor

Method Details

handleRequest

protected R handleRequest(HandlerRequest<EmptyRequestBody> request,
 AccessExecutionVertex executionVertex)
                   throws RestHandlerException

Description copied from class: AbstractSubtaskHandler

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

Specified by:

handleRequest in class AbstractSubtaskHandler<R extends ResponseBody,M extends SubtaskAttemptMessageParameters>

Parameters:

request - the request

executionVertex - the execution vertex

Returns:

the response

Throws:

RestHandlerException - the rest handler exception

handleRequest

protected abstract R handleRequest(HandlerRequest<EmptyRequestBody> request,
 AccessExecution execution)
                            throws RestHandlerException

Called for each request after the corresponding AccessExecution has been retrieved from the AccessExecutionVertex.

Parameters:

request - the request

execution - the execution

Returns:

the response

Throws:

RestHandlerException - the rest handler exception