Package org.languagetool.server

Class RequestLimiter

java.lang.Object

org.languagetool.server.RequestLimiter

Direct Known Subclasses:

ErrorRequestLimiter

class RequestLimiter
extends Object

Limit the maximum number of request per IP address for a given time range.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	RequestLimiter.RequestEvent

Field Summary

Fields

Modifier and Type	Field	Description
private final int	ipFingerprintFactor
private final int	ipRequestLimit
private final int	ipRequestLimitInBytes
(package private) static final int	REQUEST_QUEUE_SIZE
(package private) final List<RequestLimiter.RequestEvent>	requestEvents
private final int	requestLimit
private final int	requestLimitInBytes
private final int	requestLimitPeriodInSeconds
private final int	whitelistLimit
private final List<String>	whitelistUsers

Constructor Summary

Constructors

Constructor	Description
RequestLimiter(int requestLimit, int requestLimitInBytes, int requestLimitPeriodInSeconds)
RequestLimiter(int requestLimit, int requestLimitInBytes, int requestLimitPeriodInSeconds, int ipFingerprintFactor)
RequestLimiter(int requestLimit, int requestLimitInBytes, int requestLimitPeriodInSeconds, int ipFingerprintFactor, List<String> whitelistUsers, int whitelistLimit)

Method Summary

Modifier and Type	Method	Description
(package private) void	checkAccess(String ipAddress, Map<String,String> params, Map<String,List<String>> httpHeader, UserLimits userLimits)
(package private) void	checkLimit(String ipAddress, Map<String,String> parameters, Map<String,List<String>> httpHeader)
(package private) static void	checkUserLimit(String referer, String userAgent, UserLimits user)
(package private) String	computeFingerprint(Map<String,List<String>> httpHeader, Map<String,String> parameters)
private Long	getClientId(Map<String,String> parameters)
private String	getReferer(Map<String,List<String>> httpHeader)
(package private) int	getRequestLimit()	The maximum number of request per getRequestLimitPeriodInSeconds().
(package private) int	getRequestLimitInBytes()	The maximum number of request bytes per getRequestLimitPeriodInSeconds().
(package private) int	getRequestLimitPeriodInSeconds()	The time period over which requests are considered, in seconds.
private int	getRequestSize(Map<String,String> params)
private String	getUserAgent(Map<String,List<String>> httpHeader)

Methods inherited from class java.lang.Object

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

Field Details

REQUEST_QUEUE_SIZE

static final int REQUEST_QUEUE_SIZE

See Also:

• Constant Field Values

requestEvents

final List<RequestLimiter.RequestEvent> requestEvents

ipFingerprintFactor

private final int ipFingerprintFactor

whitelistUsers

private final List<String> whitelistUsers

whitelistLimit

private final int whitelistLimit

requestLimit

private final int requestLimit

ipRequestLimit

private final int ipRequestLimit

requestLimitInBytes

private final int requestLimitInBytes

ipRequestLimitInBytes

private final int ipRequestLimitInBytes

requestLimitPeriodInSeconds

private final int requestLimitPeriodInSeconds

Constructor Details

RequestLimiter

RequestLimiter(int requestLimit,
 int requestLimitInBytes,
 int requestLimitPeriodInSeconds,
 int ipFingerprintFactor,
 List<String> whitelistUsers,
 int whitelistLimit)

Parameters:

requestLimit - the maximum number of request per requestLimitPeriodInSeconds

requestLimitPeriodInSeconds - the time period over which requests are considered, in seconds

ipFingerprintFactor - allow limits x times larger per ip when fingerprints differ (i.e. assume there may be a maximum of x users behind the same ip)

RequestLimiter

RequestLimiter(int requestLimit,
 int requestLimitInBytes,
 int requestLimitPeriodInSeconds,
 int ipFingerprintFactor)

RequestLimiter

RequestLimiter(int requestLimit,
 int requestLimitInBytes,
 int requestLimitPeriodInSeconds)

Method Details

getRequestLimit

int getRequestLimit()

The maximum number of request per getRequestLimitPeriodInSeconds().

getRequestLimitInBytes

int getRequestLimitInBytes()

The maximum number of request bytes per getRequestLimitPeriodInSeconds().

Since:

4.0

getRequestLimitPeriodInSeconds

int getRequestLimitPeriodInSeconds()

The time period over which requests are considered, in seconds.

computeFingerprint

String computeFingerprint(Map<String,List<String>> httpHeader,
 Map<String,String> parameters)

checkAccess

void checkAccess(String ipAddress,
 Map<String,String> params,
 Map<String,List<String>> httpHeader,
 UserLimits userLimits)

Parameters:

ipAddress - the client's IP address

Throws:

TooManyRequestsException - if access is not allowed because the request limit is reached

getRequestSize

private int getRequestSize(Map<String,String> params)

getClientId

private Long getClientId(Map<String,String> parameters)

getReferer

private String getReferer(Map<String,List<String>> httpHeader)

getUserAgent

private String getUserAgent(Map<String,List<String>> httpHeader)

checkUserLimit

static void checkUserLimit(String referer,
 String userAgent,
 UserLimits user)

checkLimit

void checkLimit(String ipAddress,
 Map<String,String> parameters,
 Map<String,List<String>> httpHeader)