Package com.netcetera.girders.ratelimit.support

Class RateLimitingAspect

java.lang.Object

com.netcetera.girders.ratelimit.support.RateLimitingAspect

public class RateLimitingAspect
extends Object

Aspect for applying a rate limit.

Constructor Summary

Constructors

Constructor	Description
RateLimitingAspect(RateLimitValuesRetriever rateLimitValuesRetriever, List<RateLimitKeyResolver> rateLimitKeyResolvers, io.micrometer.core.instrument.MeterRegistry meterRegistry, boolean enableMeterRegistry)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	rateLimit(org.aspectj.lang.JoinPoint joinPoint, RateLimit rateLimit)	Apply a rate limit at the given join point.
void	rateLimit(org.aspectj.lang.JoinPoint joinPoint, RateLimits rateLimits)	Apply a series of rate limits at the given join point.

Methods inherited from class java.lang.Object

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

Constructor Details

RateLimitingAspect

public RateLimitingAspect(RateLimitValuesRetriever rateLimitValuesRetriever,
 List<RateLimitKeyResolver> rateLimitKeyResolvers,
 io.micrometer.core.instrument.MeterRegistry meterRegistry,
 boolean enableMeterRegistry)

Constructor.

Parameters:

rateLimitValuesRetriever - Retriever for rate limit values

rateLimitKeyResolvers - Resolver for rate limit keys

meterRegistry - Meter registry (optional)

Method Details

rateLimit

public void rateLimit(org.aspectj.lang.JoinPoint joinPoint,
 RateLimits rateLimits)
               throws RateLimitExceededException,
ExecutionException

Apply a series of rate limits at the given join point.

Parameters:

joinPoint - the join point

rateLimits - the rate limits to apply

Throws:

RateLimitExceededException - in case the rate limit was exceeded

ExecutionException - if something else went wrong

rateLimit

public void rateLimit(org.aspectj.lang.JoinPoint joinPoint,
 RateLimit rateLimit)
               throws RateLimitExceededException,
ExecutionException

Apply a rate limit at the given join point.

Parameters:

joinPoint - the join point

rateLimit - the rate limit to apply

Throws:

RateLimitExceededException - in case the rate limit was exceeded

ExecutionException - if something else went wrong