Package org.apache.flink.table.gateway.rest.handler.operation

Class AbstractOperationHandler

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.runtime.rest.handler.router.RoutedRequest>

org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler<T>

org.apache.flink.runtime.rest.handler.AbstractHandler<org.apache.flink.runtime.webmonitor.NonLeaderRetrievalRestfulGateway,R,M>

org.apache.flink.table.gateway.rest.handler.AbstractSqlGatewayRestHandler<org.apache.flink.runtime.rest.messages.EmptyRequestBody,OperationStatusResponseBody,OperationMessageParameters>

org.apache.flink.table.gateway.rest.handler.operation.AbstractOperationHandler

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

Direct Known Subclasses:

CancelOperationHandler, CloseOperationHandler, GetOperationStatusHandler

public abstract class AbstractOperationHandler
extends AbstractSqlGatewayRestHandler<org.apache.flink.runtime.rest.messages.EmptyRequestBody,OperationStatusResponseBody,OperationMessageParameters>

Abstract operation handler.

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.table.gateway.rest.handler.AbstractSqlGatewayRestHandler

service

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
AbstractOperationHandler(org.apache.flink.table.gateway.api.SqlGatewayService service, Map<String,String> responseHeaders, org.apache.flink.runtime.rest.messages.MessageHeaders<org.apache.flink.runtime.rest.messages.EmptyRequestBody,OperationStatusResponseBody,OperationMessageParameters> messageHeaders)

Method Summary

Modifier and Type	Method	Description
protected void	execute(org.apache.flink.table.gateway.api.session.SessionHandle sessionHandle, org.apache.flink.table.gateway.api.operation.OperationHandle operationHandle)
protected String	getStatus(org.apache.flink.table.gateway.api.session.SessionHandle sessionHandle, org.apache.flink.table.gateway.api.operation.OperationHandle operationHandle)
protected CompletableFuture<OperationStatusResponseBody>	handleRequest(SqlGatewayRestAPIVersion version, org.apache.flink.runtime.rest.handler.HandlerRequest<org.apache.flink.runtime.rest.messages.EmptyRequestBody> request)	This method is called for every incoming request and returns a CompletableFuture containing a the response.

Methods inherited from class org.apache.flink.table.gateway.rest.handler.AbstractSqlGatewayRestHandler

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 Detail

AbstractOperationHandler

public AbstractOperationHandler(org.apache.flink.table.gateway.api.SqlGatewayService service,
                                Map<String,String> responseHeaders,
                                org.apache.flink.runtime.rest.messages.MessageHeaders<org.apache.flink.runtime.rest.messages.EmptyRequestBody,OperationStatusResponseBody,OperationMessageParameters> messageHeaders)

Method Detail

getStatus

protected String getStatus(org.apache.flink.table.gateway.api.session.SessionHandle sessionHandle,
                           org.apache.flink.table.gateway.api.operation.OperationHandle operationHandle)

execute

protected void execute(org.apache.flink.table.gateway.api.session.SessionHandle sessionHandle,
                       org.apache.flink.table.gateway.api.operation.OperationHandle operationHandle)

handleRequest

protected CompletableFuture<OperationStatusResponseBody> handleRequest(SqlGatewayRestAPIVersion version,
                                                                       @Nonnull
                                                                       org.apache.flink.runtime.rest.handler.HandlerRequest<org.apache.flink.runtime.rest.messages.EmptyRequestBody> request)
                                                                throws org.apache.flink.runtime.rest.handler.RestHandlerException

Description copied from class: AbstractSqlGatewayRestHandler

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 AbstractSqlGatewayRestHandler<org.apache.flink.runtime.rest.messages.EmptyRequestBody,OperationStatusResponseBody,OperationMessageParameters>

Parameters:

version - request version

request - request that should be handled

Returns:

future containing a handler response

Throws:

org.apache.flink.runtime.rest.handler.RestHandlerException - if the handling failed