org.apache.hadoop.hbase.quotas

Interface QuotaSnapshotStore<T>

All Known Implementing Classes:

NamespaceQuotaSnapshotStore, TableQuotaSnapshotStore

public interface QuotaSnapshotStore<T>

A common interface for computing quota observance/violation for tables or namespaces.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	QuotaSnapshotStore.ViolationState The current state of a table with respect to the policy set forth by a quota.

Field Summary

Fields

Modifier and Type	Field and Description
static SpaceQuotaSnapshot	NO_QUOTA Singleton to represent a table without a quota defined.

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<java.util.Map.Entry<HRegionInfo,java.lang.Long>>	filterBySubject(T subject) Filters the provided regions, returning those which match the given subject.
SpaceQuotaSnapshot	getCurrentState(T subject) Returns the current QuotaSnapshotStore.ViolationState for the given subject.
QuotaProtos.SpaceQuota	getSpaceQuota(T subject) Fetch the Quota for the given table.
SpaceQuotaSnapshot	getTargetState(T subject, QuotaProtos.SpaceQuota spaceQuota) Computes the target QuotaSnapshotStore.ViolationState for the given subject.
void	setCurrentState(T subject, SpaceQuotaSnapshot state) Sets the current QuotaSnapshotStore.ViolationState for the subject.
void	setRegionUsage(java.util.Map<HRegionInfo,java.lang.Long> regionUsage) Updates this with the latest snapshot of filesystem use by region.

Field Detail

NO_QUOTA

static final SpaceQuotaSnapshot NO_QUOTA

Singleton to represent a table without a quota defined. It is never in violation.

Method Detail

getSpaceQuota

QuotaProtos.SpaceQuota getSpaceQuota(T subject)
                              throws java.io.IOException

Fetch the Quota for the given table. May be null.

Throws:

java.io.IOException

getCurrentState

SpaceQuotaSnapshot getCurrentState(T subject)

Returns the current QuotaSnapshotStore.ViolationState for the given subject.

getTargetState

SpaceQuotaSnapshot getTargetState(T subject,
                                  QuotaProtos.SpaceQuota spaceQuota)

Computes the target QuotaSnapshotStore.ViolationState for the given subject.

filterBySubject

java.lang.Iterable<java.util.Map.Entry<HRegionInfo,java.lang.Long>> filterBySubject(T subject)

Filters the provided regions, returning those which match the given subject.

Parameters:

subject - The filter criteria.

setCurrentState

void setCurrentState(T subject,
                     SpaceQuotaSnapshot state)

Sets the current QuotaSnapshotStore.ViolationState for the subject.

setRegionUsage

void setRegionUsage(java.util.Map<HRegionInfo,java.lang.Long> regionUsage)

Updates this with the latest snapshot of filesystem use by region.

Parameters:

regionUsage - A map of HRegionInfo objects to their filesystem usage in bytes