org.springframework.retry.policy

Class CircuitBreakerRetryPolicy

java.lang.Object

org.springframework.retry.policy.CircuitBreakerRetryPolicy

All Implemented Interfaces:

Serializable, RetryPolicy

public class CircuitBreakerRetryPolicy
extends Object
implements RetryPolicy

Author:

Dave Syer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CIRCUIT_OPEN
static String	CIRCUIT_SHORT_COUNT

Constructor Summary

Constructors

Constructor and Description
CircuitBreakerRetryPolicy()
CircuitBreakerRetryPolicy(RetryPolicy delegate)

Method Summary

Modifier and Type	Method and Description
boolean	canRetry(RetryContext context)
void	close(RetryContext context)
RetryContext	open(RetryContext parent) Acquire resources needed for the retry operation.
void	registerThrowable(RetryContext context, Throwable throwable) Called once per retry attempt, after the callback fails.
void	setOpenTimeout(long timeout) Timeout for tripping the open circuit.
void	setResetTimeout(long timeout) Timeout for resetting circuit in milliseconds.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CIRCUIT_OPEN

public static final String CIRCUIT_OPEN

See Also:

Constant Field Values

CIRCUIT_SHORT_COUNT

public static final String CIRCUIT_SHORT_COUNT

See Also:

Constant Field Values

Constructor Detail

CircuitBreakerRetryPolicy

public CircuitBreakerRetryPolicy()

CircuitBreakerRetryPolicy

public CircuitBreakerRetryPolicy(RetryPolicy delegate)

Method Detail

setResetTimeout

public void setResetTimeout(long timeout)

Timeout for resetting circuit in milliseconds. After the circuit opens it will re-close after this time has elapsed and the context will be restarted.

Parameters:

timeout - the timeout to set in milliseconds

setOpenTimeout

public void setOpenTimeout(long timeout)

Timeout for tripping the open circuit. If the delegate policy cannot retry and the time elapsed since the context was started is less than this window, then the circuit is opened.

Parameters:

timeout - the timeout to set in milliseconds

canRetry

public boolean canRetry(RetryContext context)

Specified by:

canRetry in interface RetryPolicy

Parameters:

context - the current retry status

Returns:

true if the operation can proceed

open

public RetryContext open(RetryContext parent)

Description copied from interface: RetryPolicy

Acquire resources needed for the retry operation. The callback is passed in so that marker interfaces can be used and a manager can collaborate with the callback to set up some state in the status token.

Specified by:

open in interface RetryPolicy

Parameters:

parent - the parent context if we are in a nested retry.

Returns:

a RetryContext object specific to this policy.

close

public void close(RetryContext context)

Specified by:

close in interface RetryPolicy

Parameters:

context - a retry status created by the RetryPolicy.open(RetryContext) method of this policy.

registerThrowable

public void registerThrowable(RetryContext context,
                              Throwable throwable)

Description copied from interface: RetryPolicy

Called once per retry attempt, after the callback fails.

Specified by:

registerThrowable in interface RetryPolicy

Parameters:

context - the current status object.

throwable - the exception to throw