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