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