Top Description Fields Constructors Methods
io.github.resilience4j.circuitbreaker.internal

public final Class InMemoryCircuitBreakerRegistry

extends AbstractRegistry<CircuitBreaker, CircuitBreakerConfig>
implements CircuitBreakerRegistry
Class Inheritance
All Implemented Interfaces
io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry, io.github.resilience4j.core.Registry
Imports
io.github.resilience4j.circuitbreaker.CircuitBreaker, .CircuitBreakerConfig, .CircuitBreakerRegistry, io.github.resilience4j.core.ConfigurationNotFoundException, .RegistryStore, io.github.resilience4j.core.registry.AbstractRegistry, .InMemoryRegistryStore, .RegistryEventConsumer, java.util.*, java.util.function.Supplier
Backend circuitBreaker manager. Constructs backend circuitBreakers according to configuration values.

Field Summary

Inherited from io.github.resilience4j.core.registry.AbstractRegistry:
CONFIG_MUST_NOT_BE_NULLconfigurationsCONSUMER_MUST_NOT_BE_NULLDEFAULT_CONFIGentryMapregistryTagsSUPPLIER_MUST_NOT_BE_NULLTAGS_MUST_NOT_BE_NULL

Constructor Summary

AccessConstructor and Description
public
InMemoryCircuitBreakerRegistry()

The constructor with default default.

public
InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig> configs)

public
InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig> configs, Map<String, String> tags)

public
InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig> configs, RegistryEventConsumer<CircuitBreaker> registryEventConsumer)

public
InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig> configs, RegistryEventConsumer<CircuitBreaker> registryEventConsumer, Map<String, String> tags)

public
InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig> configs, List<RegistryEventConsumer<CircuitBreaker>> registryEventConsumers, Map<String, String> tags, RegistryStore<CircuitBreaker> registryStore)

public
InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig> configs, List<RegistryEventConsumer<CircuitBreaker>> registryEventConsumers)

public
InMemoryCircuitBreakerRegistry(CircuitBreakerConfig
The default config.
defaultConfig)

The constructor with custom default config.

public
InMemoryCircuitBreakerRegistry(CircuitBreakerConfig
The default config.
defaultConfig, Map<String, String>
The tags to add to the CircuitBreaker
tags)

The constructor with custom default config.

public
InMemoryCircuitBreakerRegistry(CircuitBreakerConfig defaultConfig, RegistryEventConsumer<CircuitBreaker> registryEventConsumer)

public
InMemoryCircuitBreakerRegistry(CircuitBreakerConfig defaultConfig, RegistryEventConsumer<CircuitBreaker> registryEventConsumer, Map<String, String> tags)

public
InMemoryCircuitBreakerRegistry(CircuitBreakerConfig defaultConfig, List<RegistryEventConsumer<CircuitBreaker>> registryEventConsumers)

Method Summary

Modifier and TypeMethod and Description
public CircuitBreaker
circuitBreaker(String
the name of the CircuitBreaker
name)

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Returns a managed CircuitBreaker or creates a new one with the default CircuitBreaker configuration.

public CircuitBreaker
circuitBreaker(String
the name of the CircuitBreaker
name, Map<String, String>
tags added to the CircuitBreaker
tags)

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Returns a managed CircuitBreaker or creates a new one with the default CircuitBreaker configuration.

public CircuitBreaker
circuitBreaker(String
the name of the CircuitBreaker
name, CircuitBreakerConfig
a custom CircuitBreaker configuration
config)

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.

public CircuitBreaker
circuitBreaker(String
the name of the CircuitBreaker
name, CircuitBreakerConfig
a custom CircuitBreaker configuration
config, Map<String, String>
tags added to the CircuitBreaker
tags)

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.

public CircuitBreaker
circuitBreaker(String
the name of the CircuitBreaker
name, String
the name of the shared configuration
configName)

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Returns a managed CircuitBreaker or creates a new one.

public CircuitBreaker
circuitBreaker(String
the name of the CircuitBreaker
name, String
the name of the shared configuration
configName, Map<String, String>
tags added to the CircuitBreaker
tags)

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Returns a managed CircuitBreaker or creates a new one.

public CircuitBreaker
circuitBreaker(String
the name of the CircuitBreaker
name, Supplier<CircuitBreakerConfig>
a supplier of a custom CircuitBreaker configuration
circuitBreakerConfigSupplier)

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.

public CircuitBreaker
circuitBreaker(String
the name of the CircuitBreaker
name, Supplier<CircuitBreakerConfig>
a supplier of a custom CircuitBreaker configuration
circuitBreakerConfigSupplier, Map<String, String>
tags added to the CircuitBreaker
tags)

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.

public Set<CircuitBreaker>
getAllCircuitBreakers()

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.getAllCircuitBreakers.

Returns all managed CircuitBreaker instances.

Inherited from io.github.resilience4j.core.registry.AbstractRegistry:
addConfigurationcomputeIfAbsentfindgetAllTagsgetConfigurationgetDefaultConfiggetEventPublishergetTagsremoveremoveConfigurationreplace

Constructor Detail

InMemoryCircuitBreakerRegistryback to summary
public InMemoryCircuitBreakerRegistry()

The constructor with default default.

InMemoryCircuitBreakerRegistryback to summary
public InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig> configs)
InMemoryCircuitBreakerRegistryback to summary
public InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig> configs, Map<String, String> tags)
InMemoryCircuitBreakerRegistryback to summary
public InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig> configs, RegistryEventConsumer<CircuitBreaker> registryEventConsumer)
InMemoryCircuitBreakerRegistryback to summary
public InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig> configs, RegistryEventConsumer<CircuitBreaker> registryEventConsumer, Map<String, String> tags)
InMemoryCircuitBreakerRegistryback to summary
public InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig> configs, List<RegistryEventConsumer<CircuitBreaker>> registryEventConsumers, Map<String, String> tags, RegistryStore<CircuitBreaker> registryStore)
InMemoryCircuitBreakerRegistryback to summary
public InMemoryCircuitBreakerRegistry(Map<String, CircuitBreakerConfig> configs, List<RegistryEventConsumer<CircuitBreaker>> registryEventConsumers)
InMemoryCircuitBreakerRegistryback to summary
public InMemoryCircuitBreakerRegistry(CircuitBreakerConfig defaultConfig)

The constructor with custom default config.

Parameters
defaultConfig:CircuitBreakerConfig

The default config.

InMemoryCircuitBreakerRegistryback to summary
public InMemoryCircuitBreakerRegistry(CircuitBreakerConfig defaultConfig, Map<String, String> tags)

The constructor with custom default config.

Parameters
defaultConfig:CircuitBreakerConfig

The default config.

tags:Map<String, String>

The tags to add to the CircuitBreaker

InMemoryCircuitBreakerRegistryback to summary
public InMemoryCircuitBreakerRegistry(CircuitBreakerConfig defaultConfig, RegistryEventConsumer<CircuitBreaker> registryEventConsumer)
InMemoryCircuitBreakerRegistryback to summary
public InMemoryCircuitBreakerRegistry(CircuitBreakerConfig defaultConfig, RegistryEventConsumer<CircuitBreaker> registryEventConsumer, Map<String, String> tags)
InMemoryCircuitBreakerRegistryback to summary
public InMemoryCircuitBreakerRegistry(CircuitBreakerConfig defaultConfig, List<RegistryEventConsumer<CircuitBreaker>> registryEventConsumers)

Method Detail

circuitBreakerback to summary
public CircuitBreaker circuitBreaker(String name)

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Returns a managed CircuitBreaker or creates a new one with the default CircuitBreaker configuration.

Parameters
name:String

the name of the CircuitBreaker

Returns:CircuitBreaker

The CircuitBreaker

Annotations
@Override
circuitBreakerback to summary
public CircuitBreaker circuitBreaker(String name, Map<String, String> tags)

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Returns a managed CircuitBreaker or creates a new one with the default CircuitBreaker configuration.

The tags passed will be appended to the tags already configured for the registry. When tags (keys) of the two collide the tags passed with this method will override the tags of the registry.

Parameters
name:String

the name of the CircuitBreaker

tags:Map<String, String>

tags added to the CircuitBreaker

Returns:CircuitBreaker

The CircuitBreaker

Annotations
@Override
circuitBreakerback to summary
public CircuitBreaker circuitBreaker(String name, CircuitBreakerConfig config)

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.

Parameters
name:String

the name of the CircuitBreaker

config:CircuitBreakerConfig

a custom CircuitBreaker configuration

Returns:CircuitBreaker

The CircuitBreaker

Annotations
@Override
circuitBreakerback to summary
public CircuitBreaker circuitBreaker(String name, CircuitBreakerConfig config, Map<String, String> tags)

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.

The tags passed will be appended to the tags already configured for the registry. When tags (keys) of the two collide the tags passed with this method will override the tags of the registry.

Parameters
name:String

the name of the CircuitBreaker

config:CircuitBreakerConfig

a custom CircuitBreaker configuration

tags:Map<String, String>

tags added to the CircuitBreaker

Returns:CircuitBreaker

The CircuitBreaker

Annotations
@Override
circuitBreakerback to summary
public CircuitBreaker circuitBreaker(String name, String configName)

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Returns a managed CircuitBreaker or creates a new one. The configuration must have been added upfront via addConfiguration(String, Object).

Parameters
name:String

the name of the CircuitBreaker

configName:String

the name of the shared configuration

Returns:CircuitBreaker

The CircuitBreaker

Annotations
@Override
circuitBreakerback to summary
public CircuitBreaker circuitBreaker(String name, String configName, Map<String, String> tags)

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Returns a managed CircuitBreaker or creates a new one. The configuration must have been added upfront via addConfiguration(String, Object).

The tags passed will be appended to the tags already configured for the registry. When tags (keys) of the two collide the tags passed with this method will override the tags of the registry.

Parameters
name:String

the name of the CircuitBreaker

configName:String

the name of the shared configuration

tags:Map<String, String>

tags added to the CircuitBreaker

Returns:CircuitBreaker

The CircuitBreaker

Annotations
@Override
circuitBreakerback to summary
public CircuitBreaker circuitBreaker(String name, Supplier<CircuitBreakerConfig> circuitBreakerConfigSupplier)

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.

Parameters
name:String

the name of the CircuitBreaker

circuitBreakerConfigSupplier:Supplier<CircuitBreakerConfig>

a supplier of a custom CircuitBreaker configuration

Returns:CircuitBreaker

The CircuitBreaker

Annotations
@Override
circuitBreakerback to summary
public CircuitBreaker circuitBreaker(String name, Supplier<CircuitBreakerConfig> circuitBreakerConfigSupplier, Map<String, String> tags)

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.circuitBreaker.

Returns a managed CircuitBreaker or creates a new one with a custom CircuitBreaker configuration.

The tags passed will be appended to the tags already configured for the registry. When tags (keys) of the two collide the tags passed with this method will override the tags of the registry.

Parameters
name:String

the name of the CircuitBreaker

circuitBreakerConfigSupplier:Supplier<CircuitBreakerConfig>

a supplier of a custom CircuitBreaker configuration

tags:Map<String, String>

tags added to the CircuitBreaker

Returns:CircuitBreaker

The CircuitBreaker

Annotations
@Override
getAllCircuitBreakersback to summary
public Set<CircuitBreaker> getAllCircuitBreakers()

Implements io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.getAllCircuitBreakers.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.getAllCircuitBreakers.

Returns all managed CircuitBreaker instances.

Returns:Set<CircuitBreaker>

all managed CircuitBreaker instances.

Annotations
@Override