RSGroupAdminServer (Apache HBase 1.4.11 API)

java.lang.Object
- org.apache.hadoop.hbase.rsgroup.RSGroupAdminServer

All Implemented Interfaces:

Closeable, AutoCloseable, RSGroupAdmin
```
@InterfaceAudience.Private
public class RSGroupAdminServer
extends Object
implements RSGroupAdmin
```
Service to support Region Server Grouping (HBase-6721)

Constructor Summary

Constructors
Constructor and Description

RSGroupAdminServer(MasterServices master, RSGroupInfoManager RSGroupInfoManager)

Constructors
Constructor and Description
`RSGroupAdminServer(MasterServices master, RSGroupInfoManager RSGroupInfoManager)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addRSGroup(String name)` Creates a new RegionServer group with the given name.
`boolean`	`balanceRSGroup(String groupName)` Balance regions in the given RegionServer group.
`void`	`cleanupRSGroupForTable(TableName tableName)`
`void`	`close()`
`RSGroupInfo`	`getRSGroupInfo(String groupName)` Gets `RSGroupInfo` for given group name.
`RSGroupInfoManager`	`getRSGroupInfoManager()`
`RSGroupInfo`	`getRSGroupInfoOfTable(TableName tableName)` Gets `RSGroupInfo` for the given table's group.
`RSGroupInfo`	`getRSGroupOfServer(Address server)` Retrieve the RSGroupInfo a server is affiliated to
`List<RSGroupInfo>`	`listRSGroups()` Lists current set of RegionServer groups.
`void`	`moveServers(Set<Address> servers, String targetGroupName)` Move given set of servers to the specified target RegionServer group.
`void`	`moveServersAndTables(Set<Address> servers, Set<TableName> tables, String targetGroup)` Move given set of servers and tables to the specified target RegionServer group.
`void`	`moveTables(Set<TableName> tables, String targetGroup)` Move given set of tables to the specified target RegionServer group.
`void`	`prepareRSGroupForTable(HTableDescriptor desc)`
`void`	`removeRSGroup(String name)` Removes RegionServer group associated with the given name.
`void`	`removeServers(Set<Address> servers)` Remove decommissioned servers from rsgroup.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RSGroupAdminServer
```
public RSGroupAdminServer(MasterServices master,
                  RSGroupInfoManager RSGroupInfoManager)
                   throws IOException
```
    Throws:
    
    IOException
- Method Detail
  - getRSGroupInfo
```
public RSGroupInfo getRSGroupInfo(String groupName)
                           throws IOException
```
    Description copied from interface: RSGroupAdmin
    
    Gets RSGroupInfo for given group name.
    
    Specified by:
    
    getRSGroupInfo in interface RSGroupAdmin
    
    Throws:
    
    IOException
  - getRSGroupInfoOfTable
```
public RSGroupInfo getRSGroupInfoOfTable(TableName tableName)
                                  throws IOException
```
    Description copied from interface: RSGroupAdmin
    
    Gets RSGroupInfo for the given table's group.
    
    Specified by:
    
    getRSGroupInfoOfTable in interface RSGroupAdmin
    
    Throws:
    
    IOException
  - moveServers
```
public void moveServers(Set<Address> servers,
               String targetGroupName)
                 throws IOException
```
    Description copied from interface: RSGroupAdmin
    
    Move given set of servers to the specified target RegionServer group.
    
    Specified by:
    
    moveServers in interface RSGroupAdmin
    
    Throws:
    
    IOException
  - moveTables
```
public void moveTables(Set<TableName> tables,
              String targetGroup)
                throws IOException
```
    Description copied from interface: RSGroupAdmin
    
    Move given set of tables to the specified target RegionServer group. This will unassign all of a table's region so it can be reassigned to the correct group.
    
    Specified by:
    
    moveTables in interface RSGroupAdmin
    
    Throws:
    
    IOException
  - addRSGroup
```
public void addRSGroup(String name)
                throws IOException
```
    Description copied from interface: RSGroupAdmin
    
    Creates a new RegionServer group with the given name.
    
    Specified by:
    
    addRSGroup in interface RSGroupAdmin
    
    Throws:
    
    IOException
  - removeRSGroup
```
public void removeRSGroup(String name)
                   throws IOException
```
    Description copied from interface: RSGroupAdmin
    
    Removes RegionServer group associated with the given name.
    
    Specified by:
    
    removeRSGroup in interface RSGroupAdmin
    
    Throws:
    
    IOException
  - balanceRSGroup
```
public boolean balanceRSGroup(String groupName)
                       throws IOException
```
    Description copied from interface: RSGroupAdmin
    
    Balance regions in the given RegionServer group.
    
    Specified by:
    
    balanceRSGroup in interface RSGroupAdmin
    
    Returns:
    boolean Whether balance ran or not
    
    Throws:
    
    IOException
  - listRSGroups
```
public List<RSGroupInfo> listRSGroups()
                               throws IOException
```
    Description copied from interface: RSGroupAdmin
    
    Lists current set of RegionServer groups.
    
    Specified by:
    
    listRSGroups in interface RSGroupAdmin
    
    Throws:
    
    IOException
  - getRSGroupOfServer
```
public RSGroupInfo getRSGroupOfServer(Address server)
                               throws IOException
```
    Description copied from interface: RSGroupAdmin
    
    Retrieve the RSGroupInfo a server is affiliated to
    
    Specified by:
    
    getRSGroupOfServer in interface RSGroupAdmin
    
    Parameters:
    server - HostPort to get RSGroupInfo for
    
    Throws:
    
    IOException
  - getRSGroupInfoManager
```
@InterfaceAudience.Private
public RSGroupInfoManager getRSGroupInfoManager()
                                         throws IOException
```
    Throws:
    
    IOException
  - removeServers
```
public void removeServers(Set<Address> servers)
                   throws IOException
```
    Description copied from interface: RSGroupAdmin
    
    Remove decommissioned servers from rsgroup. 1. Sometimes we may find the server aborted due to some hardware failure and we must offline the server for repairing. Or we need to move some servers to join other clusters. So we need to remove these servers from the rsgroup. 2. Dead/recovering/live servers will be disallowed.
    
    Specified by:
    
    removeServers in interface RSGroupAdmin
    
    Parameters:
    servers - set of servers to remove
    
    Throws:
    
    IOException
  - prepareRSGroupForTable
```
public void prepareRSGroupForTable(HTableDescriptor desc)
                            throws IOException
```
    Throws:
    
    IOException
  - cleanupRSGroupForTable
```
public void cleanupRSGroupForTable(TableName tableName)
                            throws IOException
```
    Throws:
    
    IOException
  - moveServersAndTables
```
public void moveServersAndTables(Set<Address> servers,
                        Set<TableName> tables,
                        String targetGroup)
                          throws IOException
```
    Description copied from interface: RSGroupAdmin
    
    Move given set of servers and tables to the specified target RegionServer group.
    
    Specified by:
    
    moveServersAndTables in interface RSGroupAdmin
    
    Parameters:
    servers - set of servers to move
    tables - set of tables to move
    targetGroup - the target group name
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException

Class RSGroupAdminServer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RSGroupAdminServer

Method Detail

getRSGroupInfo

getRSGroupInfoOfTable

moveServers

moveTables

addRSGroup

removeRSGroup

balanceRSGroup

listRSGroups

getRSGroupOfServer

getRSGroupInfoManager

removeServers

prepareRSGroupForTable

cleanupRSGroupForTable

moveServersAndTables

close