Package org.apache.hadoop.hbase.quotas

Class QuotaCache

java.lang.Object

org.apache.hadoop.hbase.quotas.QuotaCache

All Implemented Interfaces:

Stoppable

@Private
@Evolving
public class QuotaCache
extends Object
implements Stoppable

Cache that keeps track of the quota settings for the users and tables that are interacting with it. To avoid blocking the operations if the requested quota is not in cache an "empty quota" will be returned and the request to fetch the quota information will be enqueued for the next refresh. TODO: At the moment the Cache has a Chore that will be triggered every 5min or on cache-miss events. Later the Quotas will be pushed using the notification system.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static interface	QuotaCache.Fetcher<Key,Value>
private class	QuotaCache.QuotaRefresherChore

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	EVICT_PERIOD_FACTOR
private boolean	exceedThrottleQuotaEnabled
private static final org.slf4j.Logger	LOG
private double	machineQuotaFactor
private final ConcurrentMap<String,QuotaState>	namespaceQuotaCache
static final String	QUOTA_USER_REQUEST_ATTRIBUTE_OVERRIDE_KEY
static final String	REFRESH_CONF_KEY
private static final int	REFRESH_DEFAULT_PERIOD
private QuotaCache.QuotaRefresherChore	refreshChore
private final ConcurrentMap<String,QuotaState>	regionServerQuotaCache
private final RegionServerServices	rsServices
private boolean	stopped
private final ConcurrentHashMap<TableName,Double>	tableMachineQuotaFactors
private final ConcurrentMap<TableName,QuotaState>	tableQuotaCache
(package private) static boolean	TEST_BLOCK_REFRESH
(package private) static boolean	TEST_FORCE_REFRESH
private final String	userOverrideRequestAttributeKey
private final ConcurrentMap<String,UserQuotaState>	userQuotaCache

Constructor Summary

Constructors

Constructor	Description
QuotaCache(RegionServerServices rsServices)

Method Summary

Modifier and Type	Method	Description
(package private) long	getLastUpdate()
QuotaLimiter	getNamespaceLimiter(String namespace)	Returns the limiter associated to the specified namespace.
(package private) Map<String,QuotaState>	getNamespaceQuotaCache()
private <K> QuotaState	getQuotaState(ConcurrentMap<K,QuotaState> quotasMap, K key)	Returns the QuotaState requested.
private String	getQuotaUserName(org.apache.hadoop.security.UserGroupInformation ugi)	Applies a request attribute user override if available, otherwise returns the UGI's short username
(package private) Map<String,QuotaState>	getRegionServerQuotaCache()
QuotaLimiter	getRegionServerQuotaLimiter(String regionServer)	Returns the limiter associated to the specified region server.
QuotaLimiter	getTableLimiter(TableName table)	Returns the limiter associated to the specified table.
(package private) Map<TableName,QuotaState>	getTableQuotaCache()
QuotaLimiter	getUserLimiter(org.apache.hadoop.security.UserGroupInformation ugi, TableName table)	Returns the limiter associated to the specified user/table.
(package private) Map<String,UserQuotaState>	getUserQuotaCache()
UserQuotaState	getUserQuotaState(org.apache.hadoop.security.UserGroupInformation ugi)	Returns the QuotaState associated to the specified user.
protected boolean	isExceedThrottleQuotaEnabled()
boolean	isStopped()	Returns True if Stoppable.stop(String) has been closed.
void	start()
void	stop(String why)	Stop this service.
(package private) void	triggerCacheRefresh()

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

REFRESH_CONF_KEY

public static final String REFRESH_CONF_KEY

See Also:

• Constant Field Values

QUOTA_USER_REQUEST_ATTRIBUTE_OVERRIDE_KEY

public static final String QUOTA_USER_REQUEST_ATTRIBUTE_OVERRIDE_KEY

See Also:

• Constant Field Values

REFRESH_DEFAULT_PERIOD

private static final int REFRESH_DEFAULT_PERIOD

See Also:

• Constant Field Values

EVICT_PERIOD_FACTOR

private static final int EVICT_PERIOD_FACTOR

See Also:

• Constant Field Values

TEST_FORCE_REFRESH

static boolean TEST_FORCE_REFRESH

TEST_BLOCK_REFRESH

static boolean TEST_BLOCK_REFRESH

namespaceQuotaCache

private final ConcurrentMap<String,QuotaState> namespaceQuotaCache

tableQuotaCache

private final ConcurrentMap<TableName,QuotaState> tableQuotaCache

userQuotaCache

private final ConcurrentMap<String,UserQuotaState> userQuotaCache

regionServerQuotaCache

private final ConcurrentMap<String,QuotaState> regionServerQuotaCache

exceedThrottleQuotaEnabled

private volatile boolean exceedThrottleQuotaEnabled

machineQuotaFactor

private volatile double machineQuotaFactor

tableMachineQuotaFactors

private final ConcurrentHashMap<TableName,Double> tableMachineQuotaFactors

rsServices

private final RegionServerServices rsServices

userOverrideRequestAttributeKey

private final String userOverrideRequestAttributeKey

refreshChore

private QuotaCache.QuotaRefresherChore refreshChore

stopped

private boolean stopped

Constructor Details

QuotaCache

public QuotaCache(RegionServerServices rsServices)

Method Details

start

public void start()
           throws IOException

Throws:

IOException

stop

public void stop(String why)

Description copied from interface: Stoppable

Stop this service. Implementers should favor logging errors over throwing RuntimeExceptions.

Specified by:

stop in interface Stoppable

Parameters:

why - Why we're stopping.

isStopped

public boolean isStopped()

Description copied from interface: Stoppable

Returns True if Stoppable.stop(String) has been closed.

Specified by:

isStopped in interface Stoppable

getUserLimiter

public QuotaLimiter getUserLimiter(org.apache.hadoop.security.UserGroupInformation ugi,
 TableName table)

Returns the limiter associated to the specified user/table.

Parameters:

ugi - the user to limit

table - the table to limit

Returns:

the limiter associated to the specified user/table

getUserQuotaState

public UserQuotaState getUserQuotaState(org.apache.hadoop.security.UserGroupInformation ugi)

Returns the QuotaState associated to the specified user.

Parameters:

ugi - the user

Returns:

the quota info associated to specified user

getTableLimiter

public QuotaLimiter getTableLimiter(TableName table)

Returns the limiter associated to the specified table.

Parameters:

table - the table to limit

Returns:

the limiter associated to the specified table

getNamespaceLimiter

public QuotaLimiter getNamespaceLimiter(String namespace)

Returns the limiter associated to the specified namespace.

Parameters:

namespace - the namespace to limit

Returns:

the limiter associated to the specified namespace

getRegionServerQuotaLimiter

public QuotaLimiter getRegionServerQuotaLimiter(String regionServer)

Returns the limiter associated to the specified region server.

Parameters:

regionServer - the region server to limit

Returns:

the limiter associated to the specified region server

isExceedThrottleQuotaEnabled

protected boolean isExceedThrottleQuotaEnabled()

getQuotaUserName

private String getQuotaUserName(org.apache.hadoop.security.UserGroupInformation ugi)

Applies a request attribute user override if available, otherwise returns the UGI's short username

Parameters:

ugi - The request's UserGroupInformation

getQuotaState

private <K> QuotaState getQuotaState(ConcurrentMap<K,QuotaState> quotasMap,
 K key)

Returns the QuotaState requested. If the quota info is not in cache an empty one will be returned and the quota request will be enqueued for the next cache refresh.

triggerCacheRefresh

void triggerCacheRefresh()

getLastUpdate

long getLastUpdate()

getNamespaceQuotaCache

Map<String,QuotaState> getNamespaceQuotaCache()

getRegionServerQuotaCache

Map<String,QuotaState> getRegionServerQuotaCache()

getTableQuotaCache

Map<TableName,QuotaState> getTableQuotaCache()

getUserQuotaCache

Map<String,UserQuotaState> getUserQuotaCache()