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

Class GetApiVersionHandler

  • 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
    public class GetApiVersionHandler
extends AbstractSqlGatewayRestHandler<org.apache.flink.runtime.rest.messages.EmptyRequestBody,​GetApiVersionResponseBody,​org.apache.flink.runtime.rest.messages.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.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​(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,​GetApiVersionResponseBody,​org.apache.flink.runtime.rest.messages.EmptyMessageParameters> messageHeaders)  
      GetApiVersionHandler​(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,​GetApiVersionResponseBody,​org.apache.flink.runtime.rest.messages.EmptyMessageParameters> messageHeaders, List<SqlGatewayRestAPIVersion> stableVersions)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected CompletableFuture<GetApiVersionResponseBody> 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.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 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​(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,​GetApiVersionResponseBody,​org.apache.flink.runtime.rest.messages.EmptyMessageParameters> messageHeaders)

      • GetApiVersionHandler

        @VisibleForTesting
public GetApiVersionHandler​(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,​GetApiVersionResponseBody,​org.apache.flink.runtime.rest.messages.EmptyMessageParameters> messageHeaders,
                            List<SqlGatewayRestAPIVersion> stableVersions)

    • Method Detail

      • handleRequest

        protected CompletableFuture<GetApiVersionResponseBody> handleRequest​(@Nullable
                                                                     SqlGatewayRestAPIVersion version,
                                                                     @Nonnull
                                                                     org.apache.flink.runtime.rest.handler.HandlerRequest<org.apache.flink.runtime.rest.messages.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<org.apache.flink.runtime.rest.messages.EmptyRequestBody,​GetApiVersionResponseBody,​org.apache.flink.runtime.rest.messages.EmptyMessageParameters>
        Parameters:
        version - request version
        request - request that should be handled
        Returns:
        future containing a handler response