org.apache.streams.util.api.requests.backoff

Interface BackOffStrategy

All Known Implementing Classes:

AbstractBackOffStrategy, ConstantTimeBackOffStrategy, ExponentialBackOffStrategy, LinearTimeBackOffStrategy

public interface BackOffStrategy

BackOffStrategy will cause the current thread to sleep for a specific amount of time. This is used to adhere to api rate limits.

The example below illustrates using a BackOffStrategy to slow down requests when you hit a rate limit exception. public void pollApi(ApiClient apiClient, BackOffStrategy backOffStrategy) throws BackOffException { while( apiClient.hasMoreData() ) { try { apiClient.pollData(); } catch (RateLimitException rle) { backOffStrategy.backOff(); } } }

Method Summary

Modifier and Type	Method and Description
void	backOff() Cause the current thread to sleep for an amount of time based on the implemented strategy.
void	reset() Rests the back off strategy to its original state.

Method Detail

backOff

void backOff()
      throws BackOffException

Cause the current thread to sleep for an amount of time based on the implemented strategy. If limits are set on the number of times the backOff can be called, an exception will be thrown.

Throws:

BackOffException - BackOffException

reset

void reset()

Rests the back off strategy to its original state. After the call the strategy will act as if AbstractBackOffStrategy.backOff() has never been called.