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

Class ConstantTimeBackOffStrategy

java.lang.Object

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

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

All Implemented Interfaces:

BackOffStrategy

public class ConstantTimeBackOffStrategy
extends AbstractBackOffStrategy

A AbstractBackOffStrategy that causes the current thread to sleep the same amount of time each time backOff() is called.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected long	calculateBackOffTime(int attemptCount, long baseSleepTime) Calculate the amount of time in milliseconds that the strategy should back off for

Methods inherited from class org.apache.streams.util.api.requests.backoff.AbstractBackOffStrategy

backOff, reset

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstantTimeBackOffStrategy

public ConstantTimeBackOffStrategy(long baseBackOffTimeInMiliseconds)

A ConstantTimeBackOffStrategy that can effectively be used endlessly.

Parameters:

baseBackOffTimeInMiliseconds - amount of time back of in milliseconds

ConstantTimeBackOffStrategy

public ConstantTimeBackOffStrategy(long baseBackOffTimeInMiliseconds,
                                   int maximumNumberOfBackOffAttempts)

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

Parameters:

baseBackOffTimeInMiliseconds - 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

calculateBackOffTime

protected long calculateBackOffTime(int attemptCount,
                                    long baseSleepTime)

Description copied from class: AbstractBackOffStrategy

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

Specified by:

calculateBackOffTime in class AbstractBackOffStrategy

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