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

Class SqlGatewayRestEndpoint

  • All Implemented Interfaces:
    AutoCloseable, org.apache.flink.runtime.rest.RestService, org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpoint, org.apache.flink.util.AutoCloseableAsync
    public class SqlGatewayRestEndpoint
extends org.apache.flink.runtime.rest.RestServerEndpoint
implements org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpoint
    The rest endpoint for sql gateway.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.apache.flink.runtime.rest.RestServerEndpoint

        org.apache.flink.runtime.rest.RestServerEndpoint.RestHandlerUrlComparator

    • Field Summary

      Fields 
      Modifier and Type Field Description
      org.apache.flink.table.gateway.api.SqlGatewayService service  

      • Fields inherited from class org.apache.flink.runtime.rest.RestServerEndpoint

        log, responseHeaders, uploadDir

    • Constructor Summary

      Constructors 
      Constructor Description
      SqlGatewayRestEndpoint​(org.apache.flink.configuration.Configuration configuration, org.apache.flink.table.gateway.api.SqlGatewayService sqlGatewayService)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addOperationRelatedHandlers​(List<org.apache.flink.api.java.tuple.Tuple2<org.apache.flink.runtime.rest.handler.RestHandlerSpecification,​org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>> handlers)  
      protected void addUtilRelatedHandlers​(List<org.apache.flink.api.java.tuple.Tuple2<org.apache.flink.runtime.rest.handler.RestHandlerSpecification,​org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>> handlers)  
      protected List<org.apache.flink.api.java.tuple.Tuple2<org.apache.flink.runtime.rest.handler.RestHandlerSpecification,​org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>> initializeHandlers​(CompletableFuture<String> localAddressFuture)  
      protected void startInternal()  
      void stop()  

      • Methods inherited from class org.apache.flink.runtime.rest.RestServerEndpoint

        closeAsync, getRestBaseUrl, getRestPort, getServerAddress, shutDownInternal, start

      • Methods inherited from interface org.apache.flink.util.AutoCloseableAsync

        close

      • Methods inherited from interface org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpoint

        start

    • Field Detail

      • service

        public final org.apache.flink.table.gateway.api.SqlGatewayService service

    • Constructor Detail

      • SqlGatewayRestEndpoint

        public SqlGatewayRestEndpoint​(org.apache.flink.configuration.Configuration configuration,
                              org.apache.flink.table.gateway.api.SqlGatewayService sqlGatewayService)
                       throws IOException,
                              org.apache.flink.util.ConfigurationException
        Throws:
        IOException
        org.apache.flink.util.ConfigurationException

    • Method Detail

      • initializeHandlers

        protected List<org.apache.flink.api.java.tuple.Tuple2<org.apache.flink.runtime.rest.handler.RestHandlerSpecification,​org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>> initializeHandlers​(CompletableFuture<String> localAddressFuture)
        Specified by:
        initializeHandlers in class org.apache.flink.runtime.rest.RestServerEndpoint

      • addOperationRelatedHandlers

        protected void addOperationRelatedHandlers​(List<org.apache.flink.api.java.tuple.Tuple2<org.apache.flink.runtime.rest.handler.RestHandlerSpecification,​org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>> handlers)

      • addUtilRelatedHandlers

        protected void addUtilRelatedHandlers​(List<org.apache.flink.api.java.tuple.Tuple2<org.apache.flink.runtime.rest.handler.RestHandlerSpecification,​org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>> handlers)

      • startInternal

        protected void startInternal()
        Specified by:
        startInternal in class org.apache.flink.runtime.rest.RestServerEndpoint

      • stop

        public void stop()
          throws Exception
        Specified by:
        stop in interface org.apache.flink.table.gateway.api.endpoint.SqlGatewayEndpoint
        Throws:
        Exception