io.micronaut.ratelimiter

Class RateLimitingConfiguration

java.lang.Object

io.micronaut.ratelimiter.RateLimitingConfiguration

@ConfigurationProperties(value="micronaut.ratelimiting")
public class RateLimitingConfiguration
extends java.lang.Object

Configuration for generic rate limiting options.

Since:

1.0.0

Author:

James Kleeh

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PATH_KEY

Constructor Summary

Constructors

Constructor and Description
RateLimitingConfiguration()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getPaths()
boolean	isIpAddressResolver()
void	setIpAddressResolver(boolean ipAddressResolver)
void	setPaths(java.util.List<java.lang.String> paths)

Methods inherited from class java.lang.Object

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

Field Detail

PATH_KEY

public static final java.lang.String PATH_KEY

See Also:

Constant Field Values

Constructor Detail

RateLimitingConfiguration

public RateLimitingConfiguration()

Method Detail

getPaths

@Nonnull
public java.util.List<java.lang.String> getPaths()

Returns:

The paths to rate limit

setPaths

public void setPaths(@Nonnull
                     java.util.List<java.lang.String> paths)

Parameters:

paths - The ANT style paths that rate limiting should be applied to

isIpAddressResolver

public boolean isIpAddressResolver()

Returns:

True if the ip address bucket name resolver should be used

setIpAddressResolver

public void setIpAddressResolver(boolean ipAddressResolver)

Parameters:

ipAddressResolver - If true, the provided IP address BucketNameResolver will be enabled.