1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to you under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.hadoop.hbase.quotas;
18
19 import java.io.IOException;
20
21 import org.apache.hadoop.hbase.TableName;
22 import org.apache.hadoop.hbase.classification.InterfaceAudience;
23 import org.apache.hadoop.hbase.classification.InterfaceStability;
24 import org.apache.hadoop.hbase.client.Connection;
25
26 /**
27 * An interface which abstract away the action taken to enable or disable
28 * a space quota violation policy across the HBase cluster. Implementations
29 * must have a no-args constructor.
30 */
31 @InterfaceAudience.Private
32 @InterfaceStability.Evolving
33 public interface SpaceQuotaSnapshotNotifier {
34
35 /**
36 * Initializes the notifier.
37 */
38 void initialize(Connection conn);
39
40 /**
41 * Instructs the cluster that the given table is in violation of a space quota. The
42 * provided violation policy is the action which should be taken on the table.
43 *
44 * @param tableName The name of the table in violation of the quota.
45 * @param snapshot The details of the violation of the quota.
46 */
47 void transitionTable(TableName tableName, SpaceQuotaSnapshot snapshot) throws IOException;
48 }