Record Class RateLimitProfile

java.lang.Object

java.lang.Record

org.j7m.middleware.application.api.RateLimitProfile

Record Components:

permits - admitted requests per window, 1..1000000; later bulkhead rejection does not refund them

window - positive monotonic interval, 1ms..1day

scope - required coordination scope; never silently downgraded

public record RateLimitProfile(long permits, Duration window, RateLimitProfile.Scope scope)
extends Record

Finite fixed-window admission policy. A LOCAL implementation must reject a DISTRIBUTED profile.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RateLimitProfile.Scope	Coordination requirement selected by the trusted host.

Constructor Summary

Constructors

Constructor	Description
RateLimitProfile(long permits, Duration window, RateLimitProfile.Scope scope)	Validates finite limits without allocating state or choosing a fallback scope.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
long	permits()	Returns the value of the permits record component.
RateLimitProfile.Scope	scope()	Returns the value of the scope record component.
final String	toString()	Returns a string representation of this record class.
Duration	window()	Returns the value of the window record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RateLimitProfile

public RateLimitProfile(long permits,
 Duration window,
 RateLimitProfile.Scope scope)

Validates finite limits without allocating state or choosing a fallback scope.

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

permits

public long permits()

Returns the value of the permits record component.

Returns:

the value of the permits record component

window

public Duration window()

Returns the value of the window record component.

Returns:

the value of the window record component

scope

public RateLimitProfile.Scope scope()

Returns the value of the scope record component.

Returns:

the value of the scope record component