hbase-server/src/main/java/org/apache/hadoop/hbase/rsgroup/RSGroupInfoManager.java

   1 /**
   2  * Licensed to the Apache Software Foundation (ASF) under one
   3  * or more contributor license agreements.  See the NOTICE file
   4  * distributed with this work for additional information
   5  * regarding copyright ownership.  The ASF licenses this file
   6  * to you under the Apache License, Version 2.0 (the
   7  * "License"); you may not use this file except in compliance
   8  * with the License.  You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 package org.apache.hadoop.hbase.rsgroup;
  19
  20 import java.io.IOException;
  21 import java.util.List;
  22 import java.util.Set;
  23 import org.apache.hadoop.hbase.TableName;
  24 import org.apache.hadoop.hbase.master.MasterServices;
  25 import org.apache.hadoop.hbase.net.Address;
  26 import org.apache.yetus.audience.InterfaceAudience;
  27
  28 /**
  29  * Interface used to manage RSGroupInfo storage. An implementation has the option to support offline
  30  * mode. See {@code RSGroupBasedLoadBalancer}.
  31  */
  32 @InterfaceAudience.Private
  33 public interface RSGroupInfoManager {
  34
  35   void start();
  36
  37   /**
  38    * Add given RSGroupInfo to existing list of group infos.
  39    */
  40   void addRSGroup(RSGroupInfo rsGroupInfo) throws IOException;
  41
  42   /**
  43    * Remove a region server group.
  44    */
  45   void removeRSGroup(String groupName) throws IOException;
  46
  47   /**
  48    * Move servers to a new group.
  49    */
  50   void moveServers(Set<Address> servers, String targetGroupName) throws IOException;
  51
  52   /**
  53    * Gets the group info of server.
  54    */
  55   RSGroupInfo getRSGroupOfServer(Address serverHostPort) throws IOException;
  56
  57   /**
  58    * Gets {@code RSGroupInfo} for the given group name.
  59    */
  60   RSGroupInfo getRSGroup(String groupName) throws IOException;
  61
  62   /**
  63    * List the existing {@code RSGroupInfo}s.
  64    */
  65   List<RSGroupInfo> listRSGroups() throws IOException;
  66
  67   /**
  68    * Whether the manager is able to fully return group metadata
  69    * @return whether the manager is in online mode
  70    */
  71   boolean isOnline();
  72
  73   /**
  74    * Remove decommissioned servers from rsgroup
  75    * @param servers set of servers to remove
  76    */
  77   void removeServers(Set<Address> servers) throws IOException;
  78
  79   /**
  80    * Get {@code RSGroupInfo} for the given table.
  81    */
  82   RSGroupInfo getRSGroupForTable(TableName tableName) throws IOException;
  83
  84   static RSGroupInfoManager create(MasterServices master) throws IOException {
  85     if (RSGroupUtil.isRSGroupEnabled(master.getConfiguration())) {
  86       return RSGroupInfoManagerImpl.getInstance(master);
  87     } else {
  88       return new DisabledRSGroupInfoManager(master.getServerManager());
  89     }
  90   }
  91
  92   /**
  93    * Balance a region server group.
  94    */
  95   boolean balanceRSGroup(String groupName) throws IOException;
  96
  97   /**
  98    * Set group for tables.
  99    */
 100   void setRSGroup(Set<TableName> tables, String groupName) throws IOException;
 101
 102   /**
 103    * Determine {@code RSGroupInfo} for the given table.
 104    * @param tableName table name
 105    * @return rsgroup name
 106    */
 107   String determineRSGroupInfoForTable(TableName tableName);
 108
 109 }