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

Class PeriodRateLimiter

java.lang.Object

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

All Implemented Interfaces:

RateLimiter

public class PeriodRateLimiter
extends Object
implements RateLimiter

Rate limiter that resets according to a defined time period.

If the fauilure count is reached, the rate limiter will start rejecting operations until the period id completed, and reset after.

Since:

1.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.mulesoft.modules.oauth2.provider.api.ratelimit.RateLimiter

RateLimiter.Operation, RateLimiter.Outcome

Constructor Summary

Constructors

Constructor and Description
PeriodRateLimiter()

Method Summary

Modifier and Type	Method and Description
void	checkOperationAuthorized(RateLimiter.Operation operation, String context)
int	getMaximumFailureCount()
void	recordOperationOutcome(RateLimiter.Operation operation, String context, RateLimiter.Outcome outcome)
void	setDuration(int duration, TimeUnit timeUnit)
void	setMaximumFailureCount(int maximumFailureCount)

Methods inherited from class java.lang.Object

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

Constructor Detail

PeriodRateLimiter

public PeriodRateLimiter()

Method Detail

checkOperationAuthorized

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

Specified by:

checkOperationAuthorized in interface RateLimiter

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

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

Specified by:

recordOperationOutcome in interface RateLimiter

getMaximumFailureCount

public int getMaximumFailureCount()

setMaximumFailureCount

public void setMaximumFailureCount(int maximumFailureCount)

setDuration

public void setDuration(int duration,
                        TimeUnit timeUnit)