Package org.apache.camel.util.backoff

Class BackOffTimerTask

java.lang.Object

org.apache.camel.util.backoff.BackOffTimerTask

All Implemented Interfaces:

Runnable, BackOffTimer.Task

public final class BackOffTimerTask
extends Object
implements BackOffTimer.Task, Runnable

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.camel.util.backoff.BackOffTimer.Task

BackOffTimer.Task.Status

Constructor Summary

Constructors

Constructor	Description
BackOffTimerTask(BackOffTimer timer, BackOff backOff, ScheduledExecutorService scheduler, ThrowingFunction<BackOffTimer.Task,Boolean,Exception> function)

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancel the task.
BackOff	getBackOff()	The back-off associated with this task.
long	getCurrentAttempts()	The number of attempts so far.
long	getCurrentDelay()	The current computed delay.
long	getCurrentElapsedTime()	The current elapsed time.
Throwable	getException()	The task failed for some un-expected exception
long	getFirstAttemptTime()	The time the first attempt was performed.
long	getLastAttemptTime()	The time the last attempt has been performed.
String	getName()	Name of this task
long	getNextAttemptTime()	An indication about the time the next attempt will be made.
BackOffTimer.Task.Status	getStatus()	Gets the task status.
long	next()	Return the number of milliseconds to wait before retrying the operation or $BackOff.NEVER to indicate that no further attempt should be made.
void	reset()	Reset the task.
void	run()
String	toString()
void	whenComplete(BiConsumer<BackOffTimer.Task,Throwable> whenCompleted)	Action to execute when the context is completed (cancelled or exhausted)

Methods inherited from class java.lang.Object

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

Constructor Details

BackOffTimerTask

public BackOffTimerTask(BackOffTimer timer,
 BackOff backOff,
 ScheduledExecutorService scheduler,
 ThrowingFunction<BackOffTimer.Task,Boolean,Exception> function)

Method Details

getName

public String getName()

Description copied from interface: BackOffTimer.Task

Name of this task

Specified by:

getName in interface BackOffTimer.Task

getBackOff

public BackOff getBackOff()

Description copied from interface: BackOffTimer.Task

The back-off associated with this task.

Specified by:

getBackOff in interface BackOffTimer.Task

getStatus

public BackOffTimer.Task.Status getStatus()

Description copied from interface: BackOffTimer.Task

Gets the task status.

Specified by:

getStatus in interface BackOffTimer.Task

getCurrentAttempts

public long getCurrentAttempts()

Description copied from interface: BackOffTimer.Task

The number of attempts so far.

Specified by:

getCurrentAttempts in interface BackOffTimer.Task

getCurrentDelay

public long getCurrentDelay()

Description copied from interface: BackOffTimer.Task

The current computed delay.

Specified by:

getCurrentDelay in interface BackOffTimer.Task

getCurrentElapsedTime

public long getCurrentElapsedTime()

Description copied from interface: BackOffTimer.Task

The current elapsed time.

Specified by:

getCurrentElapsedTime in interface BackOffTimer.Task

getFirstAttemptTime

public long getFirstAttemptTime()

Description copied from interface: BackOffTimer.Task

The time the first attempt was performed.

Specified by:

getFirstAttemptTime in interface BackOffTimer.Task

getLastAttemptTime

public long getLastAttemptTime()

Description copied from interface: BackOffTimer.Task

The time the last attempt has been performed.

Specified by:

getLastAttemptTime in interface BackOffTimer.Task

getNextAttemptTime

public long getNextAttemptTime()

Description copied from interface: BackOffTimer.Task

An indication about the time the next attempt will be made.

Specified by:

getNextAttemptTime in interface BackOffTimer.Task

getException

public Throwable getException()

Description copied from interface: BackOffTimer.Task

The task failed for some un-expected exception

Specified by:

getException in interface BackOffTimer.Task

reset

public void reset()

Description copied from interface: BackOffTimer.Task

Reset the task.

Specified by:

reset in interface BackOffTimer.Task

cancel

public void cancel()

Description copied from interface: BackOffTimer.Task

Cancel the task.

Specified by:

cancel in interface BackOffTimer.Task

whenComplete

public void whenComplete(BiConsumer<BackOffTimer.Task,Throwable> whenCompleted)

Description copied from interface: BackOffTimer.Task

Action to execute when the context is completed (cancelled or exhausted)

Specified by:

whenComplete in interface BackOffTimer.Task

Parameters:

whenCompleted - the consumer.

run

public void run()

Specified by:

run in interface Runnable

next

public long next()

Return the number of milliseconds to wait before retrying the operation or $BackOff.NEVER to indicate that no further attempt should be made.

toString

public String toString()

Overrides:

toString in class Object