org.springframework.boot.actuate.health

Class CompositeReactiveHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.CompositeReactiveHealthIndicator

All Implemented Interfaces:

ReactiveHealthIndicator

public class CompositeReactiveHealthIndicator
extends Object
implements ReactiveHealthIndicator

ReactiveHealthIndicator that returns health indications from all registered delegates. Provides an alternative Health for a delegate that reaches a configurable timeout.

Since:

2.0.0

Author:

Stephane Nicoll

Constructor Summary

Constructors

Constructor and Description
CompositeReactiveHealthIndicator(HealthAggregator healthAggregator) Deprecated. since 2.1.0 in favour of CompositeReactiveHealthIndicator(HealthAggregator, ReactiveHealthIndicatorRegistry)
CompositeReactiveHealthIndicator(HealthAggregator healthAggregator, Map<String,ReactiveHealthIndicator> indicators) Deprecated. since 2.1.0 in favour of CompositeReactiveHealthIndicator(HealthAggregator, ReactiveHealthIndicatorRegistry)
CompositeReactiveHealthIndicator(HealthAggregator healthAggregator, ReactiveHealthIndicatorRegistry registry) Create a new CompositeReactiveHealthIndicator from the indicators in the given registry.

Method Summary

Modifier and Type	Method and Description
CompositeReactiveHealthIndicator	addHealthIndicator(String name, ReactiveHealthIndicator indicator) Deprecated. since 2.1.0 in favour of ReactiveHealthIndicatorRegistry.register(String, ReactiveHealthIndicator)
reactor.core.publisher.Mono<Health>	health() Provide the indicator of health.
CompositeReactiveHealthIndicator	timeoutStrategy(long timeout, Health timeoutHealth) Specify an alternative timeout Health if a HealthIndicator failed to reply after specified timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeReactiveHealthIndicator

@Deprecated
public CompositeReactiveHealthIndicator(HealthAggregator healthAggregator)

Deprecated. since 2.1.0 in favour of CompositeReactiveHealthIndicator(HealthAggregator, ReactiveHealthIndicatorRegistry)

Create a new CompositeReactiveHealthIndicator.

Parameters:

healthAggregator - the health aggregator

CompositeReactiveHealthIndicator

@Deprecated
public CompositeReactiveHealthIndicator(HealthAggregator healthAggregator,
                                                    Map<String,ReactiveHealthIndicator> indicators)

Deprecated. since 2.1.0 in favour of CompositeReactiveHealthIndicator(HealthAggregator, ReactiveHealthIndicatorRegistry)

Create a new CompositeReactiveHealthIndicator from the specified indicators.

Parameters:

healthAggregator - the health aggregator

indicators - a map of HealthIndicators with the key being used as an indicator name.

CompositeReactiveHealthIndicator

public CompositeReactiveHealthIndicator(HealthAggregator healthAggregator,
                                        ReactiveHealthIndicatorRegistry registry)

Create a new CompositeReactiveHealthIndicator from the indicators in the given registry.

Parameters:

healthAggregator - the health aggregator

registry - the registry of HealthIndicators.

Method Detail

addHealthIndicator

@Deprecated
public CompositeReactiveHealthIndicator addHealthIndicator(String name,
                                                                       ReactiveHealthIndicator indicator)

Deprecated. since 2.1.0 in favour of ReactiveHealthIndicatorRegistry.register(String, ReactiveHealthIndicator)

Add a ReactiveHealthIndicator with the specified name.

Parameters:

name - the name of the health indicator

indicator - the health indicator to add

Returns:

this instance

Throws:

IllegalStateException - if an indicator with the given name is already registered.

timeoutStrategy

public CompositeReactiveHealthIndicator timeoutStrategy(long timeout,
                                                        Health timeoutHealth)

Specify an alternative timeout Health if a HealthIndicator failed to reply after specified timeout.

Parameters:

timeout - number of milliseconds to wait before using the timeoutHealth

timeoutHealth - the Health to use if an health indicator reached the timeout

Returns:

this instance

health

public reactor.core.publisher.Mono<Health> health()

Description copied from interface: ReactiveHealthIndicator

Provide the indicator of health.

Specified by:

health in interface ReactiveHealthIndicator

Returns:

a Mono that provides the Health