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

Class GetApiVersionHandler

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<NonLeaderRetrievalRestfulGateway,R,M>

org.apache.flink.table.gateway.rest.handler.AbstractSqlGatewayRestHandler<EmptyRequestBody,GetApiVersionResponseBody,EmptyMessageParameters>

org.apache.flink.table.gateway.rest.handler.util.GetApiVersionHandler

All Implemented Interfaces:

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

public class GetApiVersionHandler
extends AbstractSqlGatewayRestHandler<EmptyRequestBody,GetApiVersionResponseBody,EmptyMessageParameters>

Handler to get rest api version.

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
GetApiVersionHandler(SqlGatewayService service, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,GetApiVersionResponseBody,EmptyMessageParameters> messageHeaders)
GetApiVersionHandler(SqlGatewayService service, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,GetApiVersionResponseBody,EmptyMessageParameters> messageHeaders, List<SqlGatewayRestAPIVersion> stableVersions)

Method Summary

Modifier and Type	Method	Description
protected CompletableFuture<GetApiVersionResponseBody>	handleRequest(SqlGatewayRestAPIVersion version, HandlerRequest<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

GetApiVersionHandler

public GetApiVersionHandler(SqlGatewayService service,
                            Map<String,String> responseHeaders,
                            MessageHeaders<EmptyRequestBody,GetApiVersionResponseBody,EmptyMessageParameters> messageHeaders)

GetApiVersionHandler

@VisibleForTesting
public GetApiVersionHandler(SqlGatewayService service,
                            Map<String,String> responseHeaders,
                            MessageHeaders<EmptyRequestBody,GetApiVersionResponseBody,EmptyMessageParameters> messageHeaders,
                            List<SqlGatewayRestAPIVersion> stableVersions)

Method Detail

handleRequest

protected CompletableFuture<GetApiVersionResponseBody> handleRequest(@Nullable
                                                                     SqlGatewayRestAPIVersion version,
                                                                     @Nonnull
                                                                     HandlerRequest<EmptyRequestBody> request)

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<EmptyRequestBody,GetApiVersionResponseBody,EmptyMessageParameters>

Parameters:

version - request version

request - request that should be handled

Returns:

future containing a handler response