org.apache.hadoop.hbase.quotas

Class QuotaSettings

java.lang.Object

org.apache.hadoop.hbase.quotas.QuotaSettings

Direct Known Subclasses:

GlobalQuotaSettings, QuotaSettingsFactory.QuotaGlobalsSettingsBypass, SpaceLimitSettings, ThrottleSettings

@InterfaceAudience.Public
public abstract class QuotaSettings
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
private String	namespace
private String	regionServer
private TableName	tableName
private String	userName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QuotaSettings(String userName, TableName tableName, String namespace, String regionServer)

Method Summary

Modifier and Type	Method and Description
static QuotaSettings	buildFromProto(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.SetQuotaRequest request) Converts the protocol buffer request into a QuotaSetting POJO.
static org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.SetQuotaRequest	buildSetQuotaRequestProto(QuotaSettings settings) Convert a QuotaSettings to a protocol buffer SetQuotaRequest.
String	getNamespace()
abstract QuotaType	getQuotaType()
String	getRegionServer()
TableName	getTableName()
String	getUserName()
(package private) abstract QuotaSettings	merge(QuotaSettings newSettings) Merges the provided settings with this and returns a new settings object to the caller if the merged settings differ from the original.
protected String	ownerToString()
protected abstract void	setupSetQuotaRequest(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.SetQuotaRequest.Builder builder) Called by toSetQuotaRequestProto() the subclass should implement this method to set the specific SetQuotaRequest properties.
protected static String	sizeToString(long size)
protected static String	timeToString(TimeUnit timeUnit)
(package private) void	validateQuotaTarget(QuotaSettings mergee) Validates that settings being merged into this is targeting the same "subject", e.g.

Methods inherited from class java.lang.Object

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

Field Detail

userName

private final String userName

namespace

private final String namespace

tableName

private final TableName tableName

regionServer

private final String regionServer

Constructor Detail

QuotaSettings

protected QuotaSettings(String userName,
                        TableName tableName,
                        String namespace,
                        String regionServer)

Method Detail

getQuotaType

public abstract QuotaType getQuotaType()

getUserName

public String getUserName()

getTableName

public TableName getTableName()

getNamespace

public String getNamespace()

getRegionServer

public String getRegionServer()

buildFromProto

@InterfaceAudience.Private
public static QuotaSettings buildFromProto(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.SetQuotaRequest request)

Converts the protocol buffer request into a QuotaSetting POJO. Arbitrarily enforces that the request only contain one "limit", despite the message allowing multiple. The public API does not allow such use of the message.

Parameters:

request - The protocol buffer request.

Returns:

A QuotaSettings POJO.

buildSetQuotaRequestProto

@InterfaceAudience.Private
public static org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.SetQuotaRequest buildSetQuotaRequestProto(QuotaSettings settings)

Convert a QuotaSettings to a protocol buffer SetQuotaRequest. This is used internally by the Admin client to serialize the quota settings and send them to the master.

setupSetQuotaRequest

@InterfaceAudience.Private
protected abstract void setupSetQuotaRequest(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.SetQuotaRequest.Builder builder)

Called by toSetQuotaRequestProto() the subclass should implement this method to set the specific SetQuotaRequest properties.

ownerToString

protected String ownerToString()

sizeToString

protected static String sizeToString(long size)

timeToString

protected static String timeToString(TimeUnit timeUnit)

merge

abstract QuotaSettings merge(QuotaSettings newSettings)
                      throws IOException

Merges the provided settings with this and returns a new settings object to the caller if the merged settings differ from the original.

Parameters:

newSettings - The new settings to merge in.

Returns:

The merged QuotaSettings object or null if the quota should be deleted.

Throws:

IOException

validateQuotaTarget

void validateQuotaTarget(QuotaSettings mergee)

Validates that settings being merged into this is targeting the same "subject", e.g. user, table, namespace.

Parameters:

mergee - The quota settings to be merged into this.

Throws:

IllegalArgumentException - if the subjects are not equal.