org.apache.hadoop.hbase.quotas

Class ActivePolicyEnforcement

java.lang.Object

org.apache.hadoop.hbase.quotas.ActivePolicyEnforcement

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public class ActivePolicyEnforcement
extends Object

A class to ease dealing with tables that have and do not have violation policies being enforced. This class is immutable, expect for locallyCachedPolicies. The locallyCachedPolicies are mutable given the current activePolicies and snapshots. It is expected that when a new instance of this class is instantiated, we also want to invalidate those previously cached policies (as they may now be invalidate if we received new quota usage information).

Field Summary

Fields

Modifier and Type	Field and Description
private Map<TableName,SpaceViolationPolicyEnforcement>	activePolicies
private SpaceViolationPolicyEnforcementFactory	factory
private Map<TableName,SpaceViolationPolicyEnforcement>	locallyCachedPolicies
private RegionServerServices	rss
private Map<TableName,SpaceQuotaSnapshot>	snapshots

Constructor Summary

Constructors

Constructor and Description
ActivePolicyEnforcement(Map<TableName,SpaceViolationPolicyEnforcement> activePolicies, Map<TableName,SpaceQuotaSnapshot> snapshots, RegionServerServices rss)
ActivePolicyEnforcement(Map<TableName,SpaceViolationPolicyEnforcement> activePolicies, Map<TableName,SpaceQuotaSnapshot> snapshots, RegionServerServices rss, SpaceViolationPolicyEnforcementFactory factory)

Method Summary

Modifier and Type	Method and Description
(package private) Map<TableName,SpaceViolationPolicyEnforcement>	getLocallyCachedPolicies() Returns an unmodifiable version of the policy enforcements that were cached because they are not in violation of their quota.
Map<TableName,SpaceViolationPolicyEnforcement>	getPolicies() Returns an unmodifiable version of the active SpaceViolationPolicyEnforcements.
SpaceViolationPolicyEnforcement	getPolicyEnforcement(Region r) Returns the proper SpaceViolationPolicyEnforcement implementation for the given table.
SpaceViolationPolicyEnforcement	getPolicyEnforcement(TableName tableName) Returns the proper SpaceViolationPolicyEnforcement implementation for the given table.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

activePolicies

private final Map<TableName,SpaceViolationPolicyEnforcement> activePolicies

snapshots

private final Map<TableName,SpaceQuotaSnapshot> snapshots

rss

private final RegionServerServices rss

factory

private final SpaceViolationPolicyEnforcementFactory factory

locallyCachedPolicies

private final Map<TableName,SpaceViolationPolicyEnforcement> locallyCachedPolicies

Constructor Detail

ActivePolicyEnforcement

public ActivePolicyEnforcement(Map<TableName,SpaceViolationPolicyEnforcement> activePolicies,
                               Map<TableName,SpaceQuotaSnapshot> snapshots,
                               RegionServerServices rss)

ActivePolicyEnforcement

public ActivePolicyEnforcement(Map<TableName,SpaceViolationPolicyEnforcement> activePolicies,
                               Map<TableName,SpaceQuotaSnapshot> snapshots,
                               RegionServerServices rss,
                               SpaceViolationPolicyEnforcementFactory factory)

Method Detail

getPolicyEnforcement

public SpaceViolationPolicyEnforcement getPolicyEnforcement(Region r)

Returns the proper SpaceViolationPolicyEnforcement implementation for the given table. If the given table does not have a violation policy enforced, a "no-op" policy will be returned which always allows an action.

See Also:

getPolicyEnforcement(TableName)

getPolicyEnforcement

public SpaceViolationPolicyEnforcement getPolicyEnforcement(TableName tableName)

Returns the proper SpaceViolationPolicyEnforcement implementation for the given table. If the given table does not have a violation policy enforced, a "no-op" policy will be returned which always allows an action.

Parameters:

tableName - The table to fetch the policy for.

Returns:

A non-null SpaceViolationPolicyEnforcement instance.

getPolicies

public Map<TableName,SpaceViolationPolicyEnforcement> getPolicies()

Returns an unmodifiable version of the active SpaceViolationPolicyEnforcements.

getLocallyCachedPolicies

Map<TableName,SpaceViolationPolicyEnforcement> getLocallyCachedPolicies()

Returns an unmodifiable version of the policy enforcements that were cached because they are not in violation of their quota.

toString

public String toString()

Overrides:

toString in class Object