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

Class CheckpointStatisticDetailsHandler

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.checkpoints.AbstractCheckpointHandler<CheckpointStatistics,CheckpointMessageParameters>

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

All Implemented Interfaces:

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

public class CheckpointStatisticDetailsHandler
extends AbstractCheckpointHandler<CheckpointStatistics,CheckpointMessageParameters>
implements JsonArchivist

REST handler which returns the details for a checkpoint.

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

Constructor and Description
CheckpointStatisticDetailsHandler(CompletableFuture<String> localRestAddress, GatewayRetriever<? extends RestfulGateway> leaderRetriever, Time timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,CheckpointStatistics,CheckpointMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor, CheckpointStatsCache checkpointStatsCache)

Method Summary

Modifier and Type	Method and Description
Collection<ArchivedJson>	archiveJsonWithPath(AccessExecutionGraph graph) Returns a Collection of ArchivedJsons containing JSON responses and their respective REST URL for a given job.
protected CheckpointStatistics	handleCheckpointRequest(HandlerRequest<EmptyRequestBody,CheckpointMessageParameters> ignored, AbstractCheckpointStats checkpointStats) Called for each request with the corresponding AbstractCheckpointStats instance.

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

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

CheckpointStatisticDetailsHandler

public CheckpointStatisticDetailsHandler(CompletableFuture<String> localRestAddress,
                                         GatewayRetriever<? extends RestfulGateway> leaderRetriever,
                                         Time timeout,
                                         Map<String,String> responseHeaders,
                                         MessageHeaders<EmptyRequestBody,CheckpointStatistics,CheckpointMessageParameters> messageHeaders,
                                         ExecutionGraphCache executionGraphCache,
                                         Executor executor,
                                         CheckpointStatsCache checkpointStatsCache)

Method Detail

handleCheckpointRequest

protected CheckpointStatistics handleCheckpointRequest(HandlerRequest<EmptyRequestBody,CheckpointMessageParameters> ignored,
                                                       AbstractCheckpointStats checkpointStats)

Description copied from class: AbstractCheckpointHandler

Called for each request with the corresponding AbstractCheckpointStats instance.

Specified by:

handleCheckpointRequest in class AbstractCheckpointHandler<CheckpointStatistics,CheckpointMessageParameters>

Parameters:

ignored - for further information

checkpointStats - for which the handler is called

Returns:

Response

archiveJsonWithPath

public Collection<ArchivedJson> archiveJsonWithPath(AccessExecutionGraph graph)
                                             throws IOException

Description copied from interface: JsonArchivist

Returns a Collection of ArchivedJsons containing JSON responses and their respective REST URL for a given job.

The collection should contain one entry for every response that could be generated for the given job, for example one entry for each task. The REST URLs should be unique and must not contain placeholders.

Specified by:

archiveJsonWithPath in interface JsonArchivist

Parameters:

graph - AccessExecutionGraph for which the responses should be generated

Returns:

Collection containing an ArchivedJson for every response that could be generated for the given job

Throws:

IOException - thrown if the JSON generation fails