BaseRateLimiter (datarouter-rate-limiter 0.0.85 API)

java.lang.Object

io.datarouter.ratelimiter.BaseRateLimiter

Direct Known Subclasses:: BaseCacheRateLimiter

public abstract class BaseRateLimiter
extends Object

Constructor Summary

Constructors

Constructor Description

BaseRateLimiter(String name)

Method Summary

Modifier and Type	Method	Description
`boolean`	`allowed()`
`boolean`	`allowed(String dynamicKey)`
`boolean`	`allowedForIp(String dynamicKey, javax.servlet.http.HttpServletRequest request)`
`boolean`	`allowedForIp(javax.servlet.http.HttpServletRequest request)`
`String`	`getName()`
`protected abstract io.datarouter.util.tuple.Pair<Boolean,Calendar>`	`internalAllow(String key, boolean increment)`
`boolean`	`peek(String key)`

Methods inherited from class java.lang.Object

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

Constructor Details
- BaseRateLimiter
  
  public BaseRateLimiter(String name)
Method Details
- peek
  
  public final boolean peek(String key)
- allowed
  
  public final boolean allowed()
- allowed
  
  public final boolean allowed(String dynamicKey)
- allowedForIp
  
  public final boolean allowedForIp(javax.servlet.http.HttpServletRequest request)
- allowedForIp
  
  public final boolean allowedForIp(String dynamicKey, javax.servlet.http.HttpServletRequest request)
- getName
  
  public String getName()
- internalAllow
  
  protected abstract io.datarouter.util.tuple.Pair<Boolean,Calendar> internalAllow(String key, boolean increment)