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

Class RescalingHandlers.RescalingStatusHandler

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>

AbstractAsynchronousOperationHandlers<AsynchronousJobOperationKey,Acknowledge>.StatusHandler<RestfulGateway,AsynchronousOperationInfo,RescalingStatusMessageParameters>

org.apache.flink.runtime.rest.handler.job.rescaling.RescalingHandlers.RescalingStatusHandler

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:

RescalingHandlers

public class RescalingHandlers.RescalingStatusHandler
extends AbstractAsynchronousOperationHandlers<AsynchronousJobOperationKey,Acknowledge>.StatusHandler<RestfulGateway,AsynchronousOperationInfo,RescalingStatusMessageParameters>

Handler which reports the status of the rescaling operation.

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

Method Summary

Modifier and Type	Method	Description
protected AsynchronousOperationInfo	exceptionalOperationResultResponse(Throwable throwable)	Create an exceptional operation result from the given Throwable.
protected AsynchronousJobOperationKey	getOperationKey(HandlerRequest<EmptyRequestBody> request)	Extract the operation key under which the operation result future is stored.
CompletableFuture<AsynchronousOperationResult<AsynchronousOperationInfo>>	handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)	This method is called for every incoming request and returns a CompletableFuture containing a the response.
protected AsynchronousOperationInfo	operationResultResponse(Acknowledge operationResult)	Create the operation result from the given value.

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

closeHandlerAsync

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

RescalingStatusHandler

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

Method Details

handleRequest

public CompletableFuture<AsynchronousOperationResult<AsynchronousOperationInfo>> handleRequest(@Nonnull
 HandlerRequest<EmptyRequestBody> 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.

Overrides:

handleRequest in class AbstractAsynchronousOperationHandlers<AsynchronousJobOperationKey,Acknowledge>.StatusHandler<RestfulGateway,AsynchronousOperationInfo,RescalingStatusMessageParameters>

Parameters:

request - request that should be handled

gateway - leader gateway

Returns:

future containing a handler response

Throws:

RestHandlerException - if the handling failed

getOperationKey

protected AsynchronousJobOperationKey getOperationKey(HandlerRequest<EmptyRequestBody> 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<AsynchronousJobOperationKey,Acknowledge>.StatusHandler<RestfulGateway,AsynchronousOperationInfo,RescalingStatusMessageParameters>

Parameters:

request - with which the status handler has been called

Returns:

Operation key under which the operation result future is stored

exceptionalOperationResultResponse

protected AsynchronousOperationInfo 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<AsynchronousJobOperationKey,Acknowledge>.StatusHandler<RestfulGateway,AsynchronousOperationInfo,RescalingStatusMessageParameters>

Parameters:

throwable - failure of the asynchronous operation

Returns:

Exceptional operation result

operationResultResponse

protected AsynchronousOperationInfo operationResultResponse(Acknowledge operationResult)

Description copied from class: AbstractAsynchronousOperationHandlers.StatusHandler

Create the operation result from the given value.

Specified by:

operationResultResponse in class AbstractAsynchronousOperationHandlers<AsynchronousJobOperationKey,Acknowledge>.StatusHandler<RestfulGateway,AsynchronousOperationInfo,RescalingStatusMessageParameters>

Parameters:

operationResult - of the asynchronous operation

Returns:

Operation result