Package google.registry.proxy.quota

Class QuotaManager

java.lang.Object

google.registry.proxy.quota.QuotaManager

@ThreadSafe
public class QuotaManager
extends Object

A thread-safe quota manager that schedules background refresh if necessary.

This class abstracts away details about the TokenStore. It:

• Translates a QuotaManager.QuotaRequest to taking one token from the store, blocks the caller, and responds with a QuotaManager.QuotaResponse.
• Translates a QuotaManager.QuotaRebate to putting the token to the store asynchronously, and immediately returns.
• Periodically refreshes the token records asynchronously to purge stale recodes.

There should be one QuotaManager per protocol.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	QuotaManager.QuotaRebate	Value class representing a quota rebate.
static final record	QuotaManager.QuotaRequest	Value class representing a quota request.
static final record	QuotaManager.QuotaResponse	Value class representing a quota response.

Constructor Summary

Constructors

Constructor	Description
QuotaManager(TokenStore tokenStore, ExecutorService backgroundExecutor)

Method Summary

Modifier and Type	Method	Description
QuotaManager.QuotaResponse	acquireQuota(QuotaManager.QuotaRequest request)	Attempts to acquire requested quota, synchronously.
Future<?>	releaseQuota(QuotaManager.QuotaRebate rebate)	Returns granted quota to the token store, asynchronously.

Methods inherited from class java.lang.Object

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

Constructor Details

QuotaManager

public QuotaManager(TokenStore tokenStore,
 ExecutorService backgroundExecutor)

Method Details

acquireQuota

public QuotaManager.QuotaResponse acquireQuota(QuotaManager.QuotaRequest request)

Attempts to acquire requested quota, synchronously.

releaseQuota

public Future<?> releaseQuota(QuotaManager.QuotaRebate rebate)

Returns granted quota to the token store, asynchronously.