code.ponfee.commons.limit.request

类 RequestLimiter

java.lang.Object

code.ponfee.commons.limit.request.RequestLimiter

直接已知子类:

ConcurrentMapRequestLimiter, HttpSessionRequestLimiter

public abstract class RequestLimiter
extends Object

Request limiter, like as send sms and so on

作者:

Ponfee

字段概要

字段

限定符和类型	字段和说明
static String	CACHE_CAPTCHA_KEY image captcha code verify key
static String	CACHE_CODE_KEY validation code verify key
static String	CHECK_CODE_KEY
static String	CHECK_FREQ_KEY limit operation key
static String	CHECK_THRE_KEY
static String	TRACE_ACTION_KEY count operation action key

构造器概要

构造器

构造器和说明
RequestLimiter()

方法概要

限定符和类型	方法和说明
static String	buildNonce(String code, String salt) 生成nonce校验码（返回到用户端）
abstract void	cacheCaptcha(String key, String captcha, int expire) cache captcha of server generate
abstract void	cacheCode(String key, String code, int ttl) cache for the server generate validation code
boolean	checkCaptcha(String key, String captcha)
abstract boolean	checkCaptcha(String key, String captcha, boolean caseSensitive) check captcha of user input
abstract RequestLimiter	checkCode(String key, String code, int limit) check the validation code of user input is equals server cache
abstract long	countAction(String key) 统计周期内的行为量 用于登录失败达到一定次数后锁定账户等场景
static String	format(int seconds) 时间格式化，5/6 rate
RequestLimiter	limitFrequency(String key, int period)
abstract RequestLimiter	limitFrequency(String key, int period, String message) 访问频率限制：一个周期内最多允许访问1次 比如短信60秒内只能发送一次
RequestLimiter	limitThreshold(String key, int period, int limit)
abstract RequestLimiter	limitThreshold(String key, int period, int limit, String message) 访问次数限制：一个周期内最多允许访问limit次 比如一个手机号一天只能发10次
abstract void	recordAction(String key, int period) 计数周期内的行为 用于登录失败达到一定次数后锁定账户等场景
abstract void	resetAction(String key) 重置行为
static boolean	verifyNonce(String nonce, String code, String salt) 校验nonce

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

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

字段详细资料

CHECK_FREQ_KEY

public static final String CHECK_FREQ_KEY

limit operation key

另请参阅:

常量字段值

CHECK_THRE_KEY

public static final String CHECK_THRE_KEY

另请参阅:

常量字段值

CACHE_CODE_KEY

public static final String CACHE_CODE_KEY

validation code verify key

另请参阅:

常量字段值

CHECK_CODE_KEY

public static final String CHECK_CODE_KEY

另请参阅:

常量字段值

CACHE_CAPTCHA_KEY

public static final String CACHE_CAPTCHA_KEY

image captcha code verify key

另请参阅:

常量字段值

TRACE_ACTION_KEY

public static final String TRACE_ACTION_KEY

count operation action key

另请参阅:

常量字段值

构造器详细资料

RequestLimiter

public RequestLimiter()

方法详细资料

limitFrequency

public final RequestLimiter limitFrequency(String key,
                                           int period)
                                    throws RequestLimitException

抛出:

RequestLimitException

limitFrequency

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

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

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

参数:

key - the key

period - the period

message - the message

返回:

the caller, chain program

抛出:

RequestLimitException - if over limit occurs

limitThreshold

public final RequestLimiter limitThreshold(String key,
                                           int period,
                                           int limit)
                                    throws RequestLimitException

抛出:

RequestLimitException

limitThreshold

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

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

参数:

key - the key

period - the period

limit - the limit

message - the message

返回:

the caller, chain program

抛出:

RequestLimitException - if over limit occurs

cacheCode

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

cache for the server generate validation code

参数:

key - the cache key

code - the validation code of server generate

ttl - the expire time

checkCode

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

check the validation code of user input is equals server cache

参数:

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 abstract void cacheCaptcha(String key,
                                  String captcha,
                                  int expire)

cache captcha of server generate

参数:

key -

captcha - the image captcha code of server generate

expire - 缓存有效时间

checkCaptcha

public final boolean checkCaptcha(String key,
                                  String captcha)

checkCaptcha

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

check captcha of user input

参数:

key - the cache key

captcha - the captcha

caseSensitive - is case sensitive

返回:

true|false

recordAction

public abstract void recordAction(String key,
                                  int period)

计数周期内的行为

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

参数:

key -

period -

countAction

public abstract long countAction(String key)

统计周期内的行为量

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

参数:

key - the key

返回:

action count number

resetAction

public abstract void resetAction(String key)

重置行为

参数:

key - the key

buildNonce

public static String buildNonce(String code,
                                String salt)

生成nonce校验码（返回到用户端）

参数:

code - a string like as captcha code

salt - a string like as mobile phone

返回:

a check code

verifyNonce

public static boolean verifyNonce(String nonce,
                                  String code,
                                  String salt)

校验nonce

参数:

nonce - the nonce

code - the code

salt - the salt

返回:

true is verify success

format

public static String format(int seconds)

时间格式化，5/6 rate

参数:

seconds -

返回: