MasterQuotaManager (Apache HBase 1.2.12 API)

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

All Implemented Interfaces:

RegionStateListener
```
@InterfaceAudience.Private
@InterfaceStability.Evolving
public class MasterQuotaManager
extends Object
implements RegionStateListener
```
Master Quota Manager. It is responsible for initialize the quota table on the first-run and provide the admin operations to interact with the quota table. TODO: FUTURE: The master will be responsible to notify each RS of quota changes and it will do the "quota aggregation" when the QuotaScope is CLUSTER.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class MasterQuotaManager.NamedLock<T>

private static interface MasterQuotaManager.SetQuotaOperations

Nested Classes
Modifier and Type	Class and Description
`private static class`	`MasterQuotaManager.NamedLock<T>`
`private static interface`	`MasterQuotaManager.SetQuotaOperations`

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`initialized`
`private static org.apache.commons.logging.Log`	`LOG`
`private MasterServices`	`masterServices`
`private MasterQuotaManager.NamedLock<String>`	`namespaceLocks`
`private NamespaceAuditor`	`namespaceQuotaManager`
`private MasterQuotaManager.NamedLock<TableName>`	`tableLocks`
`private MasterQuotaManager.NamedLock<String>`	`userLocks`

Constructor Summary

Constructors
Constructor and Description

MasterQuotaManager(MasterServices masterServices)

Constructors
Constructor and Description
`MasterQuotaManager(MasterServices masterServices)`

Method Summary

Methods
Modifier and Type	Method and Description
`private void`	`applyBypassGlobals(org.apache.hadoop.hbase.protobuf.generated.QuotaProtos.Quotas.Builder quotas, boolean bypassGlobals)`
`private void`	`applyThrottle(org.apache.hadoop.hbase.protobuf.generated.QuotaProtos.Quotas.Builder quotas, org.apache.hadoop.hbase.protobuf.generated.QuotaProtos.ThrottleRequest req)`
`void`	`checkAndUpdateNamespaceRegionQuota(TableName tName, int regions)`
`void`	`checkNamespaceTableAndRegionQuota(TableName tName, int regions)`
`private void`	`checkQuotaSupport()`
`private void`	`createQuotaTable()`
`NamespaceAuditor`	`getNamespaceQuotaManager()`
`int`	`getRegionCountOfTable(TableName tName)`
`boolean`	`isQuotaInitialized()`
`void`	`onRegionMerged(HRegionInfo hri)` Process region merge event.
`void`	`onRegionSplit(HRegionInfo hri)` Process region split event.
`void`	`onRegionSplitReverted(HRegionInfo hri)` Process region split reverted event.
`void`	`removeNamespaceQuota(String namespace)`
`void`	`removeTableFromNamespaceQuota(TableName tName)` Remove table from namespace quota.
`void`	`setNamespaceQuota(NamespaceDescriptor desc)`
`void`	`setNamespaceQuota(String namespace, org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetQuotaRequest req)`
`org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetQuotaResponse`	`setQuota(org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetQuotaRequest req)`
`private void`	`setQuota(org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetQuotaRequest req, MasterQuotaManager.SetQuotaOperations quotaOps)`
`void`	`setTableQuota(TableName table, org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetQuotaRequest req)`
`void`	`setUserQuota(String userName, org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetQuotaRequest req)`
`void`	`setUserQuota(String userName, String namespace, org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetQuotaRequest req)`
`void`	`setUserQuota(String userName, TableName table, org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetQuotaRequest req)`
`void`	`start()`
`void`	`stop()`
`private void`	`validateTimedQuota(org.apache.hadoop.hbase.protobuf.generated.QuotaProtos.TimedQuota timedQuota)`

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

masterServices

private final MasterServices masterServices

namespaceLocks

private MasterQuotaManager.NamedLock<String> namespaceLocks

tableLocks

private MasterQuotaManager.NamedLock<TableName> tableLocks

userLocks

private MasterQuotaManager.NamedLock<String> userLocks

initialized
```
private boolean initialized
```

namespaceQuotaManager

private NamespaceAuditor namespaceQuotaManager

Constructor Detail

MasterQuotaManager

public MasterQuotaManager(MasterServices masterServices)

Method Detail

start

public void start()
           throws IOException

Throws:: IOException

stop
```
public void stop()
```

isQuotaInitialized
```
public boolean isQuotaInitialized()
```

setQuota

public org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetQuotaResponse setQuota(org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetQuotaRequest req)
                                                                                  throws IOException,
                                                                                         InterruptedException

Throws:: IOException; InterruptedException

setUserQuota

public void setUserQuota(String userName,
                org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetQuotaRequest req)
                  throws IOException,
                         InterruptedException

Throws:: IOException; InterruptedException

setUserQuota

public void setUserQuota(String userName,
                TableName table,
                org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetQuotaRequest req)
                  throws IOException,
                         InterruptedException

Throws:: IOException; InterruptedException

setUserQuota

public void setUserQuota(String userName,
                String namespace,
                org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetQuotaRequest req)
                  throws IOException,
                         InterruptedException

Throws:: IOException; InterruptedException

setTableQuota

public void setTableQuota(TableName table,
                 org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetQuotaRequest req)
                   throws IOException,
                          InterruptedException

Throws:: IOException; InterruptedException

setNamespaceQuota

public void setNamespaceQuota(String namespace,
                     org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetQuotaRequest req)
                       throws IOException,
                              InterruptedException

Throws:: IOException; InterruptedException

setNamespaceQuota

public void setNamespaceQuota(NamespaceDescriptor desc)
                       throws IOException

Throws:: IOException

removeNamespaceQuota

public void removeNamespaceQuota(String namespace)
                          throws IOException

Throws:: IOException

setQuota

private void setQuota(org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SetQuotaRequest req,
            MasterQuotaManager.SetQuotaOperations quotaOps)
               throws IOException,
                      InterruptedException

Throws:: IOException; InterruptedException

checkNamespaceTableAndRegionQuota

public void checkNamespaceTableAndRegionQuota(TableName tName,
                                     int regions)
                                       throws IOException

Throws:: IOException

checkAndUpdateNamespaceRegionQuota

public void checkAndUpdateNamespaceRegionQuota(TableName tName,
                                      int regions)
                                        throws IOException

Throws:: IOException

getRegionCountOfTable
```
public int getRegionCountOfTable(TableName tName)
                          throws IOException
```
Returns:
cached region count, or -1 if quota manager is disabled or table status not found

Throws:

IOException

onRegionMerged
```
public void onRegionMerged(HRegionInfo hri)
                    throws IOException
```
Description copied from interface: RegionStateListener

Process region merge event.

Specified by:

onRegionMerged in interface RegionStateListener

Parameters:
hri - An instance of HRegionInfo

Throws:

IOException

onRegionSplit
```
public void onRegionSplit(HRegionInfo hri)
                   throws IOException
```
Description copied from interface: RegionStateListener

Process region split event.

Specified by:

onRegionSplit in interface RegionStateListener

Parameters:
hri - An instance of HRegionInfo

Throws:

IOException

removeTableFromNamespaceQuota
```
public void removeTableFromNamespaceQuota(TableName tName)
                                   throws IOException
```
Remove table from namespace quota.

Parameters:
tName - - The table name to update quota usage.

Throws:

IOException - Signals that an I/O exception has occurred.

getNamespaceQuotaManager

public NamespaceAuditor getNamespaceQuotaManager()

applyThrottle

private void applyThrottle(org.apache.hadoop.hbase.protobuf.generated.QuotaProtos.Quotas.Builder quotas,
                 org.apache.hadoop.hbase.protobuf.generated.QuotaProtos.ThrottleRequest req)
                    throws IOException

Throws:: IOException

applyBypassGlobals

private void applyBypassGlobals(org.apache.hadoop.hbase.protobuf.generated.QuotaProtos.Quotas.Builder quotas,
                      boolean bypassGlobals)

validateTimedQuota

private void validateTimedQuota(org.apache.hadoop.hbase.protobuf.generated.QuotaProtos.TimedQuota timedQuota)
                         throws IOException

Throws:: IOException

checkQuotaSupport

private void checkQuotaSupport()
                        throws IOException

Throws:: IOException

createQuotaTable

private void createQuotaTable()
                       throws IOException

Throws:: IOException

onRegionSplitReverted
```
public void onRegionSplitReverted(HRegionInfo hri)
                           throws IOException
```
Description copied from interface: RegionStateListener

Process region split reverted event.

Specified by:

onRegionSplitReverted in interface RegionStateListener

Parameters:
hri - An instance of HRegionInfo

Throws:

IOException - Signals that an I/O exception has occurred.

Class MasterQuotaManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

masterServices

namespaceLocks

tableLocks

userLocks

initialized

namespaceQuotaManager

Constructor Detail

MasterQuotaManager

Method Detail

start

stop

isQuotaInitialized

setQuota

setUserQuota

setUserQuota

setUserQuota

setTableQuota

setNamespaceQuota

setNamespaceQuota

removeNamespaceQuota

setQuota

checkNamespaceTableAndRegionQuota

checkAndUpdateNamespaceRegionQuota

getRegionCountOfTable

onRegionMerged

onRegionSplit

removeTableFromNamespaceQuota

getNamespaceQuotaManager

applyThrottle

applyBypassGlobals

validateTimedQuota

checkQuotaSupport

createQuotaTable

onRegionSplitReverted