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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
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
long	openTimeout 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.
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).

Returns:

exception types to retry

Default:

{}

maxAttempts

public abstract int maxAttempts

Returns:

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

Default:

3

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

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