Package io.vertigo.vega.plugins.ratelimiting.mem

Class RateLimitingMemStorePlugin

java.lang.Object

io.vertigo.vega.plugins.ratelimiting.mem.RateLimitingMemStorePlugin

All Implemented Interfaces:

io.vertigo.core.node.component.CoreComponent, io.vertigo.core.node.component.Plugin, io.vertigo.core.node.definition.DefinitionProvider, io.vertigo.core.node.definition.SimpleDefinitionProvider, RateLimitingStorePlugin

public final class RateLimitingMemStorePlugin
extends Object
implements RateLimitingStorePlugin, io.vertigo.core.node.definition.SimpleDefinitionProvider

Rate limiting counting in memory storage.

Author:

npiedeloup

Constructor Summary

Constructors

Constructor	Description
RateLimitingMemStorePlugin(Optional<Integer> windowSeconds, Optional<Long> maxBanishSeconds)

Method Summary

Modifier and Type	Method	Description
void	banishUntil(String userKey, Instant banishUntil)	Set banish until instant for a userKey.
void	cancelAllBanishments()	Cancel all banishments.
void	cancelBanishment(String userKey)	Cancel banishment of a userkey.
void	extendsWindow(String userKey, long newWindowSeconds)
Instant	getBanishInstant(String userKey)	Get banish until instant.
Map<String,Instant>	getBanishments()
long	getFirstHitAgeSecond(String userKey)	Get first hit age for a userKey.
int	incrementBanishCounter(String userKey, long maxBanishSeconds)	Prepare banishment, increment and get banish counter.
List<? extends io.vertigo.core.node.definition.Definition>	provideDefinitions(io.vertigo.core.node.definition.DefinitionSpace definitionSpace)
long	remainingSeconds(String userKey)	Get remaining seconds in window for a userKey.
long	touch(String userKey, long incrBy, long windowSeconds)	Hit count by userKey, over a window.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertigo.core.node.definition.DefinitionProvider

addDefinitionResourceConfig

Methods inherited from interface io.vertigo.core.node.definition.SimpleDefinitionProvider

get

Constructor Details

RateLimitingMemStorePlugin

@Inject
public RateLimitingMemStorePlugin(Optional<Integer> windowSeconds,
 Optional<Long> maxBanishSeconds)

Method Details

provideDefinitions

public List<? extends io.vertigo.core.node.definition.Definition> provideDefinitions(io.vertigo.core.node.definition.DefinitionSpace definitionSpace)

Specified by:

provideDefinitions in interface io.vertigo.core.node.definition.SimpleDefinitionProvider

getBanishInstant

public Instant getBanishInstant(String userKey)

Description copied from interface: RateLimitingStorePlugin

Get banish until instant.

Specified by:

getBanishInstant in interface RateLimitingStorePlugin

Parameters:

userKey - user key (like ip)

Returns:

banish until instant.

touch

public long touch(String userKey,
 long incrBy,
 long windowSeconds)

Description copied from interface: RateLimitingStorePlugin

Hit count by userKey, over a window.

Specified by:

touch in interface RateLimitingStorePlugin

Parameters:

userKey - user key (like ip)

incrBy - increment by

windowSeconds - window in seconds

extendsWindow

public void extendsWindow(String userKey,
 long newWindowSeconds)

Specified by:

extendsWindow in interface RateLimitingStorePlugin

remainingSeconds

public long remainingSeconds(String userKey)

Description copied from interface: RateLimitingStorePlugin

Get remaining seconds in window for a userKey.

Specified by:

remainingSeconds in interface RateLimitingStorePlugin

Parameters:

userKey - user key (like ip)

incrementBanishCounter

public int incrementBanishCounter(String userKey,
 long maxBanishSeconds)

Description copied from interface: RateLimitingStorePlugin

Prepare banishment, increment and get banish counter.

Specified by:

incrementBanishCounter in interface RateLimitingStorePlugin

Parameters:

userKey - user key (like ip)

maxBanishSeconds - max seconds counting banishment (each banish reset this time)

Returns:

current banish counter

banishUntil

public void banishUntil(String userKey,
 Instant banishUntil)

Description copied from interface: RateLimitingStorePlugin

Set banish until instant for a userKey.

Specified by:

banishUntil in interface RateLimitingStorePlugin

Parameters:

userKey - userKey user key (like ip)

banishUntil - banish until instant

getFirstHitAgeSecond

public long getFirstHitAgeSecond(String userKey)

Description copied from interface: RateLimitingStorePlugin

Get first hit age for a userKey.

Specified by:

getFirstHitAgeSecond in interface RateLimitingStorePlugin

Parameters:

userKey - userKey user key (like ip)

Returns:

age in second (-1 if unknown)

cancelBanishment

public void cancelBanishment(String userKey)

Description copied from interface: RateLimitingStorePlugin

Cancel banishment of a userkey.

Specified by:

cancelBanishment in interface RateLimitingStorePlugin

Parameters:

userKey - user key to reset

cancelAllBanishments

public void cancelAllBanishments()

Description copied from interface: RateLimitingStorePlugin

Cancel all banishments.

Specified by:

cancelAllBanishments in interface RateLimitingStorePlugin

getBanishments

public Map<String,Instant> getBanishments()

Specified by:

getBanishments in interface RateLimitingStorePlugin

Returns:

current banished userKey