net.rithms.riot.api.request.ratelimit

Class DefaultRateLimitHandler

java.lang.Object

net.rithms.riot.api.request.ratelimit.DefaultRateLimitHandler

All Implemented Interfaces:

RateLimitHandler

Direct Known Subclasses:

BufferedRateLimitHandler

public class DefaultRateLimitHandler
extends java.lang.Object
implements RateLimitHandler

This is the default RateLimitHandler. It keeps track of rate limits when they are exceeded and prevents further requests from being fired if they would violate a known rate limit.

If you want to keep the functionality of this DefaultRateLimitHandler but want to extend it, you can simply inherit this class and call the super methods like this:

 public class CustomRateLimitHandler extends DefaultRateLimitHandler {
        @Override
        public void onRequestAboutToFire(Request request) throws RespectedRateLimitException {
                super.onRequestAboutToFire(request);
                // Your code here
        }

        @Override
        public void onRequestDone(Request request) {
                super.onRequestDone(request);
                // Your code here
        }
 }
 

Author:

Daniel 'Linnun' Figge

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DefaultRateLimitHandler.RateLimit
class	DefaultRateLimitHandler.RateLimitList

Constructor Summary

Constructors

Constructor and Description
DefaultRateLimitHandler()

Method Summary

Modifier and Type	Method and Description
void	onRequestAboutToFire(Request request) This method is called for every request before it is fired to the Riot API.
void	onRequestDone(Request request) This method is called for every request after it has finished.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRateLimitHandler

public DefaultRateLimitHandler()

Method Detail

onRequestAboutToFire

public void onRequestAboutToFire(Request request)
                          throws RespectedRateLimitException

Description copied from interface: RateLimitHandler

This method is called for every request before it is fired to the Riot API. Here you get the chance to respect rate limits and decide to not fire the request by throwing a RespectedRateLimitException instead.

Specified by:

onRequestAboutToFire in interface RateLimitHandler

Throws:

RespectedRateLimitException - If the RateLimitHandler decides that a request should not be fired

onRequestDone

public void onRequestDone(Request request)

Description copied from interface: RateLimitHandler

This method is called for every request after it has finished. Here you get the chance to check the request's response and use its header fields to handle your rate limiting logic.

Specified by:

onRequestDone in interface RateLimitHandler