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

Class CheckpointConfigHandler

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

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

All Implemented Interfaces:

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

public class CheckpointConfigHandler
extends AbstractAccessExecutionGraphHandler<CheckpointConfigInfo,JobMessageParameters>
implements OnlyExecutionGraphJsonArchivist

Handler which serves the checkpoint configuration.

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

Constructor and Description
CheckpointConfigHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, org.apache.flink.api.common.time.Time timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,CheckpointConfigInfo,JobMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)

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 CheckpointConfigInfo	handleRequest(HandlerRequest<EmptyRequestBody,JobMessageParameters> request, AccessExecutionGraph executionGraph)

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

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.runtime.webmonitor.history.OnlyExecutionGraphJsonArchivist

archiveJsonWithPath

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

CheckpointConfigHandler

public CheckpointConfigHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever,
                               org.apache.flink.api.common.time.Time timeout,
                               Map<String,String> responseHeaders,
                               MessageHeaders<EmptyRequestBody,CheckpointConfigInfo,JobMessageParameters> messageHeaders,
                               ExecutionGraphCache executionGraphCache,
                               Executor executor)

Method Detail

handleRequest

protected CheckpointConfigInfo handleRequest(HandlerRequest<EmptyRequestBody,JobMessageParameters> request,
                                             AccessExecutionGraph executionGraph)
                                      throws RestHandlerException

Specified by:

handleRequest in class AbstractAccessExecutionGraphHandler<CheckpointConfigInfo,JobMessageParameters>

Throws:

RestHandlerException

archiveJsonWithPath

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

Description copied from interface: OnlyExecutionGraphJsonArchivist

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 OnlyExecutionGraphJsonArchivist

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