com.giffing.bucket4j.spring.boot.starter.config

Class Bucket4JBaseConfiguration

java.lang.Object

com.giffing.bucket4j.spring.boot.starter.config.Bucket4JBaseConfiguration

Direct Known Subclasses:

Bucket4JAutoConfigurationServletFilter, Bucket4JAutoConfigurationZuul

public abstract class Bucket4JBaseConfiguration
extends Object

Holds helper Methods which are reused by the Bucket4JAutoConfigurationServletFilter and the Bucket4JAutoConfigurationZuul configuration classes

Constructor Summary

Constructors

Constructor and Description
Bucket4JBaseConfiguration()

Method Summary

Modifier and Type	Method and Description
FilterConfiguration	buildFilterConfig(Bucket4JBootProperties.Bucket4JConfiguration config, javax.cache.CacheManager cacheManager, org.springframework.expression.ExpressionParser expressionParser, org.springframework.beans.factory.BeanFactory beanFactory) This method
Condition	executeCondition(Bucket4JBootProperties.RateLimit rateLimit, org.springframework.expression.ExpressionParser expressionParser, org.springframework.beans.factory.BeanFactory beanFactory) Creates the lambda for the execute condition which will be evaluated on each request.
KeyFilter	getKeyFilter(String url, Bucket4JBootProperties.RateLimit rateLimit, org.springframework.expression.ExpressionParser expressionParser, org.springframework.beans.factory.BeanFactory beanFactory) Creates the key filter lambda which is responsible to decide how the rate limit will be performed.
javax.cache.Cache<String,io.github.bucket4j.grid.GridBucketState>	jCache(String cacheName, javax.cache.CacheManager cacheManager) This methods
Condition	skipCondition(Bucket4JBootProperties.RateLimit rateLimit, org.springframework.expression.ExpressionParser expressionParser, org.springframework.beans.factory.BeanFactory beanFactory) Creates the lambda for the skip condition which will be evaluated on each request

Methods inherited from class java.lang.Object

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

Constructor Detail

Bucket4JBaseConfiguration

public Bucket4JBaseConfiguration()

Method Detail

jCache

public javax.cache.Cache<String,io.github.bucket4j.grid.GridBucketState> jCache(String cacheName,
                                                                                javax.cache.CacheManager cacheManager)

This methods

Parameters:

cacheName - the name of the cache to retrieve

cacheManager -

Returns:

buildFilterConfig

public FilterConfiguration buildFilterConfig(Bucket4JBootProperties.Bucket4JConfiguration config,
                                             javax.cache.CacheManager cacheManager,
                                             org.springframework.expression.ExpressionParser expressionParser,
                                             org.springframework.beans.factory.BeanFactory beanFactory)

This method

Parameters:

config -

cacheManager -

expressionParser -

beanFactory -

Returns:

getKeyFilter

public KeyFilter getKeyFilter(String url,
                              Bucket4JBootProperties.RateLimit rateLimit,
                              org.springframework.expression.ExpressionParser expressionParser,
                              org.springframework.beans.factory.BeanFactory beanFactory)

Creates the key filter lambda which is responsible to decide how the rate limit will be performed. The key is the unique identifier like an IP address or a username.

Parameters:

url - is used to generated a unique cache key

rateLimit - the Bucket4JBootProperties.RateLimit configuration which holds the skip condition string

expressionParser - is used to evaluate the expression if the filter key type is EXPRESSION.

beanFactory - used to get full access to all java beans in the SpEl

Returns:

should not been null. If no filter key type is matching a plain 1 is returned so that all requests uses the same key.

skipCondition

public Condition skipCondition(Bucket4JBootProperties.RateLimit rateLimit,
                               org.springframework.expression.ExpressionParser expressionParser,
                               org.springframework.beans.factory.BeanFactory beanFactory)

Creates the lambda for the skip condition which will be evaluated on each request

Parameters:

rateLimit - the Bucket4JBootProperties.RateLimit configuration which holds the skip condition string

expressionParser - is used to evaluate the skip expression

beanFactory - used to get full access to all java beans in the SpEl

Returns:

the lamdba condition which will be evaluated lazy - null if there is no condition available.

executeCondition

public Condition executeCondition(Bucket4JBootProperties.RateLimit rateLimit,
                                  org.springframework.expression.ExpressionParser expressionParser,
                                  org.springframework.beans.factory.BeanFactory beanFactory)

Creates the lambda for the execute condition which will be evaluated on each request.

Parameters:

rateLimit - the Bucket4JBootProperties.RateLimit configuration which holds the execute condition string

expressionParser - is used to evaluate the execution expression

beanFactory - used to get full access to all java beans in the SpEl

Returns:

the lamdba condition which will be evaluated lazy - null if there is no condition available.