/*
 * Copyright © 2017 Cask Data, Inc.
 *
 * Licensed 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 io.cdap.cdap.data2.util.hbase;

import java.io.IOException;
import org.apache.hadoop.hbase.TableNotFoundException;
import org.apache.hadoop.hbase.client.Table;

/**
 * Interface to obtain the configuration HBase table.
 */
public interface ConfigurationTableProvider {

  /**
   * @return the configuration table as an {@link Table}
   * @throws TableNotFoundException if the table does not exist. This is expected if a
   *     coprocessor starts before the CDAP master creates the table.
   * @throws IOException for other errors
   */
  Table get() throws IOException;

  /**
   * @return the full table name of the configuration table. This should be used for logging
   *     purposes only.
   */
  String getTableName();
}
