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

Class SavepointHandlers.StopWithSavepointHandler

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,B,TriggerResponse,SavepointTriggerMessageParameters>

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

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

Enclosing class:

SavepointHandlers

public class SavepointHandlers.StopWithSavepointHandler
extends AbstractRestHandler<RestfulGateway,B,TriggerResponse,SavepointTriggerMessageParameters>

HTTP handler to stop a job with a savepoint.

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	Description
StopWithSavepointHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders)

Method Summary

Modifier and Type	Method	Description
protected AsynchronousJobOperationKey	createOperationKey(HandlerRequest<StopWithSavepointRequestBody> request)
protected Optional<TriggerId>	extractTriggerId(StopWithSavepointRequestBody request)
CompletableFuture<TriggerResponse>	handleRequest(HandlerRequest<StopWithSavepointRequestBody> request, RestfulGateway gateway)	This method is called for every incoming request and returns a CompletableFuture containing a the response.
protected CompletableFuture<Acknowledge>	triggerOperation(HandlerRequest<StopWithSavepointRequestBody> request, AsynchronousJobOperationKey operationKey, RestfulGateway gateway)

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

StopWithSavepointHandler

public StopWithSavepointHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever,
 Duration timeout,
 Map<String,String> responseHeaders)

Method Details

extractTriggerId

protected Optional<TriggerId> extractTriggerId(StopWithSavepointRequestBody request)

triggerOperation

protected CompletableFuture<Acknowledge> triggerOperation(HandlerRequest<StopWithSavepointRequestBody> request,
 AsynchronousJobOperationKey operationKey,
 RestfulGateway gateway)
                                                   throws RestHandlerException

Throws:

RestHandlerException

createOperationKey

protected AsynchronousJobOperationKey createOperationKey(HandlerRequest<StopWithSavepointRequestBody> request)

handleRequest

public CompletableFuture<TriggerResponse> handleRequest(@Nonnull
 HandlerRequest<StopWithSavepointRequestBody> request,
 @Nonnull
 RestfulGateway gateway)
                                                 throws RestHandlerException

Description copied from class: AbstractRestHandler

This method is called for every incoming request and returns a CompletableFuture containing a the response.

Implementations may decide whether to throw RestHandlerExceptions or fail the returned CompletableFuture with a RestHandlerException.

Failing the future with another exception type or throwing unchecked exceptions is regarded as an implementation error as it does not allow us to provide a meaningful HTTP status code. In this case a HttpResponseStatus.INTERNAL_SERVER_ERROR will be returned.

Specified by:

handleRequest in class AbstractRestHandler<RestfulGateway,B extends RequestBody,TriggerResponse,SavepointTriggerMessageParameters>

Parameters:

request - request that should be handled

gateway - leader gateway

Returns:

future containing a handler response

Throws:

RestHandlerException - if the handling failed