org.apache.hadoop.hbase.client.QuotaStatusCalls Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.hbase.client;

import java.io.IOException;
import java.util.concurrent.Callable;

import org.apache.hadoop.hbase.ServerName;
import org.apache.yetus.audience.InterfaceAudience;
import org.apache.hadoop.hbase.ipc.RpcControllerFactory;
import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;
import org.apache.hadoop.hbase.shaded.protobuf.RequestConverter;
import org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService;
import org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.GetQuotaStatesResponse;
import org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.GetSpaceQuotaRegionSizesResponse;
import org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.GetSpaceQuotaSnapshotsResponse;

/**
 * Client class to wrap RPCs to HBase servers for space quota status information.
 */
@InterfaceAudience.Private
public class QuotaStatusCalls {

  /**
   * See {@link #getMasterRegionSizes(Connection, RpcControllerFactory, RpcRetryingCallerFactory, int)}
   */
  public static GetSpaceQuotaRegionSizesResponse getMasterRegionSizes(
      ClusterConnection clusterConn, int timeout) throws IOException {
    RpcControllerFactory rpcController = clusterConn.getRpcControllerFactory();
    RpcRetryingCallerFactory rpcCaller = clusterConn.getRpcRetryingCallerFactory();
    return getMasterRegionSizes(clusterConn, rpcController, rpcCaller, timeout);
  }

  /**
   * Executes an RPC to the HBase master to fetch its view on the Region sizes.
   */
  public static GetSpaceQuotaRegionSizesResponse getMasterRegionSizes(
      Connection conn, RpcControllerFactory factory, RpcRetryingCallerFactory rpcCaller,
      int timeout) throws IOException {
    MasterCallable callable =
        new MasterCallable(conn, factory) {
      @Override
      protected GetSpaceQuotaRegionSizesResponse rpcCall() throws Exception {
        return master.getSpaceQuotaRegionSizes(
            getRpcController(), RequestConverter.buildGetSpaceQuotaRegionSizesRequest());
      }
    };
    RpcRetryingCaller caller = rpcCaller.newCaller();
    try {
      return caller.callWithoutRetries(callable, timeout);
    } finally {
      callable.close();
    }
  }

  /**
   * See {@link #getMasterQuotaStates(Connection, RpcControllerFactory, RpcRetryingCallerFactory, int)}
   */
  public static GetQuotaStatesResponse getMasterQuotaStates(
      ClusterConnection clusterConn, int timeout) throws IOException {
    RpcControllerFactory rpcController = clusterConn.getRpcControllerFactory();
    RpcRetryingCallerFactory rpcCaller = clusterConn.getRpcRetryingCallerFactory();
    return getMasterQuotaStates(clusterConn, rpcController, rpcCaller, timeout);
  }

  /**
   * Executes an RPC tot he HBase master to fetch its view on space quotas.
   */
  public static GetQuotaStatesResponse getMasterQuotaStates(
      Connection conn, RpcControllerFactory factory, RpcRetryingCallerFactory rpcCaller,
      int timeout) throws IOException {
    MasterCallable callable =
        new MasterCallable(conn, factory) {
      @Override
      protected GetQuotaStatesResponse rpcCall() throws Exception {
        return master.getQuotaStates(
            getRpcController(), RequestConverter.buildGetQuotaStatesRequest());
      }
    };
    RpcRetryingCaller caller = rpcCaller.newCaller();
    try {
      return caller.callWithoutRetries(callable, timeout);
    } finally {
      callable.close();
    }
  }

  /**
   * See {@link #getRegionServerQuotaSnapshot(ClusterConnection, RpcControllerFactory, int, ServerName)}
   */
  public static GetSpaceQuotaSnapshotsResponse getRegionServerQuotaSnapshot(
      ClusterConnection clusterConn, int timeout, ServerName sn) throws IOException {
    RpcControllerFactory rpcController = clusterConn.getRpcControllerFactory();
    return getRegionServerQuotaSnapshot(clusterConn, rpcController, timeout, sn);
  }

  /**
   * Executes an RPC to the RegionServer identified by the {@code ServerName} to fetch its view
   * on space quotas.
   */
  public static GetSpaceQuotaSnapshotsResponse getRegionServerQuotaSnapshot(
      ClusterConnection conn, RpcControllerFactory factory,
      int timeout, ServerName sn) throws IOException {
    final AdminService.BlockingInterface admin = conn.getAdmin(sn);
    Callable callable =
        new Callable() {
      @Override
      public GetSpaceQuotaSnapshotsResponse call() throws Exception {
        return admin.getSpaceQuotaSnapshots(
            factory.newController(), RequestConverter.buildGetSpaceQuotaSnapshotsRequest());
      }
    };
    return ProtobufUtil.call(callable);
  }
}