Class MongoHealthIndicator

java.lang.Object

org.springframework.boot.health.contributor.AbstractHealthIndicator

org.springframework.boot.mongodb.health.MongoHealthIndicator

All Implemented Interfaces:

HealthContributor, HealthIndicator

public class MongoHealthIndicator
extends AbstractHealthIndicator

Simple implementation of a HealthIndicator returning status information for MongoDB.

Since:

4.0.0

Author:

Christian Dupuis

Constructor Summary

Constructors

Constructor	Description
MongoHealthIndicator(com.mongodb.client.MongoClient mongoClient)

Method Summary

Modifier and Type	Method	Description
protected void	doHealthCheck(Health.Builder builder)	Actual health check logic.

Methods inherited from class org.springframework.boot.health.contributor.AbstractHealthIndicator

health

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.health.contributor.HealthIndicator

health

Constructor Details

MongoHealthIndicator

public MongoHealthIndicator(com.mongodb.client.MongoClient mongoClient)

Method Details

doHealthCheck

protected void doHealthCheck(Health.Builder builder)
                      throws Exception

Description copied from class: AbstractHealthIndicator

Actual health check logic.

Specified by:

doHealthCheck in class AbstractHealthIndicator

Parameters:

builder - the Health.Builder to report health status and details

Throws:

Exception - any Exception that should create a Status.DOWN system status.