uk.co.visalia.brightpearl.apiclient.ratelimit

Interface RateLimiter

All Known Implementing Classes:

ConstantWaitRateLimiter, NoOpRateLimiter

public interface RateLimiter

An interface for rate limiters, which are called before any request is made to the Brightpearl API and notified when a request cap error is received. Implementations can abort requests by throwing exceptions, or sleep before returning to reduce the rate of requests.

See Also:

http://www.brightpearl.com/developer/latest/concept/request-throttling.html

Method Summary

Methods

Modifier and Type	Method and Description
void	rateLimit(Account account) Called immediately before a request is made to the Brightpearl API for the given account.
void	requestCapExceeded(Account account) Called when a request to an account has been rejected due to request throttling.
void	requestCompleted(Account account, int requestsRemaining, long nextThrottlePeriod) Called after every request is made to the Brightpearl API, with values from the brightpearl-requests-remaining and brightpearl-next-throttle-period headers.

Method Detail

rateLimit

void rateLimit(Account account)

Called immediately before a request is made to the Brightpearl API for the given account. Implementations may sleep before returning to reduce throughput, or throw an exception to abort the request.

Parameters:

account - The account a request will be sent to.

requestCompleted

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

Called after every request is made to the Brightpearl API, with values from the brightpearl-requests-remaining and brightpearl-next-throttle-period headers. These may be used to adjust the behaviour of the rateLimit(Account) method, but as other requests may have been made on other threads while this request was executing, the values may be stale, and events may be received out of sequence.

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

void requestCapExceeded(Account account)

Called when a request to an account has been rejected due to request throttling. This event may be used to adjust the behaviour of the the rateLimit(Account) method. Other concurrent requests that were already started at the time this event is received are likely to also fail.

Parameters:

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