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.util.List;
021import org.apache.hadoop.hbase.HBaseInterfaceAudience;
022import org.apache.hadoop.hbase.TableName;
023import org.apache.yetus.audience.InterfaceAudience;
024import org.apache.yetus.audience.InterfaceStability;
025
026import org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.SetQuotaRequest.Builder;
027import org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas;
028
029/**
030 * An object which captures all quotas types (throttle or space) for a subject (user, table, or
031 * namespace). This is used inside of the HBase RegionServer to act as an analogy to the
032 * ProtocolBuffer class {@link Quotas}.
033 */
034@InterfaceAudience.LimitedPrivate({ HBaseInterfaceAudience.COPROC })
035@InterfaceStability.Evolving
036public abstract class GlobalQuotaSettings extends QuotaSettings {
037
038  protected GlobalQuotaSettings(String userName, TableName tableName, String namespace,
039    String regionServer) {
040    super(userName, tableName, namespace, regionServer);
041  }
042
043  /**
044   * Computes a list of QuotaSettings that present the complete quota state of the combination of
045   * this user, table, and/or namespace. Beware in calling this method repeatedly as the
046   * implementation of it may be costly.
047   */
048  public abstract List<QuotaSettings> getQuotaSettings();
049
050  @Override
051  public QuotaType getQuotaType() {
052    throw new UnsupportedOperationException();
053  }
054
055  @Override
056  protected void setupSetQuotaRequest(Builder builder) {
057    // ThrottleSettings should be used instead for setting a throttle quota.
058    throw new UnsupportedOperationException(
059      "This class should not be used to generate a SetQuotaRequest.");
060  }
061}