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

Class SavepointHandlers.SavepointStatusHandler

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<T,EmptyRequestBody,AsynchronousOperationResult<V>,M>

org.apache.flink.runtime.rest.handler.async.AbstractAsynchronousOperationHandlers.StatusHandler<RestfulGateway,SavepointInfo,SavepointStatusMessageParameters>

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

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.SavepointStatusHandler
extends AbstractAsynchronousOperationHandlers.StatusHandler<RestfulGateway,SavepointInfo,SavepointStatusMessageParameters>

HTTP handler to query for the status of the 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 and Description
SavepointStatusHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Time timeout, Map<String,String> responseHeaders)

Method Summary

Modifier and Type	Method and Description
protected SavepointInfo	exceptionalOperationResultResponse(Throwable throwable) Create an exceptional operation result from the given Throwable.
protected AsynchronousJobOperationKey	getOperationKey(HandlerRequest<EmptyRequestBody,SavepointStatusMessageParameters> request) Extract the operation key under which the operation result future is stored.
protected SavepointInfo	operationResultResponse(String operationResult) Create the operation result from the given value.

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

closeHandlerAsync, 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, 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.util.AutoCloseableAsync

close

Methods inherited from interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Detail

SavepointStatusHandler

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

Method Detail

getOperationKey

protected AsynchronousJobOperationKey getOperationKey(HandlerRequest<EmptyRequestBody,SavepointStatusMessageParameters> request)

Description copied from class: AbstractAsynchronousOperationHandlers.StatusHandler

Extract the operation key under which the operation result future is stored.

Specified by:

getOperationKey in class AbstractAsynchronousOperationHandlers.StatusHandler<RestfulGateway,SavepointInfo,SavepointStatusMessageParameters>

Parameters:

request - with which the status handler has been called

Returns:

Operation key under which the operation result future is stored

exceptionalOperationResultResponse

protected SavepointInfo exceptionalOperationResultResponse(Throwable throwable)

Description copied from class: AbstractAsynchronousOperationHandlers.StatusHandler

Create an exceptional operation result from the given Throwable. This method is called if the asynchronous operation failed.

Specified by:

exceptionalOperationResultResponse in class AbstractAsynchronousOperationHandlers.StatusHandler<RestfulGateway,SavepointInfo,SavepointStatusMessageParameters>

Parameters:

throwable - failure of the asynchronous operation

Returns:

Exceptional operation result

operationResultResponse

protected SavepointInfo operationResultResponse(String operationResult)

Description copied from class: AbstractAsynchronousOperationHandlers.StatusHandler

Create the operation result from the given value.

Specified by:

operationResultResponse in class AbstractAsynchronousOperationHandlers.StatusHandler<RestfulGateway,SavepointInfo,SavepointStatusMessageParameters>

Parameters:

operationResult - of the asynchronous operation

Returns:

Operation result