Package org.apache.hadoop.hbase.security.access

Class MasterReadOnlyController

java.lang.Object

org.apache.hadoop.hbase.security.access.AbstractReadOnlyController

org.apache.hadoop.hbase.security.access.MasterReadOnlyController

All Implemented Interfaces:

Coprocessor, MasterCoprocessor, MasterObserver

@LimitedPrivate("Configuration")
public class MasterReadOnlyController
extends AbstractReadOnlyController
implements MasterCoprocessor, MasterObserver

Nested Class Summary

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

Coprocessor.State

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	LOG
private MasterServices	masterServices

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

PRIORITY_HIGHEST, PRIORITY_LOWEST, PRIORITY_SYSTEM, PRIORITY_USER, VERSION

Constructor Summary

Constructors

Constructor	Description
MasterReadOnlyController()

Method Summary

Modifier and Type	Method	Description
Optional<MasterObserver>	getMasterObserver()
void	preAddReplicationPeer(ObserverContext<MasterCoprocessorEnvironment> ctx, String peerId, ReplicationPeerConfig peerConfig)	Called before add a replication peer
void	preAddRSGroup(ObserverContext<MasterCoprocessorEnvironment> ctx, String name)	Called before a new region server group is added
void	preBalanceRSGroup(ObserverContext<MasterCoprocessorEnvironment> ctx, String groupName, BalanceRequest request)	Called before a region server group is removed
void	preCloneSnapshot(ObserverContext<MasterCoprocessorEnvironment> ctx, SnapshotDescription snapshot, TableDescriptor tableDescriptor)	Called before a snapshot is cloned.
void	preCreateNamespace(ObserverContext<MasterCoprocessorEnvironment> ctx, NamespaceDescriptor ns)	Called before a new namespace is created by HMaster.
void	preCreateTable(ObserverContext<MasterCoprocessorEnvironment> ctx, TableDescriptor desc, RegionInfo[] regions)	Called before a new table is created by HMaster.
void	preCreateTableAction(ObserverContext<MasterCoprocessorEnvironment> ctx, TableDescriptor desc, RegionInfo[] regions)	Called before a new table is created by HMaster.
TableDescriptor	preCreateTableRegionsInfos(ObserverContext<MasterCoprocessorEnvironment> ctx, TableDescriptor desc)	Called before we create the region infos for this table.
void	preDeleteNamespace(ObserverContext<MasterCoprocessorEnvironment> ctx, String namespace)	Called before HMaster deletes a namespace
void	preDeleteSnapshot(ObserverContext<MasterCoprocessorEnvironment> ctx, SnapshotDescription snapshot)	Called before a snapshot is deleted.
void	preDeleteTable(ObserverContext<MasterCoprocessorEnvironment> ctx, TableName tableName)	Called before HMaster deletes a table.
void	preDeleteTableAction(ObserverContext<MasterCoprocessorEnvironment> ctx, TableName tableName)	Called before HMaster deletes a table.
void	preDisableReplicationPeer(ObserverContext<MasterCoprocessorEnvironment> ctx, String peerId)	Called before disable a replication peer
void	preEnableReplicationPeer(ObserverContext<MasterCoprocessorEnvironment> ctx, String peerId)	Called before enable a replication peer
void	preGrant(ObserverContext<MasterCoprocessorEnvironment> ctx, UserPermission userPermission, boolean mergeExistingPermissions)	Called before granting user permissions.
void	preMasterStoreFlush(ObserverContext<MasterCoprocessorEnvironment> ctx)	Called before the master local region memstore is flushed to disk.
void	preMergeRegions(ObserverContext<MasterCoprocessorEnvironment> ctx, RegionInfo[] regionsToMerge)	Called before merge regions request.
void	preMergeRegionsAction(ObserverContext<MasterCoprocessorEnvironment> ctx, RegionInfo[] regionsToMerge)	Called before the regions merge.
void	preMergeRegionsCommitAction(ObserverContext<MasterCoprocessorEnvironment> ctx, RegionInfo[] regionsToMerge, List<Mutation> metaEntries)	This will be called before update META step as part of regions merge transaction.
String	preModifyColumnFamilyStoreFileTracker(ObserverContext<MasterCoprocessorEnvironment> ctx, TableName tableName, byte[] family, String dstSFT)	Called prior to modifying a family's store file tracker.
void	preModifyNamespace(ObserverContext<MasterCoprocessorEnvironment> ctx, NamespaceDescriptor currentNsDescriptor, NamespaceDescriptor newNsDescriptor)	Called prior to modifying a namespace's properties.
TableDescriptor	preModifyTable(ObserverContext<MasterCoprocessorEnvironment> ctx, TableName tableName, TableDescriptor currentDescriptor, TableDescriptor newDescriptor)	Called prior to modifying a table's properties.
void	preModifyTableAction(ObserverContext<MasterCoprocessorEnvironment> ctx, TableName tableName, TableDescriptor currentDescriptor, TableDescriptor newDescriptor)	Called prior to modifying a table's properties.
String	preModifyTableStoreFileTracker(ObserverContext<MasterCoprocessorEnvironment> ctx, TableName tableName, String dstSFT)	Called prior to modifying a table's store file tracker.
void	preMoveServers(ObserverContext<MasterCoprocessorEnvironment> ctx, Set<Address> servers, String targetGroup)	Called before servers are moved to target region server group
void	preMoveServersAndTables(ObserverContext<MasterCoprocessorEnvironment> ctx, Set<Address> servers, Set<TableName> tables, String targetGroup)	Called before servers are moved to target region server group
void	preMoveTables(ObserverContext<MasterCoprocessorEnvironment> ctx, Set<TableName> tables, String targetGroup)	Called before tables are moved to target region server group
void	preRemoveReplicationPeer(ObserverContext<MasterCoprocessorEnvironment> ctx, String peerId)	Called before remove a replication peer
void	preRemoveRSGroup(ObserverContext<MasterCoprocessorEnvironment> ctx, String name)	Called before a region server group is removed
void	preRemoveServers(ObserverContext<MasterCoprocessorEnvironment> ctx, Set<Address> servers)	Called before servers are removed from rsgroup
void	preRenameRSGroup(ObserverContext<MasterCoprocessorEnvironment> ctx, String oldName, String newName)	Called before rename rsgroup.
void	preRestoreSnapshot(ObserverContext<MasterCoprocessorEnvironment> ctx, SnapshotDescription snapshot, TableDescriptor tableDescriptor)	Called before a snapshot is restored.
void	preRevoke(ObserverContext<MasterCoprocessorEnvironment> ctx, UserPermission userPermission)	Called before revoking user permissions.
void	preSetNamespaceQuota(ObserverContext<MasterCoprocessorEnvironment> ctx, String namespace, GlobalQuotaSettings quotas)	Called before the quota for the namespace is stored.
void	preSetRegionServerQuota(ObserverContext<MasterCoprocessorEnvironment> ctx, String regionServer, GlobalQuotaSettings quotas)	Called before the quota for the region server is stored.
void	preSetTableQuota(ObserverContext<MasterCoprocessorEnvironment> ctx, TableName tableName, GlobalQuotaSettings quotas)	Called before the quota for the table is stored.
void	preSetUserQuota(ObserverContext<MasterCoprocessorEnvironment> ctx, String userName, String namespace, GlobalQuotaSettings quotas)	Called before the quota for the user on the specified namespace is stored.
void	preSetUserQuota(ObserverContext<MasterCoprocessorEnvironment> ctx, String userName, GlobalQuotaSettings quotas)	Called before the quota for the user is stored.
void	preSetUserQuota(ObserverContext<MasterCoprocessorEnvironment> ctx, String userName, TableName tableName, GlobalQuotaSettings quotas)	Called before the quota for the user on the specified table is stored.
void	preSnapshot(ObserverContext<MasterCoprocessorEnvironment> ctx, SnapshotDescription snapshot, TableDescriptor tableDescriptor)	Called before a new snapshot is taken.
void	preSplitRegion(ObserverContext<MasterCoprocessorEnvironment> c, TableName tableName, byte[] splitRow)	Called before the split region procedure is called.
void	preSplitRegionAction(ObserverContext<MasterCoprocessorEnvironment> c, TableName tableName, byte[] splitRow)	Called before the region is split.
void	preSplitRegionAfterMETAAction(ObserverContext<MasterCoprocessorEnvironment> ctx)	This will be called after update META step as part of split transaction
void	preSplitRegionBeforeMETAAction(ObserverContext<MasterCoprocessorEnvironment> ctx, byte[] splitKey, List<Mutation> metaEntries)	This will be called before update META step as part of split transaction.
void	preTransitReplicationPeerSyncReplicationState(ObserverContext<MasterCoprocessorEnvironment> ctx, String peerId, SyncReplicationState state)	Called before transit current cluster state for the specified synchronous replication peer
void	preTruncateRegion(ObserverContext<MasterCoprocessorEnvironment> c, RegionInfo regionInfo)	Called before the truncate region procedure is called.
void	preTruncateRegionAction(ObserverContext<MasterCoprocessorEnvironment> c, RegionInfo regionInfo)	Called before the region is truncated.
void	preTruncateTable(ObserverContext<MasterCoprocessorEnvironment> ctx, TableName tableName)	Called before HMaster truncates a table.
void	preTruncateTableAction(ObserverContext<MasterCoprocessorEnvironment> ctx, TableName tableName)	Called before HMaster truncates a table.
void	preUpdateReplicationPeerConfig(ObserverContext<MasterCoprocessorEnvironment> ctx, String peerId, ReplicationPeerConfig peerConfig)	Called before update peerConfig for the specified peer
void	preUpdateRSGroupConfig(ObserverContext<MasterCoprocessorEnvironment> ctx, String groupName, Map<String,String> configuration)	Called before update rsgroup config.

Methods inherited from class org.apache.hadoop.hbase.security.access.AbstractReadOnlyController

internalReadOnlyGuard, isWritableInReadOnlyMode, isWritableInReadOnlyMode, manageActiveClusterIdFile, start, stop

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

getServices, start, stop

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

postAbortProcedure, postAddReplicationPeer, postAddRSGroup, postAssign, postBalance, postBalanceRSGroup, postBalanceSwitch, postClearDeadServers, postCloneSnapshot, postCompletedCreateTableAction, postCompletedDeleteTableAction, postCompletedDisableTableAction, postCompletedEnableTableAction, postCompletedMergeRegionsAction, postCompletedModifyTableAction, postCompletedSnapshotAction, postCompletedSplitRegionAction, postCompletedTruncateTableAction, postCreateNamespace, postCreateTable, postDecommissionRegionServers, postDeleteNamespace, postDeleteSnapshot, postDeleteTable, postDisableReplicationPeer, postDisableTable, postEnableReplicationPeer, postEnableTable, postGetClusterMetrics, postGetConfiguredNamespacesAndTablesInRSGroup, postGetLocks, postGetNamespaceDescriptor, postGetProcedures, postGetReplicationPeerConfig, postGetRSGroupInfo, postGetRSGroupInfoOfServer, postGetRSGroupInfoOfTable, postGetTableDescriptors, postGetTableNames, postGetUserPermissions, postGrant, postHasUserPermissions, postIsRpcThrottleEnabled, postListDecommissionedRegionServers, postListNamespaceDescriptors, postListNamespaces, postListReplicationPeers, postListRSGroups, postListSnapshot, postListTablesInRSGroup, postLockHeartbeat, postMasterStoreFlush, postMergeRegions, postMergeRegionsCommitAction, postModifyColumnFamilyStoreFileTracker, postModifyNamespace, 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, postTransitReplicationPeerSyncReplicationState, postTruncateRegion, postTruncateRegionAction, postTruncateTable, postUnassign, postUpdateMasterConfiguration, postUpdateReplicationPeerConfig, postUpdateRSGroupConfig, preAbortProcedure, preAssign, preBalance, preBalanceSwitch, preClearDeadServers, preDecommissionRegionServers, preDisableTable, preDisableTableAction, preEnableTable, preEnableTableAction, preGetClusterMetrics, preGetConfiguredNamespacesAndTablesInRSGroup, preGetLocks, preGetNamespaceDescriptor, preGetProcedures, preGetReplicationPeerConfig, preGetRSGroupInfo, preGetRSGroupInfoOfServer, preGetRSGroupInfoOfTable, preGetTableDescriptors, preGetTableNames, preGetUserPermissions, preHasUserPermissions, preIsRpcThrottleEnabled, preListDecommissionedRegionServers, preListNamespaceDescriptors, preListNamespaces, preListReplicationPeers, preListRSGroups, preListSnapshot, preListTablesInRSGroup, preLockHeartbeat, preMasterInitialization, preMove, preRecommissionRegionServer, preRegionOffline, preRequestLock, preSetSplitOrMergeEnabled, preShutdown, preStopMaster, preSwitchExceedThrottleQuota, preSwitchRpcThrottle, preTableFlush, preUnassign, preUpdateMasterConfiguration

Field Details

LOG

private static final org.slf4j.Logger LOG

masterServices

private MasterServices masterServices

Constructor Details

MasterReadOnlyController

public MasterReadOnlyController()

Method Details

getMasterObserver

public Optional<MasterObserver> getMasterObserver()

Specified by:

getMasterObserver in interface MasterCoprocessor

preCreateTableRegionsInfos

public TableDescriptor preCreateTableRegionsInfos(ObserverContext<MasterCoprocessorEnvironment> ctx,
 TableDescriptor desc)
                                           throws IOException

Description copied from interface: MasterObserver

Called before we create the region infos for this table. Called as part of create table RPC call.

Specified by:

preCreateTableRegionsInfos in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

desc - the TableDescriptor for the table

Returns:

the TableDescriptor used to create the table. Default is the one passed in. Return null means cancel the creation.

Throws:

IOException

preCreateTable

public void preCreateTable(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 RPC call.

Specified by:

preCreateTable 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

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

preDeleteTable

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

Description copied from interface: MasterObserver

Called before HMaster deletes a table. Called as part of delete table RPC call.

Specified by:

preDeleteTable in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

tableName - the name of the table

Throws:

IOException

preDeleteTableAction

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

Description copied from interface: MasterObserver

Called before HMaster deletes a table. Called as part of delete table procedure and it is async to the delete RPC call.

Specified by:

preDeleteTableAction in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

tableName - the name of the table

Throws:

IOException

preTruncateTable

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

Description copied from interface: MasterObserver

Called before HMaster truncates a table. Called as part of truncate table RPC call.

Specified by:

preTruncateTable in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

tableName - the name of the table

Throws:

IOException

preTruncateTableAction

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

Description copied from interface: MasterObserver

Called before HMaster truncates a table. Called as part of truncate table procedure and it is async to the truncate RPC call.

Specified by:

preTruncateTableAction in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

tableName - the name of the table

Throws:

IOException

preModifyTable

public TableDescriptor preModifyTable(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 RPC call.

Specified by:

preModifyTable 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

preModifyTableStoreFileTracker

public String preModifyTableStoreFileTracker(ObserverContext<MasterCoprocessorEnvironment> ctx,
 TableName tableName,
 String dstSFT)
                                      throws IOException

Description copied from interface: MasterObserver

Called prior to modifying a table's store file tracker. Called as part of modify table store file tracker RPC call.

Specified by:

preModifyTableStoreFileTracker in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

tableName - the name of the table

dstSFT - the store file tracker

Returns:

the store file tracker

Throws:

IOException

preModifyColumnFamilyStoreFileTracker

public String preModifyColumnFamilyStoreFileTracker(ObserverContext<MasterCoprocessorEnvironment> ctx,
 TableName tableName,
 byte[] family,
 String dstSFT)
                                             throws IOException

Description copied from interface: MasterObserver

Called prior to modifying a family's store file tracker. Called as part of modify family store file tracker RPC call.

Specified by:

preModifyColumnFamilyStoreFileTracker in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

tableName - the name of the table

family - the column family

dstSFT - the store file tracker

Returns:

the store file tracker

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

preSplitRegion

public void preSplitRegion(ObserverContext<MasterCoprocessorEnvironment> c,
 TableName tableName,
 byte[] splitRow)
                    throws IOException

Description copied from interface: MasterObserver

Called before the split region procedure is called.

Specified by:

preSplitRegion in interface MasterObserver

Parameters:

c - the environment to interact with the framework and master

tableName - the table where the region belongs to

splitRow - split point

Throws:

IOException

preSplitRegionAction

public void preSplitRegionAction(ObserverContext<MasterCoprocessorEnvironment> c,
 TableName tableName,
 byte[] splitRow)
                          throws IOException

Description copied from interface: MasterObserver

Called before the region is split.

Specified by:

preSplitRegionAction in interface MasterObserver

Parameters:

c - the environment to interact with the framework and master

tableName - the table where the region belongs to

splitRow - split point

Throws:

IOException

preSplitRegionBeforeMETAAction

public void preSplitRegionBeforeMETAAction(ObserverContext<MasterCoprocessorEnvironment> ctx,
 byte[] splitKey,
 List<Mutation> metaEntries)
                                    throws IOException

Description copied from interface: MasterObserver

This will be called before update META step as part of split transaction.

Specified by:

preSplitRegionBeforeMETAAction in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

Throws:

IOException

preSplitRegionAfterMETAAction

public void preSplitRegionAfterMETAAction(ObserverContext<MasterCoprocessorEnvironment> ctx)
                                   throws IOException

Description copied from interface: MasterObserver

This will be called after update META step as part of split transaction

Specified by:

preSplitRegionAfterMETAAction in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

Throws:

IOException

preTruncateRegion

public void preTruncateRegion(ObserverContext<MasterCoprocessorEnvironment> c,
 RegionInfo regionInfo)

Description copied from interface: MasterObserver

Called before the truncate region procedure is called.

Specified by:

preTruncateRegion in interface MasterObserver

Parameters:

c - The environment to interact with the framework and master

regionInfo - The Region being truncated

preTruncateRegionAction

public void preTruncateRegionAction(ObserverContext<MasterCoprocessorEnvironment> c,
 RegionInfo regionInfo)

Description copied from interface: MasterObserver

Called before the region is truncated.

Specified by:

preTruncateRegionAction in interface MasterObserver

Parameters:

c - The environment to interact with the framework and master

regionInfo - The Region being truncated

preMergeRegionsAction

public void preMergeRegionsAction(ObserverContext<MasterCoprocessorEnvironment> ctx,
 RegionInfo[] regionsToMerge)
                           throws IOException

Description copied from interface: MasterObserver

Called before the regions merge.

Specified by:

preMergeRegionsAction in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

Throws:

IOException

preMergeRegionsCommitAction

public void preMergeRegionsCommitAction(ObserverContext<MasterCoprocessorEnvironment> ctx,
 RegionInfo[] regionsToMerge,
 List<Mutation> metaEntries)
                                 throws IOException

Description copied from interface: MasterObserver

This will be called before update META step as part of regions merge transaction.

Specified by:

preMergeRegionsCommitAction in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

metaEntries - mutations to execute on hbase:meta atomically with regions merge updates. Any puts or deletes to execute on hbase:meta can be added to the mutations.

Throws:

IOException

preSnapshot

public void preSnapshot(ObserverContext<MasterCoprocessorEnvironment> ctx,
 SnapshotDescription snapshot,
 TableDescriptor tableDescriptor)
                 throws IOException

Description copied from interface: MasterObserver

Called before a new snapshot is taken. Called as part of snapshot RPC call.

Specified by:

preSnapshot in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

snapshot - the SnapshotDescriptor for the snapshot

tableDescriptor - the TableDescriptor of the table to snapshot

Throws:

IOException

preCloneSnapshot

public void preCloneSnapshot(ObserverContext<MasterCoprocessorEnvironment> ctx,
 SnapshotDescription snapshot,
 TableDescriptor tableDescriptor)
                      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

tableDescriptor - the TableDescriptor of the table to create

Throws:

IOException

preRestoreSnapshot

public void preRestoreSnapshot(ObserverContext<MasterCoprocessorEnvironment> ctx,
 SnapshotDescription snapshot,
 TableDescriptor tableDescriptor)
                        throws IOException

Description copied from interface: MasterObserver

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

Specified by:

preRestoreSnapshot in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

snapshot - the SnapshotDescriptor for the snapshot

tableDescriptor - the TableDescriptor of the table to restore

Throws:

IOException

preDeleteSnapshot

public void preDeleteSnapshot(ObserverContext<MasterCoprocessorEnvironment> ctx,
 SnapshotDescription snapshot)
                       throws IOException

Description copied from interface: MasterObserver

Called before a snapshot is deleted. Called as part of deleteSnapshot RPC call.

Specified by:

preDeleteSnapshot in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

snapshot - the SnapshotDescriptor of the snapshot to delete

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 currentNsDescriptor,
 NamespaceDescriptor newNsDescriptor)
                        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

currentNsDescriptor - current NamespaceDescriptor of the namespace

newNsDescriptor - after modify operation, namespace will have this descriptor

Throws:

IOException

preDeleteNamespace

public void preDeleteNamespace(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String namespace)
                        throws IOException

Description copied from interface: MasterObserver

Called before HMaster deletes a namespace

Specified by:

preDeleteNamespace in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

namespace - the name of the namespace

Throws:

IOException

preMasterStoreFlush

public void preMasterStoreFlush(ObserverContext<MasterCoprocessorEnvironment> ctx)
                         throws IOException

Description copied from interface: MasterObserver

Called before the master local region memstore is flushed to disk.

Specified by:

preMasterStoreFlush in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

Throws:

IOException

preSetUserQuota

public void preSetUserQuota(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String userName,
 GlobalQuotaSettings quotas)
                     throws IOException

Description copied from interface: MasterObserver

Called before the quota for the user is stored.

Specified by:

preSetUserQuota in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

userName - the name of user

quotas - the current quota for the user

Throws:

IOException

preSetUserQuota

public void preSetUserQuota(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String userName,
 TableName tableName,
 GlobalQuotaSettings quotas)
                     throws IOException

Description copied from interface: MasterObserver

Called before the quota for the user on the specified table is stored.

Specified by:

preSetUserQuota in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

userName - the name of user

tableName - the name of the table

quotas - the current quota for the user on the table

Throws:

IOException

preSetUserQuota

public void preSetUserQuota(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String userName,
 String namespace,
 GlobalQuotaSettings quotas)
                     throws IOException

Description copied from interface: MasterObserver

Called before the quota for the user on the specified namespace is stored.

Specified by:

preSetUserQuota in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

userName - the name of user

namespace - the name of the namespace

quotas - the current quota for the user on the namespace

Throws:

IOException

preSetTableQuota

public void preSetTableQuota(ObserverContext<MasterCoprocessorEnvironment> ctx,
 TableName tableName,
 GlobalQuotaSettings quotas)
                      throws IOException

Description copied from interface: MasterObserver

Called before the quota for the table is stored.

Specified by:

preSetTableQuota in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

tableName - the name of the table

quotas - the current quota for the table

Throws:

IOException

preSetNamespaceQuota

public void preSetNamespaceQuota(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String namespace,
 GlobalQuotaSettings quotas)
                          throws IOException

Description copied from interface: MasterObserver

Called before the quota for the namespace is stored.

Specified by:

preSetNamespaceQuota in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

namespace - the name of the namespace

quotas - the current quota for the namespace

Throws:

IOException

preSetRegionServerQuota

public void preSetRegionServerQuota(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String regionServer,
 GlobalQuotaSettings quotas)
                             throws IOException

Description copied from interface: MasterObserver

Called before the quota for the region server is stored.

Specified by:

preSetRegionServerQuota in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

regionServer - the name of the region server

quotas - the current quota for the region server

Throws:

IOException

preMergeRegions

public void preMergeRegions(ObserverContext<MasterCoprocessorEnvironment> ctx,
 RegionInfo[] regionsToMerge)
                     throws IOException

Description copied from interface: MasterObserver

Called before merge regions request.

Specified by:

preMergeRegions in interface MasterObserver

Parameters:

ctx - coprocessor environment

regionsToMerge - regions to be merged

Throws:

IOException

preMoveServersAndTables

public void preMoveServersAndTables(ObserverContext<MasterCoprocessorEnvironment> ctx,
 Set<Address> servers,
 Set<TableName> tables,
 String targetGroup)
                             throws IOException

Description copied from interface: MasterObserver

Called before servers are moved to target region server group

Specified by:

preMoveServersAndTables in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

servers - set of servers to move

targetGroup - destination group

Throws:

IOException

preMoveServers

public void preMoveServers(ObserverContext<MasterCoprocessorEnvironment> ctx,
 Set<Address> servers,
 String targetGroup)
                    throws IOException

Description copied from interface: MasterObserver

Called before servers are moved to target region server group

Specified by:

preMoveServers in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

servers - set of servers to move

targetGroup - destination group

Throws:

IOException

preMoveTables

public void preMoveTables(ObserverContext<MasterCoprocessorEnvironment> ctx,
 Set<TableName> tables,
 String targetGroup)
                   throws IOException

Description copied from interface: MasterObserver

Called before tables are moved to target region server group

Specified by:

preMoveTables in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

tables - set of tables to move

targetGroup - name of group

Throws:

IOException

preAddRSGroup

public void preAddRSGroup(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String name)
                   throws IOException

Description copied from interface: MasterObserver

Called before a new region server group is added

Specified by:

preAddRSGroup in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

name - group name

Throws:

IOException

preRemoveRSGroup

public void preRemoveRSGroup(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String name)
                      throws IOException

Description copied from interface: MasterObserver

Called before a region server group is removed

Specified by:

preRemoveRSGroup in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

name - group name

Throws:

IOException

preBalanceRSGroup

public void preBalanceRSGroup(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String groupName,
 BalanceRequest request)
                       throws IOException

Description copied from interface: MasterObserver

Called before a region server group is removed

Specified by:

preBalanceRSGroup in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

groupName - group name

Throws:

IOException

preRemoveServers

public void preRemoveServers(ObserverContext<MasterCoprocessorEnvironment> ctx,
 Set<Address> servers)
                      throws IOException

Description copied from interface: MasterObserver

Called before servers are removed from rsgroup

Specified by:

preRemoveServers in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

servers - set of decommissioned servers to remove

Throws:

IOException

preRenameRSGroup

public void preRenameRSGroup(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String oldName,
 String newName)
                      throws IOException

Description copied from interface: MasterObserver

Called before rename rsgroup.

Specified by:

preRenameRSGroup in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

oldName - old rsgroup name

newName - new rsgroup name

Throws:

IOException

preUpdateRSGroupConfig

public void preUpdateRSGroupConfig(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String groupName,
 Map<String,String> configuration)
                            throws IOException

Description copied from interface: MasterObserver

Called before update rsgroup config.

Specified by:

preUpdateRSGroupConfig in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

groupName - the group name

configuration - new configuration of the group name to be set

Throws:

IOException

preAddReplicationPeer

public void preAddReplicationPeer(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String peerId,
 ReplicationPeerConfig peerConfig)
                           throws IOException

Description copied from interface: MasterObserver

Called before add a replication peer

Specified by:

preAddReplicationPeer in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

peerId - a short name that identifies the peer

peerConfig - configuration for the replication peer

Throws:

IOException

preRemoveReplicationPeer

public void preRemoveReplicationPeer(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String peerId)
                              throws IOException

Description copied from interface: MasterObserver

Called before remove a replication peer

Specified by:

preRemoveReplicationPeer in interface MasterObserver

peerId - a short name that identifies the peer

Throws:

IOException

preEnableReplicationPeer

public void preEnableReplicationPeer(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String peerId)
                              throws IOException

Description copied from interface: MasterObserver

Called before enable a replication peer

Specified by:

preEnableReplicationPeer in interface MasterObserver

peerId - a short name that identifies the peer

Throws:

IOException

preDisableReplicationPeer

public void preDisableReplicationPeer(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String peerId)
                               throws IOException

Description copied from interface: MasterObserver

Called before disable a replication peer

Specified by:

preDisableReplicationPeer in interface MasterObserver

peerId - a short name that identifies the peer

Throws:

IOException

preUpdateReplicationPeerConfig

public void preUpdateReplicationPeerConfig(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String peerId,
 ReplicationPeerConfig peerConfig)
                                    throws IOException

Description copied from interface: MasterObserver

Called before update peerConfig for the specified peer

Specified by:

preUpdateReplicationPeerConfig in interface MasterObserver

peerId - a short name that identifies the peer

Throws:

IOException

preTransitReplicationPeerSyncReplicationState

public void preTransitReplicationPeerSyncReplicationState(ObserverContext<MasterCoprocessorEnvironment> ctx,
 String peerId,
 SyncReplicationState state)
                                                   throws IOException

Description copied from interface: MasterObserver

Called before transit current cluster state for the specified synchronous replication peer

Specified by:

preTransitReplicationPeerSyncReplicationState in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

peerId - a short name that identifies the peer

state - the new state

Throws:

IOException

preGrant

public void preGrant(ObserverContext<MasterCoprocessorEnvironment> ctx,
 UserPermission userPermission,
 boolean mergeExistingPermissions)
              throws IOException

Description copied from interface: MasterObserver

Called before granting user permissions.

Specified by:

preGrant in interface MasterObserver

Parameters:

ctx - the coprocessor instance's environment

userPermission - the user and permissions

mergeExistingPermissions - True if merge with previous granted permissions

Throws:

IOException

preRevoke

public void preRevoke(ObserverContext<MasterCoprocessorEnvironment> ctx,
 UserPermission userPermission)
               throws IOException

Description copied from interface: MasterObserver

Called before revoking user permissions.

Specified by:

preRevoke in interface MasterObserver

Parameters:

ctx - the coprocessor instance's environment

userPermission - the user and permissions

Throws:

IOException