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

Class SavepointHandlers.SavepointTriggerHandler

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<T,B,TriggerResponse,M>

org.apache.flink.runtime.rest.handler.async.AbstractAsynchronousOperationHandlers.TriggerHandler<RestfulGateway,SavepointTriggerRequestBody,SavepointTriggerMessageParameters>

org.apache.flink.runtime.rest.handler.job.savepoints.SavepointHandlers.SavepointTriggerHandler

All Implemented Interfaces:

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

Enclosing class:

SavepointHandlers

public class SavepointHandlers.SavepointTriggerHandler
extends AbstractAsynchronousOperationHandlers.TriggerHandler<RestfulGateway,SavepointTriggerRequestBody,SavepointTriggerMessageParameters>

HTTP handler to trigger savepoints.

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
SavepointTriggerHandler(CompletableFuture<String> localRestAddress, GatewayRetriever<? extends RestfulGateway> leaderRetriever, Time timeout, Map<String,String> responseHeaders)

Method Summary

Modifier and Type	Method and Description
protected AsynchronousJobOperationKey	createOperationKey(HandlerRequest<SavepointTriggerRequestBody,SavepointTriggerMessageParameters> request) Create the operation key under which the result future of the asynchronous operation will be stored.
protected CompletableFuture<String>	triggerOperation(HandlerRequest<SavepointTriggerRequestBody,SavepointTriggerMessageParameters> request, RestfulGateway gateway) Trigger the asynchronous operation and return its future result.

Methods inherited from class org.apache.flink.runtime.rest.handler.async.AbstractAsynchronousOperationHandlers.TriggerHandler

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

SavepointTriggerHandler

public SavepointTriggerHandler(CompletableFuture<String> localRestAddress,
                               GatewayRetriever<? extends RestfulGateway> leaderRetriever,
                               Time timeout,
                               Map<String,String> responseHeaders)

Method Detail

triggerOperation

protected CompletableFuture<String> triggerOperation(HandlerRequest<SavepointTriggerRequestBody,SavepointTriggerMessageParameters> request,
                                                     RestfulGateway gateway)
                                              throws RestHandlerException

Description copied from class: AbstractAsynchronousOperationHandlers.TriggerHandler

Trigger the asynchronous operation and return its future result.

Specified by:

triggerOperation in class AbstractAsynchronousOperationHandlers.TriggerHandler<RestfulGateway,SavepointTriggerRequestBody,SavepointTriggerMessageParameters>

Parameters:

request - with which the trigger handler has been called

gateway - to the leader

Returns:

Future result of the asynchronous operation

Throws:

RestHandlerException - if something went wrong

createOperationKey

protected AsynchronousJobOperationKey createOperationKey(HandlerRequest<SavepointTriggerRequestBody,SavepointTriggerMessageParameters> request)

Description copied from class: AbstractAsynchronousOperationHandlers.TriggerHandler

Create the operation key under which the result future of the asynchronous operation will be stored.

Specified by:

createOperationKey in class AbstractAsynchronousOperationHandlers.TriggerHandler<RestfulGateway,SavepointTriggerRequestBody,SavepointTriggerMessageParameters>

Parameters:

request - with which the trigger handler has been called.

Returns:

Operation key under which the result future will be stored