Package io.jans.fido2.service.readiness

Class ReadinessRateLimiter

java.lang.Object

io.jans.fido2.service.readiness.ReadinessRateLimiter

@ApplicationScoped
public class ReadinessRateLimiter
extends Object

Bounds how much outbound work the readiness endpoint can cause, per node. Three limits, all constants:

• a relying party is fetched at most once per MIN_RECHECK_INTERVAL_MS;
• at most MAX_FETCHES_PER_WINDOW files are fetched per WINDOW_MS, whichever relying parties they belong to;
• at most MAX_CONCURRENT checks run at the same time.

In a cluster each node applies its own limits, so the installation-wide ceiling is the number of nodes times these values. A refused request is never turned into a fetch: the caller answers 429 with Retry-After.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_CONCURRENT
static final int	MAX_FETCHES_PER_WINDOW
static final long	MIN_RECHECK_INTERVAL_MS
static final long	WINDOW_MS

Constructor Summary

Constructors

Constructor	Description
ReadinessRateLimiter()

Method Summary

Modifier and Type	Method	Description
long	nextAllowedAt(String rpId)	Earliest time, in epoch milliseconds, at which rpId may be fetched again.
void	release()
long	tryAcquire(String rpId, int fetches)	Asks to run a check that fetches fetches files for rpId.

Methods inherited from class java.lang.Object

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

Field Details

MIN_RECHECK_INTERVAL_MS

public static final long MIN_RECHECK_INTERVAL_MS

See Also:

• Constant Field Values

WINDOW_MS

public static final long WINDOW_MS

See Also:

• Constant Field Values

MAX_FETCHES_PER_WINDOW

public static final int MAX_FETCHES_PER_WINDOW

See Also:

• Constant Field Values

MAX_CONCURRENT

public static final int MAX_CONCURRENT

See Also:

• Constant Field Values

Constructor Details

ReadinessRateLimiter

public ReadinessRateLimiter()

Method Details

tryAcquire

public long tryAcquire(String rpId,
 int fetches)

Asks to run a check that fetches fetches files for rpId.

Returns:

0 when granted (the caller must then call release()), otherwise the number of milliseconds to wait before asking again

release

public void release()

nextAllowedAt

public long nextAllowedAt(String rpId)

Earliest time, in epoch milliseconds, at which rpId may be fetched again.