org.apache.hadoop.hbase.rsgroup

Class RSGroupAdmin

java.lang.Object

org.apache.hadoop.hbase.rsgroup.RSGroupAdmin

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

RSGroupAdminServer, VerifyingRSGroupAdminClient

@InterfaceAudience.Private
public abstract class RSGroupAdmin
extends Object
implements Closeable

Group user API interface used between client and server.

Constructor Summary

Constructors

Constructor and Description
RSGroupAdmin()

Method Summary

Modifier and Type	Method and Description
abstract void	addRSGroup(String name) Add a new group
abstract boolean	balanceRSGroup(String name) Balance the regions in a group
abstract RSGroupInfo	getRSGroupInfo(String groupName) Gets the regionserver group information.
abstract RSGroupInfo	getRSGroupInfoOfTable(TableName tableName) Gets the regionserver group info of table.
abstract RSGroupInfo	getRSGroupOfServer(HostAndPort hostPort) Retrieve the RSGroupInfo a server is affiliated to
abstract List<RSGroupInfo>	listRSGroups() Lists the existing groups.
abstract void	moveServers(Set<HostAndPort> servers, String targetGroup) Move a set of serves to another group
abstract void	moveTables(Set<TableName> tables, String targetGroup) Move tables to a new group.
static RSGroupAdmin	newClient(Connection conn) Create a new RSGroupAdmin client
abstract void	removeRSGroup(String name) Remove a regionserver group

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.io.Closeable

close

Constructor Detail

RSGroupAdmin

public RSGroupAdmin()

Method Detail

newClient

public static RSGroupAdmin newClient(Connection conn)
                              throws IOException

Create a new RSGroupAdmin client

Parameters:

conn - connection RSGroupAdmin instance will use

Returns:

a new RSGroupAdmin client

Throws:

IOException - on failure to create new client

getRSGroupInfo

public abstract RSGroupInfo getRSGroupInfo(String groupName)
                                    throws IOException

Gets the regionserver group information.

Parameters:

groupName - the group name

Returns:

An instance of RSGroupInfo

Throws:

IOException

getRSGroupInfoOfTable

public abstract RSGroupInfo getRSGroupInfoOfTable(TableName tableName)
                                           throws IOException

Gets the regionserver group info of table.

Parameters:

tableName - the table name

Returns:

An instance of RSGroupInfo.

Throws:

IOException

moveServers

public abstract void moveServers(Set<HostAndPort> servers,
                                 String targetGroup)
                          throws IOException

Move a set of serves to another group

Parameters:

servers - set of servers, must be in the form HOST:PORT

targetGroup - the target group

Throws:

IOException - Signals that an I/O exception has occurred.

moveTables

public abstract void moveTables(Set<TableName> tables,
                                String targetGroup)
                         throws IOException

Move tables to a new group. This will unassign all of a table's region so it can be reassigned to the correct group.

Parameters:

tables - list of tables to move

targetGroup - target group

Throws:

IOException - on failure to move tables

addRSGroup

public abstract void addRSGroup(String name)
                         throws IOException

Add a new group

Parameters:

name - name of the group

Throws:

IOException - on failure to add group

removeRSGroup

public abstract void removeRSGroup(String name)
                            throws IOException

Remove a regionserver group

Parameters:

name - name of the group

Throws:

IOException - on failure to remove group

balanceRSGroup

public abstract boolean balanceRSGroup(String name)
                                throws IOException

Balance the regions in a group

Parameters:

name - the name of the group to balance

Returns:

boolean whether balance ran or not

Throws:

IOException - on unexpected failure to balance group

listRSGroups

public abstract List<RSGroupInfo> listRSGroups()
                                        throws IOException

Lists the existing groups.

Returns:

Collection of RSGroupInfo.

Throws:

IOException

getRSGroupOfServer

public abstract RSGroupInfo getRSGroupOfServer(HostAndPort hostPort)
                                        throws IOException

Retrieve the RSGroupInfo a server is affiliated to

Parameters:

hostPort - HostPort to get RSGroupInfo for

Returns:

RSGroupInfo associated with the server

Throws:

IOException - on unexpected failure to retrieve GroupInfo