Index (spring-boot-health 4.0.0-M3 API)

A B C D E F G H I N O P R S T U V W
All Classes and Interfaces|All Packages

A

AbstractHealthIndicator - Class in org.springframework.boot.health.contributor: Base HealthIndicator implementations that encapsulates creation of Health instance and error handling.
AbstractHealthIndicator() - Constructor for class org.springframework.boot.health.contributor.AbstractHealthIndicator: Create a new AbstractHealthIndicator instance with a default healthCheckFailedMessage.
AbstractHealthIndicator(String) - Constructor for class org.springframework.boot.health.contributor.AbstractHealthIndicator: Create a new AbstractHealthIndicator instance with a specific message to log when the health check fails.
AbstractHealthIndicator(Function<Exception, String>) - Constructor for class org.springframework.boot.health.contributor.AbstractHealthIndicator: Create a new AbstractHealthIndicator instance with a specific message to log when the health check fails.
AbstractReactiveHealthIndicator - Class in org.springframework.boot.health.contributor: Base ReactiveHealthIndicator implementations that encapsulates creation of Health instance and error handling.
AbstractReactiveHealthIndicator() - Constructor for class org.springframework.boot.health.contributor.AbstractReactiveHealthIndicator: Create a new AbstractReactiveHealthIndicator instance with a default healthCheckFailedMessage.
AbstractReactiveHealthIndicator(String) - Constructor for class org.springframework.boot.health.contributor.AbstractReactiveHealthIndicator: Create a new AbstractReactiveHealthIndicator instance with a specific message to log when the health check fails.
AbstractReactiveHealthIndicator(Function<Throwable, String>) - Constructor for class org.springframework.boot.health.contributor.AbstractReactiveHealthIndicator: Create a new AbstractReactiveHealthIndicator instance with a specific message to log when the health check fails.
adapt(HealthContributor) - Static method in interface org.springframework.boot.health.contributor.ReactiveHealthContributor: Adapts the given HealthContributor into a ReactiveHealthContributor by scheduling blocking calls to Schedulers.boundedElastic().
adapt(HealthContributors) - Static method in interface org.springframework.boot.health.contributor.ReactiveHealthContributors: Adapts the given HealthContributors into a ReactiveHealthContributors by scheduling blocking calls to Schedulers.boundedElastic().
asHealthContributor() - Method in interface org.springframework.boot.health.contributor.CompositeReactiveHealthContributor
asHealthContributor() - Method in interface org.springframework.boot.health.contributor.ReactiveHealthContributor: Return this reactive contributor as a standard blocking HealthContributor.
asHealthContributor() - Method in interface org.springframework.boot.health.contributor.ReactiveHealthIndicator
asHealthContributors() - Method in interface org.springframework.boot.health.contributor.ReactiveHealthContributors: Return these reactive contributors as standard blocking HealthContributors.

B

build() - Method in class org.springframework.boot.health.contributor.Health.Builder: Create a new Health instance with the previously specified code and details.
Builder() - Constructor for class org.springframework.boot.health.contributor.Health.Builder: Create new Builder instance.
Builder(Status) - Constructor for class org.springframework.boot.health.contributor.Health.Builder: Create new Builder instance, setting status to given status.
Builder(Status, Map<String, ?>) - Constructor for class org.springframework.boot.health.contributor.Health.Builder: Create new Builder instance, setting status to given status and details to given details.

C

CompositeHealthContributor - Interface in org.springframework.boot.health.contributor: A HealthContributor that is composed of other HealthContributor instances.
CompositeHealthContributorConfiguration<I,B> - Class in org.springframework.boot.health.autoconfigure.contributor: Base class for health contributor configurations that can combine source beans into a composite.
CompositeHealthContributorConfiguration(Function<B, I>) - Constructor for class org.springframework.boot.health.autoconfigure.contributor.CompositeHealthContributorConfiguration: Creates a CompositeHealthContributorConfiguration that will use the given indicatorFactory to create HealthIndicator instances.
CompositeReactiveHealthContributor - Interface in org.springframework.boot.health.contributor: A ReactiveHealthContributor that is composed of other ReactiveHealthContributor instances.
CompositeReactiveHealthContributorConfiguration<I,B> - Class in org.springframework.boot.health.autoconfigure.contributor: Base class for health contributor configurations that can combine source beans into a composite.
CompositeReactiveHealthContributorConfiguration(Function<B, I>) - Constructor for class org.springframework.boot.health.autoconfigure.contributor.CompositeReactiveHealthContributorConfiguration: Creates a CompositeReactiveHealthContributorConfiguration that will use the given indicatorFactory to create ReactiveHealthIndicator instances.
ConditionalOnEnabledHealthIndicator - Annotation Interface in org.springframework.boot.health.autoconfigure.contributor: @Conditional that checks whether a default health indicator is enabled.
contributor() - Method in record class org.springframework.boot.health.contributor.HealthContributors.Entry: Returns the value of the contributor record component.
contributor() - Method in record class org.springframework.boot.health.contributor.ReactiveHealthContributors.Entry: Returns the value of the contributor record component.
createComposite(Map<String, B>) - Method in class org.springframework.boot.health.autoconfigure.contributor.CompositeHealthContributorConfiguration
createComposite(Map<String, B>) - Method in class org.springframework.boot.health.autoconfigure.contributor.CompositeReactiveHealthContributorConfiguration
createContributor(Map<String, B>) - Method in class org.springframework.boot.health.autoconfigure.contributor.CompositeHealthContributorConfiguration
createContributor(Map<String, B>) - Method in class org.springframework.boot.health.autoconfigure.contributor.CompositeReactiveHealthContributorConfiguration
createContributor(ConfigurableListableBeanFactory, Class<B>) - Method in class org.springframework.boot.health.autoconfigure.contributor.CompositeHealthContributorConfiguration: Creates a composite contributor from the beans of the given beanType retrieved from the given beanFactory.
createContributor(ConfigurableListableBeanFactory, Class<B>) - Method in class org.springframework.boot.health.autoconfigure.contributor.CompositeReactiveHealthContributorConfiguration: Creates a composite contributor from the beans of the given beanType retrieved from the given beanFactory.
createIndicator(B) - Method in class org.springframework.boot.health.autoconfigure.contributor.CompositeHealthContributorConfiguration
createIndicator(B) - Method in class org.springframework.boot.health.autoconfigure.contributor.CompositeReactiveHealthContributorConfiguration

D

DefaultHealthContributorRegistry - Class in org.springframework.boot.health.registry: Default HealthContributorRegistry implementation.
DefaultHealthContributorRegistry() - Constructor for class org.springframework.boot.health.registry.DefaultHealthContributorRegistry: Create a new empty DefaultHealthContributorRegistry instance.
DefaultHealthContributorRegistry(Collection<? extends HealthContributorNameValidator>, Consumer<BiConsumer<String, HealthContributor>>) - Constructor for class org.springframework.boot.health.registry.DefaultHealthContributorRegistry: Create a new DefaultHealthContributorRegistry instance.
DefaultReactiveHealthContributorRegistry - Class in org.springframework.boot.health.registry: Default ReactiveHealthContributorRegistry implementation.
DefaultReactiveHealthContributorRegistry() - Constructor for class org.springframework.boot.health.registry.DefaultReactiveHealthContributorRegistry: Create a new empty DefaultReactiveHealthContributorRegistry instance.
DefaultReactiveHealthContributorRegistry(Collection<? extends HealthContributorNameValidator>, Consumer<BiConsumer<String, ReactiveHealthContributor>>) - Constructor for class org.springframework.boot.health.registry.DefaultReactiveHealthContributorRegistry: Create a new DefaultReactiveHealthContributorRegistry instance.
doHealthCheck(Health.Builder) - Method in class org.springframework.boot.health.contributor.AbstractHealthIndicator: Actual health check logic.
doHealthCheck(Health.Builder) - Method in class org.springframework.boot.health.contributor.AbstractReactiveHealthIndicator: Actual health check logic.
doHealthCheck(Health.Builder) - Method in class org.springframework.boot.health.contributor.PingHealthIndicator
down() - Method in class org.springframework.boot.health.contributor.Health.Builder: Set status to DOWN.
down() - Static method in class org.springframework.boot.health.contributor.Health: Create a new Health.Builder instance with a DOWN status.
down(Throwable) - Method in class org.springframework.boot.health.contributor.Health.Builder: Set status to DOWN and add details for given Throwable.
down(Throwable) - Static method in class org.springframework.boot.health.contributor.Health: Create a new Health.Builder instance with an DOWN status and the specified exception details.
DOWN - Static variable in class org.springframework.boot.health.contributor.Status: Status indicating that the component or subsystem has suffered an unexpected failure.

E

Entry(String, HealthContributor) - Constructor for record class org.springframework.boot.health.contributor.HealthContributors.Entry: Creates an instance of a Entry record class.
Entry(String, ReactiveHealthContributor) - Constructor for record class org.springframework.boot.health.contributor.ReactiveHealthContributors.Entry: Creates an instance of a Entry record class.
equals(Object) - Method in class org.springframework.boot.health.contributor.Health
equals(Object) - Method in record class org.springframework.boot.health.contributor.HealthContributors.Entry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.boot.health.contributor.ReactiveHealthContributors.Entry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.springframework.boot.health.contributor.Status

F

fromMap(Map<String, ? extends HealthContributor>) - Static method in interface org.springframework.boot.health.contributor.CompositeHealthContributor: Factory method that will create a CompositeHealthContributor from the specified map.
fromMap(Map<String, ? extends ReactiveHealthContributor>) - Static method in interface org.springframework.boot.health.contributor.CompositeReactiveHealthContributor: Factory method that will create a CompositeReactiveHealthContributor from the specified map.
fromMap(Map<String, V>, Function<V, ? extends HealthContributor>) - Static method in interface org.springframework.boot.health.contributor.CompositeHealthContributor: Factory method that will create a CompositeHealthContributor from the specified map.
fromMap(Map<String, V>, Function<V, ? extends ReactiveHealthContributor>) - Static method in interface org.springframework.boot.health.contributor.CompositeReactiveHealthContributor: Factory method that will create a CompositeReactiveHealthContributor from the specified map.

G

generateContributorName(String) - Method in interface org.springframework.boot.health.autoconfigure.registry.HealthContributorNameGenerator: Generate the health contributor name for the given bean name.
getCode() - Method in class org.springframework.boot.health.contributor.Status: Return the code for this status.
getContributor(String) - Method in interface org.springframework.boot.health.contributor.HealthContributors: Return the contributor with the given name.
getContributor(String) - Method in interface org.springframework.boot.health.contributor.ReactiveHealthContributors: Return the contributor with the given name.
getContributor(String) - Method in class org.springframework.boot.health.registry.DefaultHealthContributorRegistry
getContributor(String) - Method in class org.springframework.boot.health.registry.DefaultReactiveHealthContributorRegistry
getDescription() - Method in class org.springframework.boot.health.contributor.Status: Return the description of this status.
getDetails() - Method in class org.springframework.boot.health.contributor.Health: Return the details of the health.
getStatus() - Method in class org.springframework.boot.health.contributor.Health: Return the status of the health.

H

hashCode() - Method in class org.springframework.boot.health.contributor.Health
hashCode() - Method in record class org.springframework.boot.health.contributor.HealthContributors.Entry: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.boot.health.contributor.ReactiveHealthContributors.Entry: Returns a hash code value for this object.
hashCode() - Method in class org.springframework.boot.health.contributor.Status
health() - Method in class org.springframework.boot.health.contributor.AbstractHealthIndicator
health() - Method in class org.springframework.boot.health.contributor.AbstractReactiveHealthIndicator
health() - Method in interface org.springframework.boot.health.contributor.HealthIndicator: Return an indication of health.
health() - Method in interface org.springframework.boot.health.contributor.ReactiveHealthIndicator: Provide the indicator of health.
health(boolean) - Method in interface org.springframework.boot.health.contributor.HealthIndicator: Return an indication of health.
health(boolean) - Method in interface org.springframework.boot.health.contributor.ReactiveHealthIndicator: Provide the indicator of health.
Health - Class in org.springframework.boot.health.contributor: The health of a component or subsystem in including its Status as well as any additional contextual details.
Health.Builder - Class in org.springframework.boot.health.contributor: Builder for creating immutable Health instances.
HealthContributor - Interface in org.springframework.boot.health.contributor: Contributes health information, either directly (HealthIndicator) or via other contributors (CompositeHealthContributor).
HealthContributorAutoConfiguration - Class in org.springframework.boot.health.autoconfigure.contributor: Auto-configuration for default health contributors.
HealthContributorAutoConfiguration() - Constructor for class org.springframework.boot.health.autoconfigure.contributor.HealthContributorAutoConfiguration
HealthContributorNameGenerator - Interface in org.springframework.boot.health.autoconfigure.registry: Strategy used to create health contributor names from bean names.
HealthContributorNameValidator - Interface in org.springframework.boot.health.registry: Interface that can be used to validate names before they are added to a health contributor registry.
HealthContributorRegistry - Interface in org.springframework.boot.health.registry: A mutable registry of health contributors.
HealthContributorRegistryAutoConfiguration - Class in org.springframework.boot.health.autoconfigure.registry: Auto-configuration for HealthContributorRegistry and ReactiveHealthContributorRegistry.
HealthContributors - Interface in org.springframework.boot.health.contributor: A collection of named health contributors.
HealthContributors.Entry - Record Class in org.springframework.boot.health.contributor: A health contributor entry.
HealthIndicator - Interface in org.springframework.boot.health.contributor: Directly contributes Health information for specific component or subsystem.

I

iterator() - Method in interface org.springframework.boot.health.contributor.HealthContributors
iterator() - Method in interface org.springframework.boot.health.contributor.ReactiveHealthContributors

N

name() - Method in record class org.springframework.boot.health.contributor.HealthContributors.Entry: Returns the value of the name record component.
name() - Method in record class org.springframework.boot.health.contributor.ReactiveHealthContributors.Entry: Returns the value of the name record component.

O

of(HealthContributors...) - Static method in interface org.springframework.boot.health.contributor.HealthContributors: Factory method to create a new HealthContributors instance composed of the given contributors.
of(ReactiveHealthContributors...) - Static method in interface org.springframework.boot.health.contributor.ReactiveHealthContributors: Factory method to create a new ReactiveHealthContributors instance composed of the given contributors.
org.springframework.boot.health.autoconfigure.contributor - package org.springframework.boot.health.autoconfigure.contributor: Auto-configuration for health contributors.
org.springframework.boot.health.autoconfigure.registry - package org.springframework.boot.health.autoconfigure.registry: Auto-configuration for health registries.
org.springframework.boot.health.contributor - package org.springframework.boot.health.contributor: Classes related to contributing health information about an application.
org.springframework.boot.health.registry - package org.springframework.boot.health.registry: Health registry support.
OUT_OF_SERVICE - Static variable in class org.springframework.boot.health.contributor.Status: Status indicating that the component or subsystem has been taken out of service and should not be used.
outOfService() - Method in class org.springframework.boot.health.contributor.Health.Builder: Set status to OUT_OF_SERVICE.
outOfService() - Static method in class org.springframework.boot.health.contributor.Health: Create a new Health.Builder instance with an OUT_OF_SERVICE status.

P

PingHealthIndicator - Class in org.springframework.boot.health.contributor: Auto-configured HealthIndicator that always returns UP.
PingHealthIndicator() - Constructor for class org.springframework.boot.health.contributor.PingHealthIndicator

R

ReactiveHealthContributor - Interface in org.springframework.boot.health.contributor: Contributes health information, either directly (ReactiveHealthIndicator) or via other contributors (CompositeReactiveHealthContributor).
ReactiveHealthContributorRegistry - Interface in org.springframework.boot.health.registry: A mutable registry of reactive health contributors.
ReactiveHealthContributors - Interface in org.springframework.boot.health.contributor: A collection of named reactive health contributors.
ReactiveHealthContributors.Entry - Record Class in org.springframework.boot.health.contributor: A reactive health contributor entry.
ReactiveHealthIndicator - Interface in org.springframework.boot.health.contributor: Directly contributes Health information for specific reactive component or subsystem.
registerContributor(String, HealthContributor) - Method in class org.springframework.boot.health.registry.DefaultHealthContributorRegistry
registerContributor(String, HealthContributor) - Method in interface org.springframework.boot.health.registry.HealthContributorRegistry: Register a contributor with the given name.
registerContributor(String, ReactiveHealthContributor) - Method in class org.springframework.boot.health.registry.DefaultReactiveHealthContributorRegistry
registerContributor(String, ReactiveHealthContributor) - Method in interface org.springframework.boot.health.registry.ReactiveHealthContributorRegistry: Register a contributor with the given name.
registrar(Map<String, C>) - Method in interface org.springframework.boot.health.autoconfigure.registry.HealthContributorNameGenerator: Return a registrar that can be used to register the given contributor beans with a generated name.

S

status(String) - Method in class org.springframework.boot.health.contributor.Health.Builder: Set status to given statusCode.
status(String) - Static method in class org.springframework.boot.health.contributor.Health: Create a new Health.Builder instance with a specific status code.
status(Status) - Method in class org.springframework.boot.health.contributor.Health.Builder: Set status to given Status instance.
status(Status) - Static method in class org.springframework.boot.health.contributor.Health: Create a new Health.Builder instance with a specific Status.
Status - Class in org.springframework.boot.health.contributor: Value object to express state of a component or subsystem.
Status(String) - Constructor for class org.springframework.boot.health.contributor.Status: Create a new Status instance with the given code and an empty description.
Status(String, String) - Constructor for class org.springframework.boot.health.contributor.Status: Create a new Status instance with the given code and description.
stream() - Method in interface org.springframework.boot.health.contributor.HealthContributors: Return a stream of the contributor entries.
stream() - Method in interface org.springframework.boot.health.contributor.ReactiveHealthContributors: Return a stream of the contributor entries.
stream() - Method in class org.springframework.boot.health.registry.DefaultHealthContributorRegistry
stream() - Method in class org.springframework.boot.health.registry.DefaultReactiveHealthContributorRegistry

T

toString() - Method in class org.springframework.boot.health.contributor.Health
toString() - Method in record class org.springframework.boot.health.contributor.HealthContributors.Entry: Returns a string representation of this record class.
toString() - Method in record class org.springframework.boot.health.contributor.ReactiveHealthContributors.Entry: Returns a string representation of this record class.
toString() - Method in class org.springframework.boot.health.contributor.Status

U

unchanged() - Static method in interface org.springframework.boot.health.autoconfigure.registry.HealthContributorNameGenerator: Return a HealthContributorNameGenerator that uses the unchanged bean name as the health contributor name.
unknown() - Method in class org.springframework.boot.health.contributor.Health.Builder: Set status to UNKNOWN status.
unknown() - Static method in class org.springframework.boot.health.contributor.Health: Create a new Health.Builder instance with an UNKNOWN status.
UNKNOWN - Static variable in class org.springframework.boot.health.contributor.Status: Status indicating that the component or subsystem is in an unknown state.
unregisterContributor(String) - Method in class org.springframework.boot.health.registry.DefaultHealthContributorRegistry
unregisterContributor(String) - Method in class org.springframework.boot.health.registry.DefaultReactiveHealthContributorRegistry
unregisterContributor(String) - Method in interface org.springframework.boot.health.registry.HealthContributorRegistry: Unregister a previously registered contributor.
unregisterContributor(String) - Method in interface org.springframework.boot.health.registry.ReactiveHealthContributorRegistry: Unregister a previously registered contributor.
up() - Method in class org.springframework.boot.health.contributor.Health.Builder: Set status to UP status.
up() - Static method in class org.springframework.boot.health.contributor.Health: Create a new Health.Builder instance with an UP status.
UP - Static variable in class org.springframework.boot.health.contributor.Status: Status indicating that the component or subsystem is functioning as expected.

V

validate(String) - Method in interface org.springframework.boot.health.registry.HealthContributorNameValidator: Validate the contributor name.
value() - Element in annotation interface org.springframework.boot.health.autoconfigure.contributor.ConditionalOnEnabledHealthIndicator: The name of the health indicator.

W

withDetail(String, Object) - Method in class org.springframework.boot.health.contributor.Health.Builder: Record detail using given key and value.
withDetails(Map<String, ?>) - Method in class org.springframework.boot.health.contributor.Health.Builder: Record details from the given details map.
withException(Throwable) - Method in class org.springframework.boot.health.contributor.Health.Builder: Record detail for given Exception.
withoutStandardSuffixes() - Static method in interface org.springframework.boot.health.autoconfigure.registry.HealthContributorNameGenerator: Return a HealthContributorNameGenerator that removes standard suffixes.
withoutSuffixes(String...) - Static method in interface org.springframework.boot.health.autoconfigure.registry.HealthContributorNameGenerator: Return a HealthContributorNameGenerator that removes the given suffixes.

A B C D E F G H I N O P R S T U V W
All Classes and Interfaces|All Packages