cn.ponfee.commons.limit.request

类 ConcurrentMapRequestLimiter

java.lang.Object

cn.ponfee.commons.limit.request.RequestLimiter

cn.ponfee.commons.limit.request.ConcurrentMapRequestLimiter

public final class ConcurrentMapRequestLimiter
extends RequestLimiter

The request limiter based ConcurrentHashMap Warning: distribute depoly with multiple server nodes maybe occur problem

作者:

Ponfee

字段概要

从类继承的字段 cn.ponfee.commons.limit.request.RequestLimiter

CACHE_CAPTCHA_KEY, CACHE_CODE_KEY, CHECK_CODE_KEY, CHECK_FREQ_KEY, CHECK_THRE_KEY, TRACE_ACTION_KEY

方法概要

限定符和类型	方法和说明
void	cacheCaptcha(String key, String captcha, int expire) cache captcha of server generate
void	cacheCode(String key, String code, int ttl) cache for the server generate validation code
boolean	checkCaptcha(String key, String captcha, boolean caseSensitive) check captcha of user input
ConcurrentMapRequestLimiter	checkCode(String key, String code, int limit) check the validation code of user input is equals server cache
long	countAction(String key) 统计周期内的行为量 用于登录失败达到一定次数后锁定账户等场景
ConcurrentMapRequestLimiter	limitFrequency(String key, int period, String message) 访问频率限制：一个周期内最多允许访问1次 比如短信60秒内只能发送一次
ConcurrentMapRequestLimiter	limitThreshold(String key, int period, int limit, String message) 访问次数限制：一个周期内最多允许访问limit次 比如一个手机号一天只能发10次
void	recordAction(String key, int period) 计数周期内的行为 用于登录失败达到一定次数后锁定账户等场景
void	resetAction(String key) 重置行为

从类继承的方法 cn.ponfee.commons.limit.request.RequestLimiter

buildNonce, checkCaptcha, format, limitFrequency, limitThreshold, verifyNonce

从类继承的方法 java.lang.Object

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

方法详细资料

limitFrequency

public ConcurrentMapRequestLimiter limitFrequency(String key,
                                                  int period,
                                                  String message)
                                           throws RequestLimitException

从类复制的说明: RequestLimiter

访问频率限制：一个周期内最多允许访问1次

比如短信60秒内只能发送一次

指定者:

limitFrequency 在类中 RequestLimiter

参数:

key - the key

period - the period

message - the message

返回:

the caller, chain program

抛出:

RequestLimitException - if over limit occurs

limitThreshold

public ConcurrentMapRequestLimiter limitThreshold(String key,
                                                  int period,
                                                  int limit,
                                                  String message)
                                           throws RequestLimitException

从类复制的说明: RequestLimiter

访问次数限制：一个周期内最多允许访问limit次 比如一个手机号一天只能发10次

指定者:

limitThreshold 在类中 RequestLimiter

参数:

key - the key

period - the period

limit - the limit

message - the message

返回:

the caller, chain program

抛出:

RequestLimitException - if over limit occurs

cacheCode

public void cacheCode(String key,
                      String code,
                      int ttl)

从类复制的说明: RequestLimiter

cache for the server generate validation code

指定者:

cacheCode 在类中 RequestLimiter

参数:

key - the cache key

code - the validation code of server generate

ttl - the expire time

checkCode

public ConcurrentMapRequestLimiter checkCode(String key,
                                             String code,
                                             int limit)
                                      throws RequestLimitException

从类复制的说明: RequestLimiter

check the validation code of user input is equals server cache

指定者:

checkCode 在类中 RequestLimiter

参数:

key - the cache key

code - the validation code of user input

limit - the maximum fail input times

返回:

the caller, chain program

抛出:

RequestLimitException - if over limit occurs

cacheCaptcha

public void cacheCaptcha(String key,
                         String captcha,
                         int expire)

从类复制的说明: RequestLimiter

cache captcha of server generate

指定者:

cacheCaptcha 在类中 RequestLimiter

captcha - the image captcha code of server generate

expire - 缓存有效时间

checkCaptcha

public boolean checkCaptcha(String key,
                            String captcha,
                            boolean caseSensitive)

从类复制的说明: RequestLimiter

check captcha of user input

指定者:

checkCaptcha 在类中 RequestLimiter

参数:

key - the cache key

captcha - the captcha

caseSensitive - is case sensitive

返回:

true|false

recordAction

public void recordAction(String key,
                         int period)

从类复制的说明: RequestLimiter

计数周期内的行为

用于登录失败达到一定次数后锁定账户等场景

指定者:

recordAction 在类中 RequestLimiter

countAction

public long countAction(String key)

从类复制的说明: RequestLimiter

统计周期内的行为量

用于登录失败达到一定次数后锁定账户等场景

指定者:

countAction 在类中 RequestLimiter

参数:

key - the key

返回:

action count number

resetAction

public void resetAction(String key)

从类复制的说明: RequestLimiter

重置行为

指定者:

resetAction 在类中 RequestLimiter

参数:

key - the key