org.springframework.retry.annotation

Annotation Type Retryable

@Target(value={METHOD,TYPE})
@Retention(value=RUNTIME)
@Documented
public @interface Retryable

Annotation for a method invocation that is retryable.

Since:

1.1

Author:

Dave Syer, Artem Bilan

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Backoff	backoff Specify the backoff properties for retrying this operation.
Class<? extends Throwable>[]	exclude Exception types that are not retryable.
Class<? extends Throwable>[]	include Exception types that are retryable.
String	interceptor Retry interceptor bean name to be applied for retryable method.
int	maxAttempts
boolean	stateful Flag to say that the retry is stateful: i.e.
Class<? extends Throwable>[]	value Exception types that are retryable.

Element Detail

interceptor

public abstract String interceptor

Retry interceptor bean name to be applied for retryable method. Is mutually exclusive with other attributes.

Returns:

the retry interceptor bean name

Default:

""

value

public abstract Class<? extends Throwable>[] value

Exception types that are retryable. Synonym for includes(). Defaults to empty (and if excludes is also empty all exceptions are retried).

Returns:

exception types to retry

Default:

{}

include

public abstract Class<? extends Throwable>[] include

Exception types that are retryable. Defaults to empty (and if excludes is also empty all exceptions are retried).

Returns:

exception types to retry

Default:

{}

exclude

public abstract Class<? extends Throwable>[] exclude

Exception types that are not retryable. Defaults to empty (and if includes is also empty all exceptions are retried).

Returns:

exception types to retry

Default:

{}

stateful

public abstract boolean stateful

Flag to say that the retry is stateful: i.e. exceptions are re-thrown, but the retry policy is applied with the same policy to subsequent invocations with the same arguments. If false then retryable exceptions are not re-thrown.

Returns:

true if retry is stateful, default false

Default:

false

maxAttempts

public abstract int maxAttempts

Returns:

the maximum number of attempts (including the first failure), defaults to 3

Default:

3

backoff

public abstract Backoff backoff

Specify the backoff properties for retrying this operation. The default is no backoff, but it can be a good idea to pause between attempts (even at the cost of blocking a thread).

Returns:

a backoff specification

Default:

@org.springframework.retry.annotation.Backoff