001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to you under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.hadoop.hbase.quotas;
018
019import java.io.IOException;
020
021import org.apache.hadoop.hbase.TableName;
022import org.apache.yetus.audience.InterfaceAudience;
023import org.apache.hadoop.hbase.client.Connection;
024
025/**
026 * An interface which abstract away the action taken to enable or disable
027 * a space quota violation policy across the HBase cluster. Implementations
028 * must have a no-args constructor.
029 */
030@InterfaceAudience.Private
031public interface SpaceQuotaSnapshotNotifier {
032
033  /**
034   * Initializes the notifier.
035   */
036  void initialize(Connection conn);
037
038  /**
039   * Informs the cluster of the current state of a space quota for a table.
040   *
041   * @param tableName The name of the table.
042   * @param snapshot The details of the space quota utilization.
043   */
044  void transitionTable(TableName tableName, SpaceQuotaSnapshot snapshot) throws IOException;
045}