com.mulesoft.modules.oauth2.provider.api.ratelimit

Interface RateLimiter

All Known Implementing Classes:

PeriodRateLimiter

@Extensible
public interface RateLimiter

A rate limiter will reject operations given a condition met.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RateLimiter.Operation
static class	RateLimiter.Outcome

Method Summary

Modifier and Type	Method and Description
void	checkOperationAuthorized(RateLimiter.Operation operation, String context)
void	recordOperationOutcome(RateLimiter.Operation operation, String context, RateLimiter.Outcome outcome)

Method Detail

checkOperationAuthorized

void checkOperationAuthorized(RateLimiter.Operation operation,
                              String context)
                       throws RateLimitExceededException

Parameters:

operation -

context -

Throws:

RateLimitExceededException - if the operation is rate-limited for the particular context. The context must be unique within the operation (for example, a unique ID or username).

recordOperationOutcome

void recordOperationOutcome(RateLimiter.Operation operation,
                            String context,
                            RateLimiter.Outcome outcome)