org.apache.hadoop.hbase.quotas.SpaceQuotaSnapshotNotifier Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hbase-server Show documentation

Server functionality for HBase

There is a newer version: 3.0.0-beta-1

/*
 * 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.hadoop.hbase.quotas;

import java.io.IOException;

import org.apache.hadoop.hbase.TableName;
import org.apache.yetus.audience.InterfaceAudience;
import org.apache.hadoop.hbase.client.Connection;

/**
 * An interface which abstract away the action taken to enable or disable
 * a space quota violation policy across the HBase cluster. Implementations
 * must have a no-args constructor.
 */
@InterfaceAudience.Private
public interface SpaceQuotaSnapshotNotifier {

  /**
   * Initializes the notifier.
   */
  void initialize(Connection conn);

  /**
   * Informs the cluster of the current state of a space quota for a table.
   *
   * @param tableName The name of the table.
   * @param snapshot The details of the space quota utilization.
   */
  void transitionTable(TableName tableName, SpaceQuotaSnapshot snapshot) throws IOException;
}