org.apache.hadoop.hbase.quotas

Interface QuotaSnapshotStore<T>

All Known Implementing Classes:

NamespaceQuotaSnapshotStore, TableQuotaSnapshotStore

@InterfaceAudience.Private
public interface QuotaSnapshotStore<T>

A common interface for computing and storing space quota observance/violation for entities. An entity is presently a table or a namespace.

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
Iterable<Map.Entry<RegionInfo,Long>>	filterBySubject(T subject) Filters the provided regions, returning those which match the given subject.
SpaceQuotaSnapshot	getCurrentState(T subject) Returns the current SpaceQuotaSnapshot for the given subject.
QuotaProtos.SpaceQuota	getSpaceQuota(T subject) Fetch the Quota for the given subject.
SpaceQuotaSnapshot	getTargetState(T subject, QuotaProtos.SpaceQuota spaceQuota) Computes the target SpaceQuotaSnapshot for the given subject and spaceQuota.
void	setCurrentState(T subject, SpaceQuotaSnapshot state) Persists the current SpaceQuotaSnapshot for the subject.
void	setRegionUsage(Map<RegionInfo,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 IOException

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

Parameters:

subject - The object for which the quota should be fetched

Throws:

IOException

getCurrentState

SpaceQuotaSnapshot getCurrentState(T subject)

Returns the current SpaceQuotaSnapshot for the given subject.

Parameters:

subject - The object which the quota snapshot should be fetched

getTargetState

SpaceQuotaSnapshot getTargetState(T subject,
                                  QuotaProtos.SpaceQuota spaceQuota)
                           throws IOException

Computes the target SpaceQuotaSnapshot for the given subject and spaceQuota.

Parameters:

subject - The object which to determine the target SpaceQuotaSnapshot of

spaceQuota - The quota "definition" for the subject

Throws:

IOException

filterBySubject

Iterable<Map.Entry<RegionInfo,Long>> filterBySubject(T subject)

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

Parameters:

subject - The filter criteria. Only regions belonging to this parameter will be returned

setCurrentState

void setCurrentState(T subject,
                     SpaceQuotaSnapshot state)

Persists the current SpaceQuotaSnapshot for the subject.

Parameters:

subject - The object which the SpaceQuotaSnapshot is being persisted for

state - The current state of the subject

setRegionUsage

void setRegionUsage(Map<RegionInfo,Long> regionUsage)

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

Parameters:

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