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

Class AbstractCheckpointHandler<R extends ResponseBody,M extends CheckpointMessageParameters>

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.checkpoints.AbstractCheckpointStatsHandler<R,M>

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

Type Parameters:

R - type of the response

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:

CheckpointStatisticDetailsHandler, TaskCheckpointStatisticDetailsHandler

public abstract class AbstractCheckpointHandler<R extends ResponseBody,M extends CheckpointMessageParameters>
extends AbstractCheckpointStatsHandler<R,M>

Base class for checkpoint related REST handler.

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

AbstractCheckpointHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, org.apache.flink.api.common.time.Time timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,R,M> messageHeaders, Executor executor, org.apache.flink.shaded.guava31.com.google.common.cache.Cache<org.apache.flink.api.common.JobID,CompletableFuture<CheckpointStatsSnapshot>> checkpointStatsSnapshotCache, CheckpointStatsCache checkpointStatsCache)

Method Summary

Modifier and Type	Method and Description
protected abstract R	handleCheckpointRequest(HandlerRequest<EmptyRequestBody> request, AbstractCheckpointStats checkpointStats) Called for each request with the corresponding AbstractCheckpointStats instance.
protected R	handleCheckpointStatsRequest(HandlerRequest<EmptyRequestBody> request, CheckpointStatsSnapshot checkpointStatsSnapshot)

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

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

AbstractCheckpointHandler

protected AbstractCheckpointHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever,
                                    org.apache.flink.api.common.time.Time timeout,
                                    Map<String,String> responseHeaders,
                                    MessageHeaders<EmptyRequestBody,R,M> messageHeaders,
                                    Executor executor,
                                    org.apache.flink.shaded.guava31.com.google.common.cache.Cache<org.apache.flink.api.common.JobID,CompletableFuture<CheckpointStatsSnapshot>> checkpointStatsSnapshotCache,
                                    CheckpointStatsCache checkpointStatsCache)

Method Detail

handleCheckpointStatsRequest

protected R handleCheckpointStatsRequest(HandlerRequest<EmptyRequestBody> request,
                                         CheckpointStatsSnapshot checkpointStatsSnapshot)
                                  throws RestHandlerException

Specified by:

handleCheckpointStatsRequest in class AbstractCheckpointStatsHandler<R extends ResponseBody,M extends CheckpointMessageParameters>

Throws:

RestHandlerException

handleCheckpointRequest

protected abstract R handleCheckpointRequest(HandlerRequest<EmptyRequestBody> request,
                                             AbstractCheckpointStats checkpointStats)
                                      throws RestHandlerException

Called for each request with the corresponding AbstractCheckpointStats instance.

Parameters:

request - for further information

checkpointStats - for which the handler is called

Returns:

Response

Throws:

RestHandlerException - if the handler could not handle the request