org.apache.hadoop.hbase.quotas

Interface SpaceViolationPolicyEnforcement

All Known Implementing Classes:

AbstractViolationPolicyEnforcement, DefaultViolationPolicyEnforcement, DisableTableViolationPolicyEnforcement, MissingSnapshotViolationPolicyEnforcement, NoInsertsViolationPolicyEnforcement, NoWritesCompactionsViolationPolicyEnforcement, NoWritesViolationPolicyEnforcement

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public interface SpaceViolationPolicyEnforcement

RegionServer implementation of SpaceViolationPolicy. Implementations must have a public, no-args constructor.

Method Summary

Modifier and Type	Method and Description
boolean	areCompactionsDisabled() Returns whether or not compactions on this table should be disabled for this policy.
void	check(Mutation m) Checks the given Mutation against this policy.
long	computeBulkLoadSize(org.apache.hadoop.fs.FileSystem fs, List<String> paths) Computes the size of the file(s) at the given path against this policy and the current SpaceQuotaSnapshot.
void	disable() Disables this policy.
void	enable() Enables this policy.
String	getPolicyName() Returns a logical name for the SpaceViolationPolicy that this enforcement is for.
SpaceQuotaSnapshot	getQuotaSnapshot() Returns the SpaceQuotaSnapshot this was initialized with.
void	initialize(RegionServerServices rss, TableName tableName, SpaceQuotaSnapshot snapshot) Initializes this policy instance.
boolean	shouldCheckBulkLoads() Returns whether thet caller should verify any bulk loads against this.

Method Detail

initialize

void initialize(RegionServerServices rss,
                TableName tableName,
                SpaceQuotaSnapshot snapshot)

Initializes this policy instance.

enable

void enable()
     throws IOException

Enables this policy. Not all policies have enable actions.

Throws:

IOException

disable

void disable()
      throws IOException

Disables this policy. Not all policies have disable actions.

Throws:

IOException

check

void check(Mutation m)
    throws SpaceLimitingException

Checks the given Mutation against this policy. If the Mutation violates the policy, this policy should throw a SpaceLimitingException.

Throws:

SpaceLimitingException - When the given mutation violates this policy.

getPolicyName

String getPolicyName()

Returns a logical name for the SpaceViolationPolicy that this enforcement is for.

areCompactionsDisabled

boolean areCompactionsDisabled()

Returns whether or not compactions on this table should be disabled for this policy.

getQuotaSnapshot

SpaceQuotaSnapshot getQuotaSnapshot()

Returns the SpaceQuotaSnapshot this was initialized with.

shouldCheckBulkLoads

boolean shouldCheckBulkLoads()

Returns whether thet caller should verify any bulk loads against this.

computeBulkLoadSize

long computeBulkLoadSize(org.apache.hadoop.fs.FileSystem fs,
                         List<String> paths)
                  throws SpaceLimitingException

Computes the size of the file(s) at the given path against this policy and the current SpaceQuotaSnapshot. If the file would violate the policy, a SpaceLimitingException will be thrown.

Parameters:

paths - The paths in HDFS to files to be bulk loaded.

Returns:

The size, in bytes, of the files that would be loaded.

Throws:

SpaceLimitingException