org.apache.hadoop.hbase.rsgroup

Class RSGroupAdminEndpoint

java.lang.Object

org.apache.hadoop.hbase.rsgroup.RSGroupAdminEndpoint

All Implemented Interfaces:

Coprocessor, MasterCoprocessor, MasterObserver

@InterfaceAudience.Private
public class RSGroupAdminEndpoint
extends Object
implements MasterCoprocessor, MasterObserver

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	RSGroupAdminEndpoint.RSGroupAdminServiceImpl Implementation of RSGroupAdminService defined in RSGroupAdmin.proto.

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.Coprocessor

Coprocessor.State

Field Summary

Fields

Modifier and Type	Field and Description
private AccessChecker	accessChecker
private RSGroupAdminServer	groupAdminServer
private org.apache.hadoop.hbase.protobuf.generated.RSGroupAdminProtos.RSGroupAdminService	groupAdminService
private RSGroupInfoManager	groupInfoManager
private static org.slf4j.Logger	LOG
private MasterServices	master
private UserProvider	userProvider Provider for mapping principal names to Users

Fields inherited from interface org.apache.hadoop.hbase.Coprocessor

PRIORITY_HIGHEST, PRIORITY_LOWEST, PRIORITY_SYSTEM, PRIORITY_USER, VERSION

Constructor Summary

Constructors

Constructor and Description
RSGroupAdminEndpoint()

Method Summary

Modifier and Type	Method and Description
(package private) void	assignTableToGroup(TableDescriptor desc)
void	checkPermission(String request)
private RSGroupInfo	determineRSGroupInfoForTable(TableDescriptor desc)
private User	getActiveUser() Returns the active user to which authorization checks should be applied.
(package private) RSGroupAdminServer	getGroupAdminServer()
(package private) RSGroupInfoManager	getGroupInfoManager()
Optional<MasterObserver>	getMasterObserver()
Iterable<com.google.protobuf.Service>	getServices() Coprocessor endpoints providing protobuf services should override this method.
private void	moveTableToRSGroup(TableDescriptor desc, RSGroupInfo rsGroupInfo)
private void	moveTableToValidRSGroup(TableDescriptor desc)
void	postClearDeadServers(ObserverContext<MasterCoprocessorEnvironment> ctx, List<ServerName> servers, List<ServerName> notClearedServers) Called after clear dead region servers.
void	postCompletedModifyTableAction(ObserverContext<MasterCoprocessorEnvironment> ctx, TableName tableName, TableDescriptor oldDescriptor, TableDescriptor currentDescriptor) Called after to modifying a table's properties.
void	postDeleteTable(ObserverContext<MasterCoprocessorEnvironment> ctx, TableName tableName) Called after the deleteTable operation has been requested.
void	preCloneSnapshot(ObserverContext<MasterCoprocessorEnvironment> ctx, SnapshotDescription snapshot, TableDescriptor desc) Called before a snapshot is cloned.
void	preCreateNamespace(ObserverContext<MasterCoprocessorEnvironment> ctx, NamespaceDescriptor ns) Called before a new namespace is created by HMaster.
void	preCreateTableAction(ObserverContext<MasterCoprocessorEnvironment> ctx, TableDescriptor desc, RegionInfo[] regions) Called before a new table is created by HMaster.
void	preModifyNamespace(ObserverContext<MasterCoprocessorEnvironment> ctx, NamespaceDescriptor ns) Called prior to modifying a namespace's properties.
void	preModifyTableAction(ObserverContext<MasterCoprocessorEnvironment> ctx, TableName tableName, TableDescriptor currentDescriptor, TableDescriptor newDescriptor) Called prior to modifying a table's properties.
(package private) boolean	rsgroupHasServersOnline(TableDescriptor desc)
void	start(CoprocessorEnvironment env) Called by the CoprocessorEnvironment during it's own startup to initialize the coprocessor.
void	stop(CoprocessorEnvironment env) Called by the CoprocessorEnvironment during it's own shutdown to stop the coprocessor.
private void	validateRSGroup(TableDescriptor desc, RSGroupInfo rsGroupInfo)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.coprocessor.MasterObserver

postAbortProcedure, postAddReplicationPeer, postAddRSGroup, postAssign, postBalance, postBalanceRSGroup, postBalanceSwitch, postCloneSnapshot, postCompletedCreateTableAction, postCompletedDeleteTableAction, postCompletedDisableTableAction, postCompletedEnableTableAction, postCompletedMergeRegionsAction, postCompletedModifyTableAction, postCompletedSnapshotAction, postCompletedSplitRegionAction, postCompletedTruncateTableAction, postCreateNamespace, postCreateTable, postDecommissionRegionServers, postDeleteNamespace, postDeleteSnapshot, postDisableReplicationPeer, postDisableTable, postEnableReplicationPeer, postEnableTable, postGetClusterMetrics, postGetLocks, postGetNamespaceDescriptor, postGetProcedures, postGetReplicationPeerConfig, postGetTableDescriptors, postGetTableNames, postGetUserPermissions, postGrant, postHasUserPermissions, postIsRpcThrottleEnabled, postListDecommissionedRegionServers, postListNamespaceDescriptors, postListNamespaces, postListReplicationPeers, postListSnapshot, postLockHeartbeat, postMasterStoreFlush, postMergeRegions, postMergeRegionsCommitAction, postModifyColumnFamilyStoreFileTracker, postModifyNamespace, postModifyNamespace, postModifyTable, postModifyTable, postModifyTableStoreFileTracker, postMove, postMoveServers, postMoveServersAndTables, postMoveTables, postRecommissionRegionServer, postRegionOffline, postRemoveReplicationPeer, postRemoveRSGroup, postRemoveServers, postRenameRSGroup, postRequestLock, postRestoreSnapshot, postRevoke, postRollBackMergeRegionsAction, postRollBackSplitRegionAction, postSetNamespaceQuota, postSetRegionServerQuota, postSetSplitOrMergeEnabled, postSetTableQuota, postSetUserQuota, postSetUserQuota, postSetUserQuota, postSnapshot, postStartMaster, postSwitchExceedThrottleQuota, postSwitchRpcThrottle, postTableFlush, postTruncateTable, postUnassign, postUnassign, postUpdateReplicationPeerConfig, postUpdateRSGroupConfig, preAbortProcedure, preAddReplicationPeer, preAddRSGroup, preAssign, preBalance, preBalanceRSGroup, preBalanceSwitch, preClearDeadServers, preCreateTable, preCreateTableRegionsInfos, preDecommissionRegionServers, preDeleteNamespace, preDeleteSnapshot, preDeleteTable, preDeleteTableAction, preDisableReplicationPeer, preDisableTable, preDisableTableAction, preEnableReplicationPeer, preEnableTable, preEnableTableAction, preGetClusterMetrics, preGetLocks, preGetNamespaceDescriptor, preGetProcedures, preGetReplicationPeerConfig, preGetTableDescriptors, preGetTableNames, preGetUserPermissions, preGrant, preHasUserPermissions, preIsRpcThrottleEnabled, preListDecommissionedRegionServers, preListNamespaceDescriptors, preListNamespaces, preListReplicationPeers, preListSnapshot, preLockHeartbeat, preMasterInitialization, preMasterStoreFlush, preMergeRegions, preMergeRegionsAction, preMergeRegionsCommitAction, preModifyColumnFamilyStoreFileTracker, preModifyNamespace, preModifyTable, preModifyTable, preModifyTableAction, preModifyTableStoreFileTracker, preMove, preMoveServers, preMoveServersAndTables, preMoveTables, preRecommissionRegionServer, preRegionOffline, preRemoveReplicationPeer, preRemoveRSGroup, preRemoveServers, preRenameRSGroup, preRequestLock, preRestoreSnapshot, preRevoke, preSetNamespaceQuota, preSetRegionServerQuota, preSetSplitOrMergeEnabled, preSetTableQuota, preSetUserQuota, preSetUserQuota, preSetUserQuota, preShutdown, preSnapshot, preSplitRegion, preSplitRegionAction, preSplitRegionAfterMETAAction, preSplitRegionBeforeMETAAction, preStopMaster, preSwitchExceedThrottleQuota, preSwitchRpcThrottle, preTableFlush, preTruncateTable, preTruncateTableAction, preUnassign, preUnassign, preUpdateReplicationPeerConfig, preUpdateRSGroupConfig

Field Detail

LOG

private static final org.slf4j.Logger LOG

master

private MasterServices master

groupInfoManager

private RSGroupInfoManager groupInfoManager

groupAdminServer

private RSGroupAdminServer groupAdminServer

groupAdminService

private final org.apache.hadoop.hbase.protobuf.generated.RSGroupAdminProtos.RSGroupAdminService groupAdminService

accessChecker

private AccessChecker accessChecker

userProvider

private UserProvider userProvider

Provider for mapping principal names to Users

Constructor Detail

RSGroupAdminEndpoint

public RSGroupAdminEndpoint()

Method Detail

start

public void start(CoprocessorEnvironment env)
           throws IOException

Description copied from interface: Coprocessor

Called by the CoprocessorEnvironment during it's own startup to initialize the coprocessor.

Specified by:

start in interface Coprocessor

Throws:

IOException

stop

public void stop(CoprocessorEnvironment env)

Description copied from interface: Coprocessor

Called by the CoprocessorEnvironment during it's own shutdown to stop the coprocessor.

Specified by:

stop in interface Coprocessor

getServices

public Iterable<com.google.protobuf.Service> getServices()

Description copied from interface: Coprocessor

Coprocessor endpoints providing protobuf services should override this method.

Specified by:

getServices in interface Coprocessor

Returns:

Iterable of Services or empty collection. Implementations should never return null.

getMasterObserver

public Optional<MasterObserver> getMasterObserver()

Specified by:

getMasterObserver in interface MasterCoprocessor

getGroupInfoManager

RSGroupInfoManager getGroupInfoManager()

getGroupAdminServer

RSGroupAdminServer getGroupAdminServer()

rsgroupHasServersOnline

boolean rsgroupHasServersOnline(TableDescriptor desc)
                         throws IOException

Throws:

IOException

assignTableToGroup

void assignTableToGroup(TableDescriptor desc)
                 throws IOException

Throws:

IOException

preCreateTableAction

public void preCreateTableAction(ObserverContext<MasterCoprocessorEnvironment> ctx,
                                 TableDescriptor desc,
                                 RegionInfo[] regions)
                          throws IOException

Description copied from interface: MasterObserver

Called before a new table is created by HMaster. Called as part of create table procedure and it is async to the create RPC call.

Specified by:

preCreateTableAction in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

desc - the TableDescriptor for the table

regions - the initial regions created for the table

Throws:

IOException

preModifyTableAction

public void preModifyTableAction(ObserverContext<MasterCoprocessorEnvironment> ctx,
                                 TableName tableName,
                                 TableDescriptor currentDescriptor,
                                 TableDescriptor newDescriptor)
                          throws IOException

Description copied from interface: MasterObserver

Called prior to modifying a table's properties. Called as part of modify table procedure and it is async to the modify table RPC call.

Specified by:

preModifyTableAction in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

tableName - the name of the table

currentDescriptor - current TableDescriptor of the table

newDescriptor - after modify operation, table will have this descriptor

Throws:

IOException

postCompletedModifyTableAction

public void postCompletedModifyTableAction(ObserverContext<MasterCoprocessorEnvironment> ctx,
                                           TableName tableName,
                                           TableDescriptor oldDescriptor,
                                           TableDescriptor currentDescriptor)
                                    throws IOException

Description copied from interface: MasterObserver

Called after to modifying a table's properties. Called as part of modify table procedure and it is async to the modify table RPC call.

Specified by:

postCompletedModifyTableAction in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

tableName - the name of the table

oldDescriptor - descriptor of table before modify operation happened

currentDescriptor - current TableDescriptor of the table

Throws:

IOException

moveTableToValidRSGroup

private void moveTableToValidRSGroup(TableDescriptor desc)
                              throws IOException

Throws:

IOException

validateRSGroup

private void validateRSGroup(TableDescriptor desc,
                             RSGroupInfo rsGroupInfo)
                      throws IOException

Throws:

IOException

moveTableToRSGroup

private void moveTableToRSGroup(TableDescriptor desc,
                                RSGroupInfo rsGroupInfo)
                         throws IOException

Throws:

IOException

determineRSGroupInfoForTable

private RSGroupInfo determineRSGroupInfoForTable(TableDescriptor desc)
                                          throws IOException

Throws:

IOException

postDeleteTable

public void postDeleteTable(ObserverContext<MasterCoprocessorEnvironment> ctx,
                            TableName tableName)
                     throws IOException

Description copied from interface: MasterObserver

Called after the deleteTable operation has been requested. Called as part of delete table RPC call.

Specified by:

postDeleteTable in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

tableName - the name of the table

Throws:

IOException

preCreateNamespace

public void preCreateNamespace(ObserverContext<MasterCoprocessorEnvironment> ctx,
                               NamespaceDescriptor ns)
                        throws IOException

Description copied from interface: MasterObserver

Called before a new namespace is created by HMaster.

Specified by:

preCreateNamespace in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

ns - the NamespaceDescriptor for the table

Throws:

IOException

preModifyNamespace

public void preModifyNamespace(ObserverContext<MasterCoprocessorEnvironment> ctx,
                               NamespaceDescriptor ns)
                        throws IOException

Description copied from interface: MasterObserver

Called prior to modifying a namespace's properties.

Specified by:

preModifyNamespace in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

ns - after modify operation, namespace will have this descriptor

Throws:

IOException

preCloneSnapshot

public void preCloneSnapshot(ObserverContext<MasterCoprocessorEnvironment> ctx,
                             SnapshotDescription snapshot,
                             TableDescriptor desc)
                      throws IOException

Description copied from interface: MasterObserver

Called before a snapshot is cloned. Called as part of restoreSnapshot RPC call.

Specified by:

preCloneSnapshot in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

snapshot - the SnapshotDescriptor for the snapshot

desc - the TableDescriptor of the table to create

Throws:

IOException

postClearDeadServers

public void postClearDeadServers(ObserverContext<MasterCoprocessorEnvironment> ctx,
                                 List<ServerName> servers,
                                 List<ServerName> notClearedServers)
                          throws IOException

Description copied from interface: MasterObserver

Called after clear dead region servers.

Specified by:

postClearDeadServers in interface MasterObserver

Throws:

IOException

checkPermission

public void checkPermission(String request)
                     throws IOException

Throws:

IOException

getActiveUser

private User getActiveUser()
                    throws IOException

Returns the active user to which authorization checks should be applied. If we are in the context of an RPC call, the remote user is used, otherwise the currently logged in user is used.

Throws:

IOException