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

Class BackOffException

java.lang.Object

java.lang.Throwable

java.lang.Exception

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

All Implemented Interfaces:

Serializable

public class BackOffException
extends Exception

Exception that is thrown when a AbstractBackOffStrategy has attempted to backOff() more than the AbstractBackOffStrategy was configured for.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BackOffException()
BackOffException(int attemptCount, long maxSleepTime)
BackOffException(String message)
BackOffException(String message, int attemptCount, long maxSleepTime) BackOffException constructor.

Method Summary

Modifier and Type	Method and Description
long	getLongestBackOff() Gets the longest sleep period that the strategy attempted.
int	getNumberOfBackOffsAttempted() Gets the number of back off attempts that happened before the exception was thrown.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BackOffException

public BackOffException()

BackOffException

public BackOffException(String message)

BackOffException

public BackOffException(int attemptCount,
                        long maxSleepTime)

BackOffException

public BackOffException(String message,
                        int attemptCount,
                        long maxSleepTime)

BackOffException constructor.

Parameters:

message - message

attemptCount - attemptCount

maxSleepTime - maxSleepTime (in millis)

Method Detail

getNumberOfBackOffsAttempted

public int getNumberOfBackOffsAttempted()

Gets the number of back off attempts that happened before the exception was thrown. If the function that initialized this exception does not set the number of attempts, -1 will be returned.

Returns:

number of back off attempts

getLongestBackOff

public long getLongestBackOff()

Gets the longest sleep period that the strategy attempted. If the function that initialized this exception does not set the longest sleep period, -1 will be returned.

Returns:

longest sleep period that the strategy attempted