Skip to content

Commit

Permalink
remove deprecated documentation for Filter types
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcGiffing committed Mar 16, 2022
1 parent 3bc6fc5 commit 59a2310
Showing 1 changed file with 0 additions and 12 deletions.
12 changes: 0 additions & 12 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -139,18 +139,6 @@ bucket4j.filters[0].rate-limits[0].bandwidths[0].fixed-refill-interval=0
bucket4j.filters[0].rate-limits[0].bandwidths[0].fixed-refill-interval-unit=minutes
----

=== Filter types (bad name, should be renamed in the feature)

Filter types are predefined configuration option on how to define the key which should be used to limiting the requests.

==== Default

The default options doesn't differentiates between incoming requests (user, ip, etc). Its a general limiting.

==== IP

The IP filter type limits the access based on the IP address (httpServletRequest.getRemoteAddr()). So each IP address will independently throttled.

==== Expression

The expression based filter type provides the most flexible one and uses the https://docs.spring.io/spring/docs/current/spring-framework-reference/html/expressions.html[Spring Expression Language] (SpEL). https://docs.spring.io/spring/docs/current/spring-framework-reference/html/expressions.html#expressions-spel-compilation[The expression compiles to a Java class which will be used].
Expand Down

0 comments on commit 59a2310

Please sign in to comment.