QuotaCache (Apache HBase 1.4.11 API)

java.lang.Object
- org.apache.hadoop.hbase.quotas.QuotaCache

All Implemented Interfaces:

Stoppable
```
@InterfaceAudience.Private
@InterfaceStability.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.

Field Summary

Fields
Modifier and Type Field and Description

static String REFRESH_CONF_KEY

Fields
Modifier and Type	Field and Description
`static String`	`REFRESH_CONF_KEY`

Constructor Summary

Constructors
Constructor and Description

QuotaCache(RegionServerServices rsServices)

Constructors
Constructor and Description
`QuotaCache(RegionServerServices rsServices)`

Method Summary

Methods
Modifier and Type	Method and Description
`QuotaLimiter`	`getNamespaceLimiter(String namespace)` Returns the limiter associated to the specified namespace.
`QuotaLimiter`	`getTableLimiter(TableName table)` Returns the limiter associated to the specified table.
`QuotaLimiter`	`getUserLimiter(org.apache.hadoop.security.UserGroupInformation ugi, TableName table)` Returns the limiter associated to the specified user/table.
`UserQuotaState`	`getUserQuotaState(org.apache.hadoop.security.UserGroupInformation ugi)` Returns the QuotaState associated to the specified user.
`boolean`	`isStopped()`
`static boolean`	`isTEST_FORCE_REFRESH()`
`static void`	`setTEST_FORCE_REFRESH(boolean tEST_FORCE_REFRESH)`
`void`	`start()`
`void`	`stop(String why)` Stop this service.

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

- Field Detail
  - REFRESH_CONF_KEY
```
public static final String REFRESH_CONF_KEY
```
    See Also:
    Constant Field Values
- Constructor Detail
  - QuotaCache
```
public QuotaCache(RegionServerServices rsServices)
```
- Method Detail
  - 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()
```
    Specified by:
    
    isStopped in interface Stoppable
    
    Returns:
    True if Stoppable.stop(String) has been closed.
  - 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
  - isTEST_FORCE_REFRESH
```
public static boolean isTEST_FORCE_REFRESH()
```
  - setTEST_FORCE_REFRESH
```
public static void setTEST_FORCE_REFRESH(boolean tEST_FORCE_REFRESH)
```

Class QuotaCache

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REFRESH_CONF_KEY

Constructor Detail

QuotaCache

Method Detail

start

stop

isStopped

getUserLimiter

getUserQuotaState

getTableLimiter

getNamespaceLimiter

isTEST_FORCE_REFRESH

setTEST_FORCE_REFRESH