public Interface CircuitBreakerRegistry

circuitBreaker back to summary

circuitBreaker	back to summary
public CircuitBreaker circuitBreaker(String name, Map<String, String> tags) 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`

public CircuitBreaker circuitBreaker(String name, Map<String, String> tags)

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

circuitBreaker back to summary

circuitBreaker	back to summary
public CircuitBreaker circuitBreaker(String name, CircuitBreakerConfig config) 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`

public CircuitBreaker circuitBreaker(String name, CircuitBreakerConfig config)

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

circuitBreaker back to summary

circuitBreaker	back to summary
public CircuitBreaker circuitBreaker(String name, CircuitBreakerConfig config, Map<String, String> tags) 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`

public CircuitBreaker circuitBreaker(String name, CircuitBreakerConfig config, Map<String, String> tags)

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

circuitBreaker back to summary

circuitBreaker	back to summary
public CircuitBreaker circuitBreaker(String name, String configName) 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`

public CircuitBreaker circuitBreaker(String name, String configName)

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

circuitBreaker back to summary

circuitBreaker	back to summary
public CircuitBreaker circuitBreaker(String name, String configName, Map<String, String> tags) 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`

public CircuitBreaker circuitBreaker(String name, String configName, Map<String, String> tags)

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

circuitBreaker back to summary

circuitBreaker	back to summary
public CircuitBreaker circuitBreaker(String name, Supplier<CircuitBreakerConfig> circuitBreakerConfigSupplier) 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`

public CircuitBreaker circuitBreaker(String name, Supplier<CircuitBreakerConfig> circuitBreakerConfigSupplier)

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

circuitBreaker back to summary

circuitBreaker	back to summary
public CircuitBreaker circuitBreaker(String name, Supplier<CircuitBreakerConfig> circuitBreakerConfigSupplier, Map<String, String> tags) 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`

public CircuitBreaker circuitBreaker(String name, Supplier<CircuitBreakerConfig> circuitBreakerConfigSupplier, Map<String, String> tags)

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

custom back to summary

custom	back to summary
public static CircuitBreakerRegistry.Builder custom() Returns a builder to create a custom CircuitBreakerRegistry. Returns:CircuitBreakerRegistry.Builder a `CircuitBreakerRegistry.Builder`

public static CircuitBreakerRegistry.Builder custom()

Returns a builder to create a custom CircuitBreakerRegistry.

Returns:CircuitBreakerRegistry.Builder: a CircuitBreakerRegistry.Builder

getAllCircuitBreakers back to summary

getAllCircuitBreakers	back to summary
public Set<CircuitBreaker> getAllCircuitBreakers() Returns all managed `CircuitBreaker` instances. Returns:Set<CircuitBreaker> all managed `CircuitBreaker` instances.

public Set<CircuitBreaker> getAllCircuitBreakers()

Returns all managed CircuitBreaker instances.

Returns:Set<CircuitBreaker>: all managed CircuitBreaker instances.

of	back to summary
public static CircuitBreakerRegistry of(CircuitBreakerConfig circuitBreakerConfig) Creates a CircuitBreakerRegistry with a custom default CircuitBreaker configuration. Parameters circuitBreakerConfig:CircuitBreakerConfig a custom default CircuitBreaker configuration Returns:CircuitBreakerRegistry a CircuitBreakerRegistry with a custom CircuitBreaker configuration.

public static CircuitBreakerRegistry of(CircuitBreakerConfig circuitBreakerConfig)

Creates a CircuitBreakerRegistry with a custom default CircuitBreaker configuration.

Parameters

circuitBreakerConfig:CircuitBreakerConfig: a custom default CircuitBreaker configuration

a CircuitBreakerRegistry with a custom CircuitBreaker configuration.

of	back to summary
public static CircuitBreakerRegistry of(CircuitBreakerConfig circuitBreakerConfig, RegistryEventConsumer<CircuitBreaker> registryEventConsumer) Creates a CircuitBreakerRegistry with a custom default CircuitBreaker configuration and a CircuitBreaker registry event consumer. Parameters circuitBreakerConfig:CircuitBreakerConfig a custom default CircuitBreaker configuration. registryEventConsumer:RegistryEventConsumer<CircuitBreaker> a CircuitBreaker registry event consumer. Returns:CircuitBreakerRegistry a CircuitBreakerRegistry with a custom CircuitBreaker configuration and a CircuitBreaker registry event consumer.

public static CircuitBreakerRegistry of(CircuitBreakerConfig circuitBreakerConfig, RegistryEventConsumer<CircuitBreaker> registryEventConsumer)

Creates a CircuitBreakerRegistry with a custom default CircuitBreaker configuration and a CircuitBreaker registry event consumer.

Parameters

circuitBreakerConfig:CircuitBreakerConfig: a custom default CircuitBreaker configuration.
registryEventConsumer:RegistryEventConsumer<CircuitBreaker>: a CircuitBreaker registry event consumer.

a CircuitBreakerRegistry with a custom CircuitBreaker configuration and a CircuitBreaker registry event consumer.

of	back to summary
public static CircuitBreakerRegistry of(CircuitBreakerConfig circuitBreakerConfig, List<RegistryEventConsumer<CircuitBreaker>> registryEventConsumers) Creates a CircuitBreakerRegistry with a custom default CircuitBreaker configuration and a list of CircuitBreaker registry event consumers. Parameters circuitBreakerConfig:CircuitBreakerConfig a custom default CircuitBreaker configuration. registryEventConsumers:List<RegistryEventConsumer<CircuitBreaker>> a list of CircuitBreaker registry event consumers. Returns:CircuitBreakerRegistry a CircuitBreakerRegistry with a custom CircuitBreaker configuration and list of CircuitBreaker registry event consumers.

public static CircuitBreakerRegistry of(CircuitBreakerConfig circuitBreakerConfig, List<RegistryEventConsumer<CircuitBreaker>> registryEventConsumers)

Creates a CircuitBreakerRegistry with a custom default CircuitBreaker configuration and a list of CircuitBreaker registry event consumers.

Parameters

circuitBreakerConfig:CircuitBreakerConfig: a custom default CircuitBreaker configuration.
registryEventConsumers:List<RegistryEventConsumer<CircuitBreaker>>: a list of CircuitBreaker registry event consumers.

a CircuitBreakerRegistry with a custom CircuitBreaker configuration and list of CircuitBreaker registry event consumers.

of	back to summary
public static CircuitBreakerRegistry of(Map<String, CircuitBreakerConfig> configs) Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations. Parameters configs:Map<String, CircuitBreakerConfig> a Map of shared CircuitBreaker configurations Returns:CircuitBreakerRegistry a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations.

public static CircuitBreakerRegistry of(Map<String, CircuitBreakerConfig> configs)

Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations.

Parameters

configs:Map<String, CircuitBreakerConfig>: a Map of shared CircuitBreaker configurations

a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations.

of	back to summary
public static CircuitBreakerRegistry of(Map<String, CircuitBreakerConfig> configs, Map<String, String> tags) Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations. Tags added to the registry will be added to every instance created by this registry. Parameters configs:Map<String, CircuitBreakerConfig> a Map of shared CircuitBreaker configurations tags:Map<String, String> default tags to add to the registry Returns:CircuitBreakerRegistry a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations.

public static CircuitBreakerRegistry of(Map<String, CircuitBreakerConfig> configs, Map<String, String> tags)

Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations.

Tags added to the registry will be added to every instance created by this registry.

Parameters

configs:Map<String, CircuitBreakerConfig>: a Map of shared CircuitBreaker configurations
tags:Map<String, String>: default tags to add to the registry

a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations.

of	back to summary
public static CircuitBreakerRegistry of(Map<String, CircuitBreakerConfig> configs, RegistryEventConsumer<CircuitBreaker> registryEventConsumer) Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a CircuitBreaker registry event consumer. Parameters configs:Map<String, CircuitBreakerConfig> a Map of shared CircuitBreaker configurations. registryEventConsumer:RegistryEventConsumer<CircuitBreaker> a CircuitBreaker registry event consumer. Returns:CircuitBreakerRegistry a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a CircuitBreaker registry event consumer.

public static CircuitBreakerRegistry of(Map<String, CircuitBreakerConfig> configs, RegistryEventConsumer<CircuitBreaker> registryEventConsumer)

Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a CircuitBreaker registry event consumer.

Parameters

configs:Map<String, CircuitBreakerConfig>: a Map of shared CircuitBreaker configurations.
registryEventConsumer:RegistryEventConsumer<CircuitBreaker>: a CircuitBreaker registry event consumer.

a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a CircuitBreaker registry event consumer.

of	back to summary
public static CircuitBreakerRegistry of(Map<String, CircuitBreakerConfig> configs, RegistryEventConsumer<CircuitBreaker> registryEventConsumer, Map<String, String> tags) Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a CircuitBreaker registry event consumer. Parameters configs:Map<String, CircuitBreakerConfig> a Map of shared CircuitBreaker configurations. registryEventConsumer:RegistryEventConsumer<CircuitBreaker> a CircuitBreaker registry event consumer. tags:Map<String, String> default tags to add to the registry Returns:CircuitBreakerRegistry a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a CircuitBreaker registry event consumer.

public static CircuitBreakerRegistry of(Map<String, CircuitBreakerConfig> configs, RegistryEventConsumer<CircuitBreaker> registryEventConsumer, Map<String, String> tags)

Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a CircuitBreaker registry event consumer.

Parameters

configs:Map<String, CircuitBreakerConfig>: a Map of shared CircuitBreaker configurations.
registryEventConsumer:RegistryEventConsumer<CircuitBreaker>: a CircuitBreaker registry event consumer.
tags:Map<String, String>: default tags to add to the registry

a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a CircuitBreaker registry event consumer.

of	back to summary
public static CircuitBreakerRegistry of(Map<String, CircuitBreakerConfig> configs, List<RegistryEventConsumer<CircuitBreaker>> registryEventConsumers) Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a list of CircuitBreaker registry event consumers. Parameters configs:Map<String, CircuitBreakerConfig> a Map of shared CircuitBreaker configurations. registryEventConsumers:List<RegistryEventConsumer<CircuitBreaker>> a list of CircuitBreaker registry event consumers. Returns:CircuitBreakerRegistry a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a list of CircuitBreaker registry event consumers.

public static CircuitBreakerRegistry of(Map<String, CircuitBreakerConfig> configs, List<RegistryEventConsumer<CircuitBreaker>> registryEventConsumers)

Creates a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a list of CircuitBreaker registry event consumers.

Parameters

configs:Map<String, CircuitBreakerConfig>: a Map of shared CircuitBreaker configurations.
registryEventConsumers:List<RegistryEventConsumer<CircuitBreaker>>: a list of CircuitBreaker registry event consumers.

a CircuitBreakerRegistry with a Map of shared CircuitBreaker configurations and a list of CircuitBreaker registry event consumers.

ofDefaults	back to summary
public static CircuitBreakerRegistry ofDefaults() Creates a CircuitBreakerRegistry with a default CircuitBreaker configuration. Returns:CircuitBreakerRegistry a CircuitBreakerRegistry with a default CircuitBreaker configuration.

ofDefaults

public static CircuitBreakerRegistry ofDefaults()

Creates a CircuitBreakerRegistry with a default CircuitBreaker configuration.

Returns:CircuitBreakerRegistry: a CircuitBreakerRegistry with a default CircuitBreaker configuration.

io.github.resilience4j.circuitbreaker back to summary

public Class CircuitBreakerRegistry.Builder

Class Inheritance

extends Object

java.lang.Object
io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry.Builder

Field Summary

Modifier and Type	Field and Description
private Map<String, CircuitBreakerConfig>	circuitBreakerConfigsMap
private static final String	DEFAULT_CONFIG
private List<RegistryEventConsumer<CircuitBreaker>>	registryEventConsumers
private RegistryStore<CircuitBreaker>	registryStore
private Map<String, String>	tags

Constructor Summary

Access	Constructor and Description
public	Builder()

Method Summary

Modifier and Type	Method and Description
public CircuitBreakerRegistry.Builder	Returns: a `CircuitBreakerRegistry.Builder` addCircuitBreakerConfig(String configName for a custom shared CircuitBreaker configuration configName, CircuitBreakerConfig a custom shared CircuitBreaker configuration configuration) Configures a CircuitBreakerRegistry with a custom CircuitBreaker configuration.
public CircuitBreakerRegistry.Builder	Returns: a `CircuitBreakerRegistry.Builder` addRegistryEventConsumer(RegistryEventConsumer<CircuitBreaker> a CircuitBreaker registry event consumer. registryEventConsumer) Configures a CircuitBreakerRegistry with a CircuitBreaker registry event consumer.
public CircuitBreakerRegistry	Returns: the CircuitBreakerRegistry build() Builds a CircuitBreakerRegistry
public CircuitBreakerRegistry.Builder	Returns: a `CircuitBreakerRegistry.Builder` withCircuitBreakerConfig(CircuitBreakerConfig a custom default CircuitBreaker configuration circuitBreakerConfig) Configures a CircuitBreakerRegistry with a custom default CircuitBreaker configuration.
public CircuitBreakerRegistry.Builder	withRegistryStore(RegistryStore<CircuitBreaker> registryStore)
public CircuitBreakerRegistry.Builder	Returns: a `CircuitBreakerRegistry.Builder` withTags(Map<String, String> default tags to add to the registry. tags) Configures a CircuitBreakerRegistry with Tags.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

circuitBreakerConfigsMap	back to summary
private Map<String, CircuitBreakerConfig> circuitBreakerConfigsMap

DEFAULT_CONFIG	back to summary
private static final String DEFAULT_CONFIG

registryEventConsumers	back to summary
private List<RegistryEventConsumer<CircuitBreaker>> registryEventConsumers

registryStore	back to summary
private RegistryStore<CircuitBreaker> registryStore

tags	back to summary
private Map<String, String> tags

Constructor Detail

Builder	back to summary
public Builder()

Method Detail

addCircuitBreakerConfig back to summary

addCircuitBreakerConfig	back to summary
public CircuitBreakerRegistry.Builder addCircuitBreakerConfig(String configName, CircuitBreakerConfig configuration) Configures a CircuitBreakerRegistry with a custom CircuitBreaker configuration. Parameters configName:String configName for a custom shared CircuitBreaker configuration configuration:CircuitBreakerConfig a custom shared CircuitBreaker configuration Returns:CircuitBreakerRegistry.Builder a `CircuitBreakerRegistry.Builder` Exceptions IllegalArgumentException: if `configName.equals("default")`

public CircuitBreakerRegistry.Builder addCircuitBreakerConfig(String configName, CircuitBreakerConfig configuration)

Configures a CircuitBreakerRegistry with a custom CircuitBreaker configuration.

Parameters

configName:String: configName for a custom shared CircuitBreaker configuration
configuration:CircuitBreakerConfig: a custom shared CircuitBreaker configuration

Exceptions

IllegalArgumentException:: if configName.equals("default")

addRegistryEventConsumer back to summary

addRegistryEventConsumer	back to summary
public CircuitBreakerRegistry.Builder addRegistryEventConsumer(RegistryEventConsumer<CircuitBreaker> registryEventConsumer) Configures a CircuitBreakerRegistry with a CircuitBreaker registry event consumer. Parameters registryEventConsumer:RegistryEventConsumer<CircuitBreaker> a CircuitBreaker registry event consumer. Returns:CircuitBreakerRegistry.Builder a `CircuitBreakerRegistry.Builder`

public CircuitBreakerRegistry.Builder addRegistryEventConsumer(RegistryEventConsumer<CircuitBreaker> registryEventConsumer)

Configures a CircuitBreakerRegistry with a CircuitBreaker registry event consumer.

Parameters

registryEventConsumer:RegistryEventConsumer<CircuitBreaker>: a CircuitBreaker registry event consumer.

build	back to summary
public CircuitBreakerRegistry build() Builds a CircuitBreakerRegistry Returns:CircuitBreakerRegistry the CircuitBreakerRegistry

build

public CircuitBreakerRegistry build()

Builds a CircuitBreakerRegistry

Returns:CircuitBreakerRegistry: the CircuitBreakerRegistry

withCircuitBreakerConfig back to summary

withCircuitBreakerConfig	back to summary
public CircuitBreakerRegistry.Builder withCircuitBreakerConfig(CircuitBreakerConfig circuitBreakerConfig) Configures a CircuitBreakerRegistry with a custom default CircuitBreaker configuration. Parameters circuitBreakerConfig:CircuitBreakerConfig a custom default CircuitBreaker configuration Returns:CircuitBreakerRegistry.Builder a `CircuitBreakerRegistry.Builder`

public CircuitBreakerRegistry.Builder withCircuitBreakerConfig(CircuitBreakerConfig circuitBreakerConfig)

Configures a CircuitBreakerRegistry with a custom default CircuitBreaker configuration.

Parameters

circuitBreakerConfig:CircuitBreakerConfig: a custom default CircuitBreaker configuration

withRegistryStore	back to summary
public CircuitBreakerRegistry.Builder withRegistryStore(RegistryStore<CircuitBreaker> registryStore)

withTags back to summary

withTags	back to summary
public CircuitBreakerRegistry.Builder withTags(Map<String, String> tags) Configures a CircuitBreakerRegistry with Tags. Tags added to the registry will be added to every instance created by this registry. Parameters tags:Map<String, String> default tags to add to the registry. Returns:CircuitBreakerRegistry.Builder a `CircuitBreakerRegistry.Builder`

public CircuitBreakerRegistry.Builder withTags(Map<String, String> tags)

Configures a CircuitBreakerRegistry with Tags.

Tags added to the registry will be added to every instance created by this registry.

Parameters

tags:Map<String, String>: default tags to add to the registry.