es.moki.ratelimij.dropwizard.annotation

Annotation Type RateLimited

@NameBinding
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface RateLimited

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Rate[]	rates

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	groupKeyPrefix An optional group key prefix allows for a grouped rate limit across multiple dropwizard resources.
KeyPart[]	keys
boolean	reportOnly If true the rate limiter won't enforce over limit.

Element Detail

rates

public abstract Rate[] rates

keys

public abstract KeyPart[] keys

Default:

{}

groupKeyPrefix

public abstract java.lang.String groupKeyPrefix

An optional group key prefix allows for a grouped rate limit across multiple dropwizard resources. Note the group key name will have no impact if using the deprecated key.

Returns:

Default:

""

reportOnly

public abstract boolean reportOnly

If true the rate limiter won't enforce over limit. ReportOnly can be used to evaluate rate limits in production environments.

Returns:

should not enforce limit.

Default:

false