org.apache.kyuubi.service.FrontendService.scala Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.kyuubi.service

/**
 * A [[FrontendService]] in Kyuubi architecture is responsible for taking requests from clients
 */
trait FrontendService {

  /**
   * The connection url for client to connect
   */
  def connectionUrl: String

  /**
   * A interface of [[Serverable]], e.g. Server/Engines for [[FrontendService]] to call
   */
  val serverable: Serverable

  /**
   * A interface of [[BackendService]], e.g. Server/Engines for [[FrontendService]] to call
   */
  final def be: BackendService = serverable.backendService

  /**
   * An optional `ServiceDiscovery` for [[FrontendService]] to expose itself
   */
  val discoveryService: Option[Service]

  /**
   * Attributes map for [[FrontendService]] to expose
   */
  def attributes: Map[String, String] = Map.empty
}