Interface CircuitBreakerBuilder

public interface CircuitBreakerBuilder

A builder for CircuitBreaker.

Unlike CircuitBreaker.openHandler(Handler), CircuitBreaker.halfOpenHandler(Handler) and CircuitBreaker.closeHandler(Handler), the handlers configured through this builder are baked in as immutable when build() is called: calling the corresponding mutator method again on the built circuit breaker throws an IllegalStateException.

Method Summary

Modifier and Type	Method	Description
CircuitBreaker	build()	Build and return the circuit breaker.
CircuitBreakerBuilder	closeHandler(Handler<Void> handler)	Set the handler invoked when the circuit breaker state switches to closed.
<T> CircuitBreakerBuilder	failurePolicy(FailurePolicy<T> failurePolicy)	Set the failure policy, see CircuitBreaker.failurePolicy(FailurePolicy).
<T> CircuitBreakerBuilder	fallback(Function<Throwable, T> handler)	Set the default fallback function, see CircuitBreaker.fallback(Function).
CircuitBreakerBuilder	halfOpenHandler(Handler<Void> handler)	Set the handler invoked when the circuit breaker state switches to half-open.
CircuitBreakerBuilder	openHandler(Handler<Void> handler)	Set the handler invoked when the circuit breaker state switches to open.
CircuitBreakerBuilder	retryPolicy(RetryPolicy retryPolicy)	Set the retry policy, see CircuitBreaker.retryPolicy(RetryPolicy).
CircuitBreakerBuilder	with(CircuitBreakerOptions options)	Configure the circuit breaker options.

Method Details

with

CircuitBreakerBuilder with(CircuitBreakerOptions options)

Configure the circuit breaker options.

Parameters:

options - the configuration options

Returns:

a reference to this, so the API can be used fluently

openHandler

CircuitBreakerBuilder openHandler(Handler<Void> handler)

Set the handler invoked when the circuit breaker state switches to open.

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

halfOpenHandler

CircuitBreakerBuilder halfOpenHandler(Handler<Void> handler)

Set the handler invoked when the circuit breaker state switches to half-open.

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

closeHandler

CircuitBreakerBuilder closeHandler(Handler<Void> handler)

Set the handler invoked when the circuit breaker state switches to closed.

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

fallback

<T> CircuitBreakerBuilder fallback(Function<Throwable, T> handler)

Set the default fallback function, see CircuitBreaker.fallback(Function).

Parameters:

handler - the fallback function

Returns:

a reference to this, so the API can be used fluently

failurePolicy

<T> CircuitBreakerBuilder failurePolicy(FailurePolicy<T> failurePolicy)

Set the failure policy, see CircuitBreaker.failurePolicy(FailurePolicy).

Parameters:

failurePolicy - the failure policy

Returns:

a reference to this, so the API can be used fluently

retryPolicy

CircuitBreakerBuilder retryPolicy(RetryPolicy retryPolicy)

Set the retry policy, see CircuitBreaker.retryPolicy(RetryPolicy).

Parameters:

retryPolicy - the retry policy

Returns:

a reference to this, so the API can be used fluently

build

CircuitBreaker build()

Build and return the circuit breaker.

Returns:

the circuit breaker as configured by this builder