Package org.languagetool.server

Class UserLimits

java.lang.Object

org.languagetool.server.UserLimits

class UserLimits
extends Object

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	UserLimits.Account

Field Summary

Fields

Modifier and Type	Field	Description
private final UserInfoEntry	account
private final Long	dictionaryCacheSize
private final boolean	hasPremium
private final LimitEnforcementMode	limitEnforcementMode
private static final org.slf4j.Logger	logger
private final long	maxCheckTimeMillis
private final int	maxTextLength
private final Long	premiumUid
private final Long	requestsPerDay
private boolean	skipLimits

Constructor Summary

Constructors

Modifier	Constructor	Description
(package private)	UserLimits(boolean skipLimits)	Special case for internal use to skip all limits.
private	UserLimits(int maxTextLength, long maxCheckTimeMillis, Long premiumUid, boolean hasPremium)
private	UserLimits(int maxTextLength, long maxCheckTimeMillis, Long premiumUid, boolean hasPremium, Long dictCacheSize, Long requestsPerDay, LimitEnforcementMode limitEnforcement)
private	UserLimits(int maxTextLength, long maxCheckTimeMillis, Long premiumUid, boolean hasPremium, Long dictCacheSize, Long requestsPerDay, LimitEnforcementMode limitEnforcement, UserInfoEntry account)

Method Summary

Modifier and Type	Method	Description
(package private) UserInfoEntry	getAccount()
(package private) static UserLimits	getDefaultLimits(HTTPServerConfig config)
Long	getDictCacheSize()
LimitEnforcementMode	getLimitEnforcementMode()
static UserLimits	getLimitsByAddonToken(HTTPServerConfig config, String username, String addonToken)	Get limits from the addon token, needs DB access
static UserLimits	getLimitsByApiKey(HTTPServerConfig config, String username, String apiKey)	Get limits from the api key itself, database access is needed.
(package private) static UserLimits	getLimitsFromUserAccount(HTTPServerConfig config, String username, String password)	Deprecated. Use getLimitsByApiKey() instead
(package private) long	getMaxCheckTimeMillis()
(package private) int	getMaxTextLength()
(package private) Long	getPremiumUid()
Long	getRequestsPerDay()
(package private) boolean	getSkipLimits()
private static UserLimits	getUserLimitsFromWhitelistOrDefault(HTTPServerConfig config, String username)
boolean	hasPremium()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final org.slf4j.Logger logger

account

@Nullable
private final UserInfoEntry account

maxTextLength

private final int maxTextLength

maxCheckTimeMillis

private final long maxCheckTimeMillis

hasPremium

private final boolean hasPremium

dictionaryCacheSize

private final Long dictionaryCacheSize

premiumUid

private final Long premiumUid

skipLimits

private boolean skipLimits

requestsPerDay

private final Long requestsPerDay

limitEnforcementMode

private final LimitEnforcementMode limitEnforcementMode

Constructor Details

UserLimits

private UserLimits(int maxTextLength,
 long maxCheckTimeMillis,
 Long premiumUid,
 boolean hasPremium)

UserLimits

private UserLimits(int maxTextLength,
 long maxCheckTimeMillis,
 Long premiumUid,
 boolean hasPremium,
 Long dictCacheSize,
 Long requestsPerDay,
 LimitEnforcementMode limitEnforcement)

UserLimits

private UserLimits(int maxTextLength,
 long maxCheckTimeMillis,
 Long premiumUid,
 boolean hasPremium,
 Long dictCacheSize,
 Long requestsPerDay,
 LimitEnforcementMode limitEnforcement,
 UserInfoEntry account)

UserLimits

UserLimits(boolean skipLimits)

Special case for internal use to skip all limits.

Method Details

getDefaultLimits

static UserLimits getDefaultLimits(HTTPServerConfig config)

getLimitsFromUserAccount

@Deprecated
static UserLimits getLimitsFromUserAccount(HTTPServerConfig config,
 @NotNull
 String username,
 @NotNull
 String password)

Deprecated.

Use getLimitsByApiKey() instead

getLimitsByApiKey

public static UserLimits getLimitsByApiKey(HTTPServerConfig config,
 String username,
 String apiKey)

Get limits from the api key itself, database access is needed.

getLimitsByAddonToken

public static UserLimits getLimitsByAddonToken(HTTPServerConfig config,
 String username,
 String addonToken)

Get limits from the addon token, needs DB access

getUserLimitsFromWhitelistOrDefault

private static UserLimits getUserLimitsFromWhitelistOrDefault(HTTPServerConfig config,
 String username)

getMaxTextLength

int getMaxTextLength()

getMaxCheckTimeMillis

long getMaxCheckTimeMillis()

getSkipLimits

boolean getSkipLimits()

getPremiumUid

@Nullable
Long getPremiumUid()

hasPremium

public boolean hasPremium()

toString

public String toString()

Overrides:

toString in class Object

getDictCacheSize

public Long getDictCacheSize()

getRequestsPerDay

public Long getRequestsPerDay()

getLimitEnforcementMode

public LimitEnforcementMode getLimitEnforcementMode()

getAccount

@Nullable
UserInfoEntry getAccount()