io.micronaut.ratelimiter

Class RateLimitingSupport

java.lang.Object

io.micronaut.ratelimiter.RateLimitingSupport

@Singleton
public class RateLimitingSupport
extends java.lang.Object

Contains common business logic for rate limiting implementations.

Since:

1.0.0

Author:

James Kleeh

Constructor Summary

Constructors

Constructor and Description
RateLimitingSupport(RateLimitingConfiguration configuration) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected java.util.Optional<io.micronaut.core.annotation.AnnotationMetadata>	getAnnotationMetadata(io.micronaut.http.HttpRequest<?> request)
java.util.Optional<java.lang.String>	getConfigurationName(io.micronaut.http.HttpRequest<?> request)
boolean	shouldLimit(io.micronaut.http.HttpRequest<?> request)

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimitingSupport

public RateLimitingSupport(RateLimitingConfiguration configuration)

Default constructor.

Parameters:

configuration - The rate limiting configuration

Method Detail

shouldLimit

public boolean shouldLimit(io.micronaut.http.HttpRequest<?> request)

Parameters:

request - The request

Returns:

True if the request should be rate limited

getConfigurationName

public java.util.Optional<java.lang.String> getConfigurationName(io.micronaut.http.HttpRequest<?> request)

Parameters:

request - The request

Returns:

The rate limiting configuration to be used for this request. Returns empty if the default configuration should apply

getAnnotationMetadata

protected java.util.Optional<io.micronaut.core.annotation.AnnotationMetadata> getAnnotationMetadata(io.micronaut.http.HttpRequest<?> request)

Parameters:

request - The request

Returns:

The annotation metadata to resolve rate limit annotations