com.giffing.bucket4j.spring.boot.starter.context

Interface KeyFilter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface KeyFilter

Functional interface to retrieve the Bucket4j key. The key is used to identify the Bucket4j storage.

Method Summary

Modifier and Type	Method and Description
String	key(javax.servlet.http.HttpServletRequest servletRequest) Return the unique Bucket4j storage key.

Method Detail

key

@NotNull
String key(javax.servlet.http.HttpServletRequest servletRequest)

Return the unique Bucket4j storage key. You can think of the key as a unique identifier which is for example an IP-Address or a user name. The rate limit is then applied to each individual key.

Parameters:

servletRequest - HTTP Servlet Request information of the current request

Returns:

the key to identify the the rate limit (IP, username, ...)