org.wikidata.query.rdf.blazegraph.throttling

Class ThrottlingState

java.lang.Object

org.wikidata.query.rdf.blazegraph.throttling.ThrottlingState

All Implemented Interfaces:

BanState, TimeAndErrorsState

@ThreadSafe
public final class ThrottlingState
extends Object
implements BanState, TimeAndErrorsState

Keeps track of resource useage for a client. This class tracks of the request time consumed, the errors and the number of request throttled for a given client.

Constructor Summary

Constructors

Constructor and Description
ThrottlingState(org.isomorphism.util.TokenBucket timeBucket, org.isomorphism.util.TokenBucket errorsBucket, org.isomorphism.util.TokenBucket throttleBucket, Duration banDuration) Constructor.

Method Summary

Modifier and Type	Method and Description
Instant	bannedUntil() A user is banned until this instant.
void	consumeError() Consumes errors from the error bucket.
void	consumeThrottled() Consume throttled requests.
void	consumeTime(Duration elapsed) Consumes request time from the time bucket.
Instant	throttledUntil() A user is throttled until this instant.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThrottlingState

public ThrottlingState(org.isomorphism.util.TokenBucket timeBucket,
                       org.isomorphism.util.TokenBucket errorsBucket,
                       org.isomorphism.util.TokenBucket throttleBucket,
                       Duration banDuration)

Constructor.

Parameters:

timeBucket - bucket to track requests time

errorsBucket - bucket to track errors

throttleBucket - bucket to track throttling

banDuration - default duration of a ban

Method Detail

consumeThrottled

public void consumeThrottled()

Description copied from interface: BanState

Consume throttled requests. Should be called each time a request is throttled. Will update the banned state.

Specified by:

consumeThrottled in interface BanState

bannedUntil

public Instant bannedUntil()

Description copied from interface: BanState

A user is banned until this instant.

Specified by:

bannedUntil in interface BanState

Returns:

the end of the ban if the user is banned, an Instant in the past otherwise

consumeTime

public void consumeTime(Duration elapsed)

Description copied from interface: TimeAndErrorsState

Consumes request time from the time bucket. If the time bucket contains less tokens than what the request consumed, all available tokens will be consumed: min(elapsed.toMillis(), timeBucket.getNumTokens()).

Specified by:

consumeTime in interface TimeAndErrorsState

Parameters:

elapsed - time elapsed during the request

consumeError

public void consumeError()

Description copied from interface: TimeAndErrorsState

Consumes errors from the error bucket. If the error bucket is already empty, does nothing.

Specified by:

consumeError in interface TimeAndErrorsState

throttledUntil

public Instant throttledUntil()

Description copied from interface: TimeAndErrorsState

A user is throttled until this instant.

Specified by:

throttledUntil in interface TimeAndErrorsState

Returns:

the end of the throttling if the user is throttled, an Instant in the past otherwise