org.rnorth.ducttape.circuitbreakers

Class BreakerBuilder

java.lang.Object

org.rnorth.ducttape.circuitbreakers.BreakerBuilder

public class BreakerBuilder
extends Object

BreakerBuilder A builder of Breaker instances having any combination of the following features:

• automatic reset after a configured period of time has passed since the last failure
• configurable state storage, for example for use with a distributed map implementation

These features are optional; by default instances will be created with none of them.

Author:

richardnorth

Method Summary

Modifier and Type	Method and Description
BreakerBuilder	autoResetAfter(long autoResetInterval, @NotNull TimeUnit autoResetUnit) Configure the breaker to automatically reset a given time after a failure has occurred.
Breaker	build()
static BreakerBuilder	newBuilder()
BreakerBuilder	storeStateIn(@NotNull ConcurrentMap<String,Object> map, @NotNull String keyPrefix) Configure the breaker to use the provided Map to store its state.
BreakerBuilder	storeStateIn(@NotNull StateStore stateStore) Configure the breaker to use the provided StateStore to store its state.
BreakerBuilder	timeSource(@NotNull org.rnorth.ducttape.circuitbreakers.TimeSource timeSource) Use a TimeSource instance to track time elapsed since last failure.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static BreakerBuilder newBuilder()

Returns:

a new `BreakerBuilder` instance.

build

public Breaker build()

Returns:

a Breaker instance configured using settings passed in to this `BreakerBuilder`

timeSource

public BreakerBuilder timeSource(@NotNull
                                 @NotNull org.rnorth.ducttape.circuitbreakers.TimeSource timeSource)

Use a TimeSource instance to track time elapsed since last failure. Mainly intended for use in testing.

Parameters:

timeSource - a time source instance to track time elapsed since last failure.

Returns:

this

autoResetAfter

public BreakerBuilder autoResetAfter(long autoResetInterval,
                                     @NotNull
                                     @NotNull TimeUnit autoResetUnit)

Configure the breaker to automatically reset a given time after a failure has occurred. Use this for unattended retry behaviour. If this method is not used, the default is for the breaker to wait `Long.MAX_VALUE` days before it resets automatically, i.e. effectively forever.

Parameters:

autoResetInterval - the interval length

autoResetUnit - the units of the interval

Returns:

this

storeStateIn

public BreakerBuilder storeStateIn(@NotNull
                                   @NotNull ConcurrentMap<String,Object> map,
                                   @NotNull
                                   @NotNull String keyPrefix)

Configure the breaker to use the provided Map to store its state. The

keyPrefix

is used to uniquely identify the breaker's entries in the map.

keyPrefix

should be unique; behaviour is undefined if it is not. Additionally, behaviour is undefined if entries are directly modified.

Parameters:

map - the map to use for storage

keyPrefix - a unique prefix for the +Breaker+'s entries in the map

Returns:

this

storeStateIn

public BreakerBuilder storeStateIn(@NotNull
                                   @NotNull StateStore stateStore)

Configure the breaker to use the provided StateStore to store its state.

Parameters:

stateStore - an instance of StateStore to store state in

Returns:

this