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

Class AbstractBackOffStrategy

java.lang.Object

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

All Implemented Interfaces:

BackOffStrategy

Direct Known Subclasses:

ConstantTimeBackOffStrategy, ExponentialBackOffStrategy, LinearTimeBackOffStrategy

public abstract class AbstractBackOffStrategy
extends Object
implements BackOffStrategy

See Also:

BackOffStrategy

Constructor Summary

Constructors

Constructor and Description
AbstractBackOffStrategy(long baseBackOffTime) A BackOffStrategy that can effectively be used endlessly.
AbstractBackOffStrategy(long baseBackOffTime, int maximumNumberOfBackOffAttempts) A BackOffStrategy that has a limited number of uses before it throws a BackOffException.

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.
protected abstract long	calculateBackOffTime(int attemptCount, long baseSleepTime) Calculate the amount of time in milliseconds that the strategy should back off for
void	reset() Rests the back off strategy to its original state.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBackOffStrategy

public AbstractBackOffStrategy(long baseBackOffTime)

A BackOffStrategy that can effectively be used endlessly.

Parameters:

baseBackOffTime - amount of time back of in seconds

AbstractBackOffStrategy

public AbstractBackOffStrategy(long baseBackOffTime,
                               int maximumNumberOfBackOffAttempts)

A BackOffStrategy that has a limited number of uses before it throws a BackOffException.

Parameters:

baseBackOffTime - time to back off in milliseconds, must be greater than 0.

maximumNumberOfBackOffAttempts - maximum number of attempts, must be grater than 0 or -1. -1 indicates there is no maximum number of attempts.

Method Detail

backOff

public void backOff()
             throws BackOffException

Description copied from interface: BackOffStrategy

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.

Specified by:

backOff in interface BackOffStrategy

Throws:

BackOffException - BackOffException

reset

public void reset()

Description copied from interface: BackOffStrategy

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

Specified by:

reset in interface BackOffStrategy

calculateBackOffTime

protected abstract long calculateBackOffTime(int attemptCount,
                                             long baseSleepTime)

Calculate the amount of time in milliseconds that the strategy should back off for

Parameters:

attemptCount - the number of attempts the strategy has backed off. i.e. 1 -> this is the first attempt, 2 -> this is the second attempt, etc.

baseSleepTime - the minimum amount of time it should back off for in milliseconds

Returns:

the amount of time it should back off in milliseconds