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, Gary Russell, Maksim Kita

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Backoff	backoff Specify the backoff properties for retrying this operation.
String	exceptionExpression Specify an expression to be evaluated after the SimpleRetryPolicy.canRetry() returns true - can be used to conditionally suppress the retry.
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.
String	label A unique label for statistics reporting.
String[]	listeners Bean names of retry listeners to use instead of default ones defined in Spring context
int	maxAttempts
String	maxAttemptsExpression
String	recover Name of method in this class to use for recover.
boolean	stateful Flag to say that the retry is stateful: i.e.
Class<? extends Throwable>[]	value Exception types that are retryable.

Element Detail

recover

public abstract String recover

Name of method in this class to use for recover. Method had to be marked with Recover annotation.

Returns:

the name of recover method

Default:

""

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). If includes is empty but excludes is not, all not excluded exceptions are retried

Returns:

exception types not to retry

Default:

{}

label

public abstract String label

A unique label for statistics reporting. If not provided the caller may choose to ignore it, or provide a default.

Returns:

the label for the statistics

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

maxAttemptsExpression

public abstract String maxAttemptsExpression

Returns:

an expression evaluated to the maximum number of attempts (including the first failure), defaults to 3 Overrides maxAttempts().

Since:

1.2

Default:

""

backoff

public abstract Backoff backoff

Specify the backoff properties for retrying this operation. The default is a simple Backoff specification with no properties - see its documentation for defaults.

Returns:

a backoff specification

Default:

@org.springframework.retry.annotation.Backoff

exceptionExpression

public abstract String exceptionExpression

Specify an expression to be evaluated after the SimpleRetryPolicy.canRetry() returns true - can be used to conditionally suppress the retry. Only invoked after an exception is thrown. The root object for the evaluation is the last Throwable. Other beans in the context can be referenced. For example:

  "message.contains('you can retry this')".
 

and

  "@someBean.shouldRetry(#root)".
 

Returns:

the expression.

Since:

1.2

Default:

""

listeners

public abstract String[] listeners

Bean names of retry listeners to use instead of default ones defined in Spring context

Returns:

retry listeners bean names

Default:

{}