Package io.github.resilience4j.circuitbreaker.configure

Class CircuitBreakerConfiguration

java.lang.Object

io.github.resilience4j.circuitbreaker.configure.CircuitBreakerConfiguration

@Configuration
@Import({FallbackConfiguration.class,SpelResolverConfiguration.class})
public class CircuitBreakerConfiguration
extends Object

Configuration for resilience4j-circuitbreaker.

Constructor Summary

Constructors

Constructor	Description
CircuitBreakerConfiguration(CircuitBreakerConfigurationProperties circuitBreakerProperties)

Method Summary

Modifier and Type	Method	Description
CircuitBreakerAspect	circuitBreakerAspect(io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry, List<CircuitBreakerAspectExt> circuitBreakerAspectExtList, FallbackExecutor fallbackExecutor, SpelResolver spelResolver)
io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry	circuitBreakerRegistry(io.github.resilience4j.consumer.EventConsumerRegistry<io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent> eventConsumerRegistry, io.github.resilience4j.core.registry.RegistryEventConsumer<io.github.resilience4j.circuitbreaker.CircuitBreaker> circuitBreakerRegistryEventConsumer, io.github.resilience4j.common.CompositeCustomizer<io.github.resilience4j.common.circuitbreaker.configuration.CircuitBreakerConfigCustomizer> compositeCircuitBreakerCustomizer)
io.github.resilience4j.core.registry.RegistryEventConsumer<io.github.resilience4j.circuitbreaker.CircuitBreaker>	circuitBreakerRegistryEventConsumer(Optional<List<io.github.resilience4j.core.registry.RegistryEventConsumer<io.github.resilience4j.circuitbreaker.CircuitBreaker>>> optionalRegistryEventConsumers)
io.github.resilience4j.common.CompositeCustomizer<io.github.resilience4j.common.circuitbreaker.configuration.CircuitBreakerConfigCustomizer>	compositeCircuitBreakerCustomizer(List<io.github.resilience4j.common.circuitbreaker.configuration.CircuitBreakerConfigCustomizer> customizers)
io.github.resilience4j.consumer.EventConsumerRegistry<io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent>	eventConsumerRegistry()	The EventConsumerRegistry is used to manage EventConsumer instances.
ReactorCircuitBreakerAspectExt	reactorCircuitBreakerAspect()
void	registerEventConsumer(io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry, io.github.resilience4j.consumer.EventConsumerRegistry<io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent> eventConsumerRegistry)	Registers the post creation consumer function that registers the consumer events to the circuit breakers.
RxJava2CircuitBreakerAspectExt	rxJava2CircuitBreakerAspect()

Methods inherited from class java.lang.Object

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

Constructor Details

CircuitBreakerConfiguration

public CircuitBreakerConfiguration(CircuitBreakerConfigurationProperties circuitBreakerProperties)

Method Details

compositeCircuitBreakerCustomizer

@Bean
@Qualifier("compositeCircuitBreakerCustomizer")
public io.github.resilience4j.common.CompositeCustomizer<io.github.resilience4j.common.circuitbreaker.configuration.CircuitBreakerConfigCustomizer> compositeCircuitBreakerCustomizer(@Autowired(required=false)
 List<io.github.resilience4j.common.circuitbreaker.configuration.CircuitBreakerConfigCustomizer> customizers)

circuitBreakerRegistry

@Bean
public io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry(io.github.resilience4j.consumer.EventConsumerRegistry<io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent> eventConsumerRegistry,
 io.github.resilience4j.core.registry.RegistryEventConsumer<io.github.resilience4j.circuitbreaker.CircuitBreaker> circuitBreakerRegistryEventConsumer,
 @Qualifier("compositeCircuitBreakerCustomizer")
 io.github.resilience4j.common.CompositeCustomizer<io.github.resilience4j.common.circuitbreaker.configuration.CircuitBreakerConfigCustomizer> compositeCircuitBreakerCustomizer)

circuitBreakerRegistryEventConsumer

@Bean
@Primary
public io.github.resilience4j.core.registry.RegistryEventConsumer<io.github.resilience4j.circuitbreaker.CircuitBreaker> circuitBreakerRegistryEventConsumer(Optional<List<io.github.resilience4j.core.registry.RegistryEventConsumer<io.github.resilience4j.circuitbreaker.CircuitBreaker>>> optionalRegistryEventConsumers)

circuitBreakerAspect

@Bean
@Conditional(AspectJOnClasspathCondition.class)
public CircuitBreakerAspect circuitBreakerAspect(io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry,
 @Autowired(required=false)
 List<CircuitBreakerAspectExt> circuitBreakerAspectExtList,
 FallbackExecutor fallbackExecutor,
 SpelResolver spelResolver)

rxJava2CircuitBreakerAspect

@Bean
@Conditional({RxJava2OnClasspathCondition.class,AspectJOnClasspathCondition.class})
public RxJava2CircuitBreakerAspectExt rxJava2CircuitBreakerAspect()

reactorCircuitBreakerAspect

@Bean
@Conditional({ReactorOnClasspathCondition.class,AspectJOnClasspathCondition.class})
public ReactorCircuitBreakerAspectExt reactorCircuitBreakerAspect()

eventConsumerRegistry

@Bean
public io.github.resilience4j.consumer.EventConsumerRegistry<io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent> eventConsumerRegistry()

The EventConsumerRegistry is used to manage EventConsumer instances. The EventConsumerRegistry is used by the CircuitBreakerHealthIndicator to show the latest CircuitBreakerEvents events for each CircuitBreaker instance.

Returns:

a default EventConsumerRegistry DefaultEventConsumerRegistry

registerEventConsumer

public void registerEventConsumer(io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry,
 io.github.resilience4j.consumer.EventConsumerRegistry<io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent> eventConsumerRegistry)

Registers the post creation consumer function that registers the consumer events to the circuit breakers.

Parameters:

circuitBreakerRegistry - The circuit breaker registry.

eventConsumerRegistry - The event consumer registry.