org.wikidata.query.rdf.blazegraph.throttling

Class Throttler<S>

java.lang.Object

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

Type Parameters:

S - the type of state used by child classes to track the clients.

Direct Known Subclasses:

BanThrottler, TimeAndErrorsThrottler

@ThreadSafe
public abstract class Throttler<S>
extends Object

Implement throttling logic.

See Also:

for a more complete description of how throttling works.

Field Summary

Fields

Modifier and Type	Field and Description
String	alwaysThrottleParam This parameter in query will cause throttling no matter what.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected S	getState(Object bucket)
protected S	getStateIfPresent(Object bucket)
protected abstract Instant	internalThrottledUntil(Object bucket, javax.servlet.http.HttpServletRequest request) Implemented by clients for the specific throttling logic.
protected boolean	shouldBypassThrottling(javax.servlet.http.HttpServletRequest request) Check whether this request should have throttling enabled.
Duration	throttledDuration(Object bucket, javax.servlet.http.HttpServletRequest request)
Instant	throttledUntil(Object bucket, javax.servlet.http.HttpServletRequest request) Until when is this request throttled.

Methods inherited from class java.lang.Object

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

Field Detail

alwaysThrottleParam

@Nullable
public final String alwaysThrottleParam

This parameter in query will cause throttling no matter what. This can be used for testing.

Constructor Detail

Throttler

public Throttler(Callable<S> createThrottlingState,
                 com.google.common.cache.Cache<Object,S> stateStore,
                 String enableThrottlingIfHeader,
                 String alwaysThrottleParam,
                 @Nonnull
                 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

alwaysThrottleParam - this query parameter will cause throttling no matter what

clock -

Method Detail

getState

protected S getState(Object bucket)
              throws ExecutionException

Throws:

ExecutionException

getStateIfPresent

protected S getStateIfPresent(Object bucket)

shouldBypassThrottling

protected boolean shouldBypassThrottling(javax.servlet.http.HttpServletRequest request)

Check whether this request should have throttling enabled.

Returns:

true if throttling should be skipped

throttledUntil

public Instant throttledUntil(Object bucket,
                              javax.servlet.http.HttpServletRequest request)

Until when is this request throttled.

Returns:

the end time of the throttling if the request is throttled, a time in the past if the request isn't throttled

throttledDuration

public Duration throttledDuration(Object bucket,
                                  javax.servlet.http.HttpServletRequest request)

internalThrottledUntil

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

Implemented by clients for the specific throttling logic.

See Also:

throttledUntil(Object, HttpServletRequest)