com.peterphi.std.guice.common.retry.annotation

Annotation Type Retry

@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface Retry

When annotated on a public/protected/package-private method in a Guice-constructed object this annotation will automatically retry if that method throws an exception

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
double	backoffExponent The amount to multiply backoff time by for each failure
long	backoffTime the backoff wait amount
java.util.concurrent.TimeUnit	backoffUnit The backoff wait unit
java.lang.Class<? extends java.lang.Throwable>[]	exceptOn The exception types which, if thrown, will bypass retry logic altogether
java.lang.Class<? extends java.lang.Throwable>[]	exceptOnCore The core exception types which, if thrown, will bypass retry logic altogether. These are set to sensible defaults for regular Java code (Errors, IllegalArgumentExceptions and NullPointerExceptions)
int	maxAttempts The maximum number of attempts before the exception is thrown as normal
java.lang.Class<? extends java.lang.Throwable>[]	on The exception types which, if thrown, will cause retry.

Element Detail

backoffTime

public abstract long backoffTime

the backoff wait amount

Returns:

Default:

1000L

backoffUnit

public abstract java.util.concurrent.TimeUnit backoffUnit

The backoff wait unit

Returns:

Default:

java.util.concurrent.TimeUnit.MILLISECONDS

backoffExponent

public abstract double backoffExponent

The amount to multiply backoff time by for each failure

Returns:

Default:

2.0

maxAttempts

public abstract int maxAttempts

The maximum number of attempts before the exception is thrown as normal

Returns:

Default:

3

on

public abstract java.lang.Class<? extends java.lang.Throwable>[] on

The exception types which, if thrown, will cause retry. Exceptions specified in this list will bypass any exceptions listed in exceptOn or exceptOnCore

Returns:

Default:

{}

exceptOn

public abstract java.lang.Class<? extends java.lang.Throwable>[] exceptOn

The exception types which, if thrown, will bypass retry logic altogether

Returns:

Default:

{}

exceptOnCore

public abstract java.lang.Class<? extends java.lang.Throwable>[] exceptOnCore

The core exception types which, if thrown, will bypass retry logic altogether.
These are set to sensible defaults for regular Java code (Errors, IllegalArgumentExceptions and NullPointerExceptions)

Returns:

Default:

{java.lang.Error.class, java.lang.IllegalArgumentException.class, java.lang.NullPointerException.class}