org.wikidata.query.rdf.blazegraph.throttling

Class BanThrottler<S extends BanState>

java.lang.Object

org.wikidata.query.rdf.blazegraph.throttling.Throttler<S>

org.wikidata.query.rdf.blazegraph.throttling.BanThrottler<S>

public class BanThrottler<S extends BanState>
extends Throttler<S>

Field Summary

Fields inherited from class org.wikidata.query.rdf.blazegraph.throttling.Throttler

alwaysThrottleParam

Constructor Summary

Constructors

Constructor and Description
BanThrottler(Callable<S> createThrottlingState, com.google.common.cache.Cache<Object,S> stateStore, String enableThrottlingIfHeader, String alwaysBanParam, Clock clock) Constructor.

Method Summary

Modifier and Type	Method and Description
protected Instant	internalThrottledUntil(Object bucket, javax.servlet.http.HttpServletRequest request) Implemented by clients for the specific throttling logic.
void	throttled(Object bucket, javax.servlet.http.HttpServletRequest request) Should be called each time a request is throttled.

Methods inherited from class org.wikidata.query.rdf.blazegraph.throttling.Throttler

getState, getStateIfPresent, shouldBypassThrottling, throttledDuration, throttledUntil

Methods inherited from class java.lang.Object

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

Constructor Detail

BanThrottler

public BanThrottler(Callable<S> createThrottlingState,
                    com.google.common.cache.Cache<Object,S> stateStore,
                    String enableThrottlingIfHeader,
                    String alwaysBanParam,
                    Clock clock)

Constructor.

Note that a bucket represent our approximation of a single client.

Parameters:

createThrottlingState - how to create the initial throttling state when we start tracking a specific client

stateStore - the cache in which we store the per client state of throttling

enableThrottlingIfHeader - throttling is only enabled if this header is present

alwaysBanParam - this query parameter will cause banning no matter what

Method Detail

internalThrottledUntil

protected Instant internalThrottledUntil(Object bucket,
                                         javax.servlet.http.HttpServletRequest request)

Description copied from class: Throttler

Implemented by clients for the specific throttling logic.

Specified by:

internalThrottledUntil in class Throttler<S extends BanState>

See Also:

Throttler.throttledUntil(Object, HttpServletRequest)

throttled

public void throttled(Object bucket,
                      javax.servlet.http.HttpServletRequest request)

Should be called each time a request is throttled.

Parameters:

bucket - the bucket to which this request belongs

request - the request being throttled