org.springframework.retry.annotation

Annotation Type CircuitBreaker

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

Annotation for a method invocation that is retryable.

Since:

1.2

Author:

Dave Syer, Artem Bilan, Gary Russell

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
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	label A unique label for the circuit for reporting and state management.
int	maxAttempts
String	maxAttemptsExpression
long	openTimeout When maxAttempts() failures are reached within this timeout, the circuit is opened automatically, preventing access to the downstream component.
String	openTimeoutExpression When maxAttempts() failures are reached within this timeout, the circuit is opened automatically, preventing access to the downstream component.
long	resetTimeout If the circuit is open for longer than this timeout then it resets on the next call to give the downstream component a chance to respond again.
String	resetTimeoutExpression If the circuit is open for longer than this timeout then it resets on the next call to give the downstream component a chance to respond again.
Class<? extends Throwable>[]	value Exception types that are retryable.

Element Detail

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:

{}

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.3

Default:

""

label

public abstract String label

A unique label for the circuit for reporting and state management. Defaults to the method signature where the annotation is declared.

Returns:

the label for the circuit

Default:

""

resetTimeout

public abstract long resetTimeout

If the circuit is open for longer than this timeout then it resets on the next call to give the downstream component a chance to respond again.

Returns:

the timeout before an open circuit is reset in milliseconds, defaults to 20000

Default:

20000L

resetTimeoutExpression

public abstract String resetTimeoutExpression

If the circuit is open for longer than this timeout then it resets on the next call to give the downstream component a chance to respond again. Overrides resetTimeout().

Returns:

the timeout before an open circuit is reset in milliseconds, no default.

Since:

1.2.3

Default:

""

openTimeout

public abstract long openTimeout

When maxAttempts() failures are reached within this timeout, the circuit is opened automatically, preventing access to the downstream component.

Returns:

the timeout before an closed circuit is opened in milliseconds, defaults to 5000

Default:

5000L

openTimeoutExpression

public abstract String openTimeoutExpression

When maxAttempts() failures are reached within this timeout, the circuit is opened automatically, preventing access to the downstream component. Overrides openTimeout().

Returns:

the timeout before an closed circuit is opened in milliseconds, no default.

Since:

1.2.3

Default:

""

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.3

Default:

""