uk.co.visalia.brightpearl.apiclient.ratelimit

Class NoOpRateLimiter

java.lang.Object

uk.co.visalia.brightpearl.apiclient.ratelimit.NoOpRateLimiter

All Implemented Interfaces:

RateLimiter

public class NoOpRateLimiter
extends Object
implements RateLimiter

An implementation of RateLimiter that allows requests to be sent to Brightpearl as fast as they are made by the client. Suitable for use anywhere the request cap is unlikely to be reached, when another strategy is in place for limiting the rate of requests, or when the client is set up to recover from rate limit errors automatically.

Constructor Summary

Constructors

Constructor and Description
NoOpRateLimiter()

Method Summary

Methods

Modifier and Type	Method and Description
void	rateLimit(Account account) This implementation does nothing.
void	requestCapExceeded(Account account) This implementation does nothing.
void	requestCompleted(Account account, int requestsRemaining, long nextThrottlePeriod) This implementation does nothing.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoOpRateLimiter

public NoOpRateLimiter()

Method Detail

rateLimit

public void rateLimit(Account account)

This implementation does nothing.

Specified by:

rateLimit in interface RateLimiter

Parameters:

account - The account a request will be sent to.

requestCompleted

public void requestCompleted(Account account,
                    int requestsRemaining,
                    long nextThrottlePeriod)

This implementation does nothing.

Specified by:

requestCompleted in interface RateLimiter

Parameters:

account - The account a response has been received from.

requestsRemaining - The value of the brightpearl-requests-remaining response header.

nextThrottlePeriod - The value of the brightpearl-next-throttle-period header.

requestCapExceeded

public void requestCapExceeded(Account account)

This implementation does nothing.

Specified by:

requestCapExceeded in interface RateLimiter

Parameters:

account - An account for which a request cap error has been received.