RegionServerQuotaManager (Apache HBase 1.2.12 API)

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

```
@InterfaceAudience.Private
@InterfaceStability.Evolving
public class RegionServerQuotaManager
extends Object
```
Region Server Quota Manager. It is responsible to provide access to the quota information of each user/table. The direct user of this class is the RegionServer that will get and check the user/table quota for each operation (put, get, scan). For system tables and user/table with a quota specified, the quota check will be a noop.

Field Summary

Fields
Modifier and Type Field and Description

private static org.apache.commons.logging.Log LOG

private QuotaCache quotaCache

private RegionServerServices rsServices

Fields
Modifier and Type	Field and Description
`private static org.apache.commons.logging.Log`	`LOG`
`private QuotaCache`	`quotaCache`
`private RegionServerServices`	`rsServices`

Constructor Summary

Constructors
Constructor and Description

RegionServerQuotaManager(RegionServerServices rsServices)

Constructors
Constructor and Description
`RegionServerQuotaManager(RegionServerServices rsServices)`

Method Summary

Methods
Modifier and Type	Method and Description
`private OperationQuota`	`checkQuota(Region region, int numWrites, int numReads, int numScans)` Check the quota for the current (rpc-context) user.
`OperationQuota`	`checkQuota(Region region, List<org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Action> actions)` Check the quota for the current (rpc-context) user.
`OperationQuota`	`checkQuota(Region region, OperationQuota.OperationType type)` Check the quota for the current (rpc-context) user.
`OperationQuota`	`getQuota(org.apache.hadoop.security.UserGroupInformation ugi, TableName table)` Returns the quota for an operation.
`(package private) QuotaCache`	`getQuotaCache()`
`boolean`	`isQuotaEnabled()`
`void`	`start(RpcScheduler rpcScheduler)`
`void`	`stop()`

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

- Field Detail
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
  - rsServices
```
private final RegionServerServices rsServices
```
  - quotaCache
```
private QuotaCache quotaCache
```
- Constructor Detail
  - RegionServerQuotaManager
```
public RegionServerQuotaManager(RegionServerServices rsServices)
```
- Method Detail
  - start
```
public void start(RpcScheduler rpcScheduler)
           throws IOException
```
    Throws:
    
    IOException
  - stop
```
public void stop()
```
  - isQuotaEnabled
```
public boolean isQuotaEnabled()
```
  - getQuotaCache
```
QuotaCache getQuotaCache()
```
  - getQuota
```
public OperationQuota getQuota(org.apache.hadoop.security.UserGroupInformation ugi,
                      TableName table)
```
    Returns the quota for an operation.
    
    Parameters:
    ugi - the user that is executing the operation
    table - the table where the operation will be executed
    
    Returns:
    the OperationQuota
  - checkQuota
```
public OperationQuota checkQuota(Region region,
                        OperationQuota.OperationType type)
                          throws IOException,
                                 ThrottlingException
```
    Check the quota for the current (rpc-context) user. Returns the OperationQuota used to get the available quota and to report the data/usage of the operation.
    
    Parameters:
    region - the region where the operation will be performed
    type - the operation type
    
    Returns:
    the OperationQuota
    
    Throws:
    
    ThrottlingException - if the operation cannot be executed due to quota exceeded.
    
    IOException
  - checkQuota
```
public OperationQuota checkQuota(Region region,
                        List<org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Action> actions)
                          throws IOException,
                                 ThrottlingException
```
    Check the quota for the current (rpc-context) user. Returns the OperationQuota used to get the available quota and to report the data/usage of the operation.
    
    Parameters:
    region - the region where the operation will be performed
    actions - the "multi" actions to perform
    
    Returns:
    the OperationQuota
    
    Throws:
    
    ThrottlingException - if the operation cannot be executed due to quota exceeded.
    
    IOException
  - checkQuota
```
private OperationQuota checkQuota(Region region,
                        int numWrites,
                        int numReads,
                        int numScans)
                           throws IOException,
                                  ThrottlingException
```
    Check the quota for the current (rpc-context) user. Returns the OperationQuota used to get the available quota and to report the data/usage of the operation.
    
    Parameters:
    region - the region where the operation will be performed
    numWrites - number of writes to perform
    numReads - number of short-reads to perform
    numScans - number of scan to perform
    
    Returns:
    the OperationQuota
    
    Throws:
    
    ThrottlingException - if the operation cannot be executed due to quota exceeded.
    
    IOException

Class RegionServerQuotaManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

rsServices

quotaCache

Constructor Detail

RegionServerQuotaManager

Method Detail

start

stop

isQuotaEnabled

getQuotaCache

getQuota

checkQuota

checkQuota

checkQuota